azure-devops-yaml-schema
azure-devops-yaml-schema copied to clipboard
Document that target can be a branch
Based on https://github.com/microsoft/coe-starter-kit/blob/3d5598bcef607055d41bcaf9c11538558254e3a3/CenterofExcellenceResources/Release/Pipelines/CoEStarterKit/create-github-release.yml#L201 , this input can be a branch name. Please confirm. Hopefully, I'll be able to confirm soon.
- [ ] Are you creating a new task article? If yes, STOP. New task articles are auto-generated when the new task is deployed to an Azure DevOps sprint, including all task inputs, aliases, defaults, and allowed values. Once the task deploys and the article is generated, you can make a PR to add examples, remarks, and descriptions. If you have a readme.md file in the tasks repo for your new task, that content will be picked up as well. If you have a section in the readme.md file that explains what makes this new version of the task different than the previous version, that is greatly appreciated.
- [x] Are you editing a task or YAML schema definition article? We welcome your contributions to content that is contained within "editable-content" tags. Any contributions outside of an "editable-content" tag won't be merged as these articles are auto-generated (and auto-updated when new properties or inputs are deployed), with the exception of the content inside "editable-content" tags.
@TravisEz13 : Thanks for your contribution! The author(s) have been notified to review your proposed change.
@TravisEz13 : Thanks for your contribution! The author(s) have been notified to review your proposed change.
Learn Build status updates of commit 8ca0542:
:white_check_mark: Validation status: passed
| File | Status | Preview URL | Details |
|---|---|---|---|
| task-reference/github-release-v1.md | :white_check_mark:Succeeded |
For more details, please refer to the build report.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
@TravisEz13 Sorry for the long delay, and thank you for making this PR. This task just calls the GH API for creating a release, and that parameter is described as target_commitish: Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch.
https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28#create-a-release
The GitHub action version of the task says the same thing. I am merging this PR and thank you for making the PR and helping to improve the docs.