search

microsoft / azure-pipelines-yaml

Azure Pipelines YAML examples, templates, and community interaction
MIT License
1.21k stars 934 forks source link

properties.json spec? #526

Closed blake-mealey closed 3 years ago

blake-mealey commented 3 years ago

After looking into this project a bit I've noticed you're using template-name.properties.json files to add metadata for your templates. This seems quite similar to GH actions properties.json files which are documented here.

I was wondering if there is any documentation of the properties.json files you're using in this project, or at least have a reference to some source code which consumes it? I'm building a tool for generating documentation out of my company's repo of shared Azure Pipelines YAML templates and these seem like a good way for adding necessary metadata.

Thanks!

andy-mishechkin commented 3 years ago

Hello, @blake-mealey As far as I know, now we have no any description of template-name.properties.json files. We plan to create this documentation in foreseeable future, and place it in azure-pipelines-yaml repo. Thank you for your note!

blake-mealey commented 3 years ago

Thanks for the response.

FYI here's my docs generation tool: https://www.npmjs.com/package/@pipelinedoc/cli

As you can see, I took inspiration from your format but adapted it to my needs.

stale[bot] commented 3 years ago

In order to consolidate to fewer feedback channels, we've moved suggestions and issue reporting to Developer Community. Sorry for any confusion resulting from this move.