diff --git a/.editorconfig b/.editorconfig index afcf269..a6ec277 100644 --- a/.editorconfig +++ b/.editorconfig @@ -11,3 +11,6 @@ insert_final_newline = true [*.yml] indent_size = 2 + +[*.md] +indent_size = 2 diff --git a/README.md b/README.md index b4d1828..204e136 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,20 @@ GitHub Actions that allow to install and use the GitVersion and GitReleaseManage [![Build Status](https://github.com/GitTools/actions/workflows/CI/badge.svg)](https://github.com/GitTools/actions/actions) [![Build Status](https://github.com/GitTools/actions/workflows/release/badge.svg)](https://github.com/GitTools/actions/actions) +[![Azure Pipeline Task](https://img.shields.io/badge/marketplace-gittools.gittools-blue?logo=visual-studio)](https://marketplace.visualstudio.com/items?itemName=gittools.gittools) +[![Github Action](https://img.shields.io/badge/marketplace-use--actions-blue?logo=github)](https://github.com/marketplace/actions/use-actions) + ## Usage -See [setup](gitversion/setup/action.yml) and [usage](gitversion/execute/action.yml) for GitVersion +see examples of usages for **GitVersion**: -and [setup](gitreleasemanager/setup/action.yml) for GitReleaseManager +- [GitHub Actions](docs/github/gitversion) +- [Azure Pipeline tasks](docs/azure/gitversion) + +and for **GitReleaseManager**: + +- [GitHub Actions](docs/github/gitreleasemanager) +- [Azure Pipeline tasks](docs/azure/gitreleasemanager) ## Dependency @@ -34,12 +43,12 @@ Basic: - name: Fetch all history for all tags and branches run: git fetch --prune --unshallow - name: Install GitVersion - uses: gittools/actions/gitversion/setup@v0.6.1 + uses: gittools/actions/gitversion/setup@v0.9 with: versionSpec: '5.1.x' - name: Use GitVersion id: gitversion # step id used as reference for output values - uses: gittools/actions/gitversion/execute@v0.6.1 + uses: gittools/actions/gitversion/execute@v0.9 - run: | echo "Major: ${{ steps.gitversion.outputs.major }}" echo "Minor: ${{ steps.gitversion.outputs.minor }}" @@ -76,7 +85,7 @@ Basic: ### Private Repositories -Private repos require credentials before you can fetch the master branch and tags. +Private repos require credentials before you can fetch the master branch and tags. ```yaml steps: diff --git a/docs/examples/azure/gitreleasemanager/addasset.md b/docs/examples/azure/gitreleasemanager/addasset.md new file mode 100644 index 0000000..6bdd1c8 --- /dev/null +++ b/docs/examples/azure/gitreleasemanager/addasset.md @@ -0,0 +1,14 @@ +# Example + +```yaml + steps: + - task: gitreleasemanager/addasset@0 + inputs: + token: '$(GITHUB_TOKEN)' + owner: 'someOwner' + repository: 'someRepo' + tagName: '0.1.0' + assets: | + src/test.txt + src/test1.txt +``` diff --git a/docs/examples/azure/gitreleasemanager/close.md b/docs/examples/azure/gitreleasemanager/close.md new file mode 100644 index 0000000..b4b8474 --- /dev/null +++ b/docs/examples/azure/gitreleasemanager/close.md @@ -0,0 +1,11 @@ +# Example + +```yaml + steps: + - task: gitreleasemanager/close@0 + inputs: + token: '$(GITHUB_TOKEN)' + owner: 'someOwner' + repository: 'someRepo' + milestone: '0.1.0' +``` diff --git a/docs/examples/azure/gitreleasemanager/create.md b/docs/examples/azure/gitreleasemanager/create.md new file mode 100644 index 0000000..4bcf2ed --- /dev/null +++ b/docs/examples/azure/gitreleasemanager/create.md @@ -0,0 +1,16 @@ +# Example + +```yaml + steps: + - task: gitreleasemanager/create@0 + displayName: Create release with GitReleaseManager + inputs: + token: $(GITHUB_TOKEN) + owner: 'someOwner' + repository: 'someRepo' + milestone: '0.1.0' + name: 'v0.1.0' + assets: | + src/test.txt + src/test1.txt +``` diff --git a/docs/examples/azure/gitreleasemanager/discard.md b/docs/examples/azure/gitreleasemanager/discard.md new file mode 100644 index 0000000..2dd181d --- /dev/null +++ b/docs/examples/azure/gitreleasemanager/discard.md @@ -0,0 +1,11 @@ +# Example + +```yaml + steps: + - task: gitreleasemanager/discard@0 + inputs: + token: '$(GITHUB_TOKEN)' + owner: 'someOwner' + repository: 'someRepo' + milestone: '0.1.0' +``` diff --git a/docs/examples/azure/gitreleasemanager/open.md b/docs/examples/azure/gitreleasemanager/open.md new file mode 100644 index 0000000..501fdd2 --- /dev/null +++ b/docs/examples/azure/gitreleasemanager/open.md @@ -0,0 +1,11 @@ +# Example + +```yaml + steps: + - task: gitreleasemanager/open@0 + inputs: + token: '$(GITHUB_TOKEN)' + owner: 'someOwner' + repository: 'someRepo' + milestone: '0.1.0' +``` diff --git a/docs/examples/azure/gitreleasemanager/publish.md b/docs/examples/azure/gitreleasemanager/publish.md new file mode 100644 index 0000000..50e3daa --- /dev/null +++ b/docs/examples/azure/gitreleasemanager/publish.md @@ -0,0 +1,11 @@ +# Example + +```yaml + steps: + - task: gitreleasemanager/publish@0 + inputs: + token: '$(GITHUB_TOKEN)' + owner: 'someOwner' + repository: 'someRepo' + tagName: '0.1.0' +``` diff --git a/docs/examples/azure/gitreleasemanager/setup.md b/docs/examples/azure/gitreleasemanager/setup.md new file mode 100644 index 0000000..797f5e3 --- /dev/null +++ b/docs/examples/azure/gitreleasemanager/setup.md @@ -0,0 +1,9 @@ +# Example + +```yaml + steps: + - task: gitreleasemanager/setup@0 + displayName: Install GitReleaseManager + inputs: + versionSpec: '0.10.x' +``` diff --git a/docs/examples/azure/gitversion/execute.md b/docs/examples/azure/gitversion/execute.md new file mode 100644 index 0000000..f9b59ef --- /dev/null +++ b/docs/examples/azure/gitversion/execute.md @@ -0,0 +1,10 @@ +# Example + +```yaml + steps: + - task: gitversion/execute@0 + displayName: Use GitVersion + - script: | + echo "FullSemVer: $(fullSemVer)" + echo "##vso[build.updatebuildnumber]$(fullSemVer)" +``` diff --git a/docs/examples/azure/gitversion/setup.md b/docs/examples/azure/gitversion/setup.md new file mode 100644 index 0000000..bf1cdf1 --- /dev/null +++ b/docs/examples/azure/gitversion/setup.md @@ -0,0 +1,9 @@ +# Example + +```yaml + steps: + - task: gitversion/setup@0 + displayName: Install GitVersion + inputs: + versionSpec: '5.1.2' +``` diff --git a/docs/examples/github/gitreleasemanager/addasset.md b/docs/examples/github/gitreleasemanager/addasset.md new file mode 100644 index 0000000..54ba6b9 --- /dev/null +++ b/docs/examples/github/gitreleasemanager/addasset.md @@ -0,0 +1,15 @@ +# Example + +```yaml + steps: + - uses: gittools/actions/gitreleasemanager/addasset@v0.9 + name: Add asset to a release with GitReleaseManager + with: + token: ${{ secrets.GITHUB_TOKEN }} + owner: 'someOwner' + repository: 'someRepository' + tagName: '0.1.0' + assets: | + src/test.txt + src/test1.txt +``` diff --git a/docs/examples/github/gitreleasemanager/close.md b/docs/examples/github/gitreleasemanager/close.md new file mode 100644 index 0000000..6f25c41 --- /dev/null +++ b/docs/examples/github/gitreleasemanager/close.md @@ -0,0 +1,12 @@ +# Example + +```yaml + steps: + - uses: gittools/actions/gitreleasemanager/close@v0.9 + name: Close release with GitReleaseManager + with: + token: ${{ secrets.GITHUB_TOKEN }} + owner: 'someOwner' + repository: 'someRepository' + milestone: '0.1.0' +``` diff --git a/docs/examples/github/gitreleasemanager/create.md b/docs/examples/github/gitreleasemanager/create.md new file mode 100644 index 0000000..df50bc3 --- /dev/null +++ b/docs/examples/github/gitreleasemanager/create.md @@ -0,0 +1,16 @@ +# Example + +```yaml + steps: + - uses: gittools/actions/gitreleasemanager/create@v0.9 + name: Create release with GitReleaseManager + with: + token: ${{ secrets.GITHUB_TOKEN }} + owner: 'someOwner' + repository: 'someRepository' + milestone: '0.1.0' + name: 'v0.1.0' + assets: | + src/test.txt + src/test1.txt +``` diff --git a/docs/examples/github/gitreleasemanager/discard.md b/docs/examples/github/gitreleasemanager/discard.md new file mode 100644 index 0000000..22e27c9 --- /dev/null +++ b/docs/examples/github/gitreleasemanager/discard.md @@ -0,0 +1,12 @@ +# Example + +```yaml + steps: + - uses: gittools/actions/gitreleasemanager/discard@v0.9 + name: Discard release with GitReleaseManager + with: + token: ${{ secrets.GITHUB_TOKEN }} + owner: 'someOwner' + repository: 'someRepository' + milestone: '0.1.0' +``` diff --git a/docs/examples/github/gitreleasemanager/open.md b/docs/examples/github/gitreleasemanager/open.md new file mode 100644 index 0000000..1b320be --- /dev/null +++ b/docs/examples/github/gitreleasemanager/open.md @@ -0,0 +1,12 @@ +# Example + +```yaml + steps: + - uses: gittools/actions/gitreleasemanager/open@v0.9 + name: Open release with GitReleaseManager + with: + token: ${{ secrets.GITHUB_TOKEN }} + owner: 'someOwner' + repository: 'someRepository' + milestone: '0.1.0' +``` diff --git a/docs/examples/github/gitreleasemanager/publish.md b/docs/examples/github/gitreleasemanager/publish.md new file mode 100644 index 0000000..6e0d92e --- /dev/null +++ b/docs/examples/github/gitreleasemanager/publish.md @@ -0,0 +1,12 @@ +# Example + +```yaml + steps: + - uses: gittools/actions/gitreleasemanager/publish@v0.9 + name: Publish release with GitReleaseManager + with: + token: ${{ secrets.GITHUB_TOKEN }} + owner: 'someOwner' + repository: 'someRepository' + tagName: '0.1.0' +``` diff --git a/docs/examples/github/gitreleasemanager/setup.md b/docs/examples/github/gitreleasemanager/setup.md new file mode 100644 index 0000000..69c3b8a --- /dev/null +++ b/docs/examples/github/gitreleasemanager/setup.md @@ -0,0 +1,9 @@ +# Example + +```yaml + steps: + - uses: gittools/actions/gitreleasemanager/setup@v0.9 + name: Install GitReleaseManager + with: + versionSpec: '0.10.x' +``` diff --git a/docs/examples/github/gitversion/execute.md b/docs/examples/github/gitversion/execute.md new file mode 100644 index 0000000..36dc04b --- /dev/null +++ b/docs/examples/github/gitversion/execute.md @@ -0,0 +1,15 @@ +# Example + +```yaml + steps: + - name: Fetch all history for all tags and branches + run: git fetch --prune --unshallow + - name: Use GitVersion + id: gitversion # step id used as reference for output values + uses: gittools/actions/gitversion/execute@v0.9 + - run: | + echo "Major: ${{ steps.gitversion.outputs.major }}" + echo "Minor: ${{ steps.gitversion.outputs.minor }}" + echo "Patch: ${{ steps.gitversion.outputs.patch }}" + name: Output +``` diff --git a/docs/examples/github/gitversion/setup.md b/docs/examples/github/gitversion/setup.md new file mode 100644 index 0000000..017e2e6 --- /dev/null +++ b/docs/examples/github/gitversion/setup.md @@ -0,0 +1,11 @@ +# Example + +```yaml + steps: + - name: Checkout + uses: actions/checkout@v2 + - name: Install GitVersion + uses: gittools/actions/gitversion/setup@v0.9 + with: + versionSpec: '5.1.x' +```