From 8b298bc93ae892ac5b065731ad52969d8a7b5c8a Mon Sep 17 00:00:00 2001 From: Nick Sjostrom Date: Wed, 8 Sep 2021 09:58:01 -0400 Subject: [PATCH] Bump version in README and in commit comment as #minor... --- LICENSE | 2 +- README.md | 56 +++++++++++++++++++++++++++---------------------------- 2 files changed, 29 insertions(+), 29 deletions(-) diff --git a/LICENSE b/LICENSE index 6609e3f2..0b6d33ac 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2019 Lars +Copyright (c) 2019 Nick Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index edbf8d8c..0fc77652 100755 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ jobs: with: fetch-depth: '0' - name: Bump version and push tag - uses: anothrNick/github-tag-action@1.26.0 + uses: anothrNick/github-tag-action@1.36.0 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} WITH_V: true @@ -38,25 +38,25 @@ _NOTE: set the fetch-depth for `actions/checkout@v2` to be sure you retrieve all **Environment Variables** -* **GITHUB_TOKEN** ***(required)*** - Required for permission to tag the repo. -* **DEFAULT_BUMP** *(optional)* - Which type of bump to use when none explicitly provided (default: `minor`). -* **WITH_V** *(optional)* - Tag version with `v` character. -* **RELEASE_BRANCHES** *(optional)* - Comma separated list of branches (bash reg exp accepted) that will generate the release tags. Other branches and pull-requests generate versions postfixed with the commit hash and do not generate any tag. Examples: `master` or `.*` or `release.*,hotfix.*,master` ... -* **CUSTOM_TAG** *(optional)* - Set a custom tag, useful when generating tag based on f.ex FROM image in a docker image. **Setting this tag will invalidate any other settings set!** -* **SOURCE** *(optional)* - Operate on a relative path under $GITHUB_WORKSPACE. -* **DRY_RUN** *(optional)* - Determine the next version without tagging the branch. The workflow can use the outputs `new_tag` and `tag` in subsequent steps. Possible values are ```true``` and ```false``` (default). -* **INITIAL_VERSION** *(optional)* - Set initial version before bump. Default `0.0.0`. -* **TAG_CONTEXT** *(optional)* - Set the context of the previous tag. Possible values are `repo` (default) or `branch`. -* **PRERELEASE_SUFFIX** *(optional)* - Suffix for your prerelease versions, `beta` by default. Note this will only be used if a prerelease branch. -* **VERBOSE** *(optional)* - Print git logs. For some projects these logs may be very large. Possible values are ```true``` (default) and ```false```. +- **GITHUB_TOKEN** **_(required)_** - Required for permission to tag the repo. +- **DEFAULT_BUMP** _(optional)_ - Which type of bump to use when none explicitly provided (default: `minor`). +- **WITH_V** _(optional)_ - Tag version with `v` character. +- **RELEASE_BRANCHES** _(optional)_ - Comma separated list of branches (bash reg exp accepted) that will generate the release tags. Other branches and pull-requests generate versions postfixed with the commit hash and do not generate any tag. Examples: `master` or `.*` or `release.*,hotfix.*,master` ... +- **CUSTOM_TAG** _(optional)_ - Set a custom tag, useful when generating tag based on f.ex FROM image in a docker image. **Setting this tag will invalidate any other settings set!** +- **SOURCE** _(optional)_ - Operate on a relative path under $GITHUB_WORKSPACE. +- **DRY_RUN** _(optional)_ - Determine the next version without tagging the branch. The workflow can use the outputs `new_tag` and `tag` in subsequent steps. Possible values are `true` and `false` (default). +- **INITIAL_VERSION** _(optional)_ - Set initial version before bump. Default `0.0.0`. +- **TAG_CONTEXT** _(optional)_ - Set the context of the previous tag. Possible values are `repo` (default) or `branch`. +- **PRERELEASE_SUFFIX** _(optional)_ - Suffix for your prerelease versions, `beta` by default. Note this will only be used if a prerelease branch. +- **VERBOSE** _(optional)_ - Print git logs. For some projects these logs may be very large. Possible values are `true` (default) and `false`. #### Outputs -* **new_tag** - The value of the newly created tag. -* **tag** - The value of the latest tag after running this action. -* **part** - The part of version which was bumped. +- **new_tag** - The value of the newly created tag. +- **tag** - The value of the latest tag after running this action. +- **part** - The part of version which was bumped. -> ***Note:*** This action creates a [lightweight tag](https://developer.github.com/v3/git/refs/#create-a-reference). +> **_Note:_** This action creates a [lightweight tag](https://developer.github.com/v3/git/refs/#create-a-reference). ### Bumping @@ -65,19 +65,19 @@ If `#none` is contained in the commit message, it will skip bumping regardless ` **Automatic Bumping:** If no `#major`, `#minor` or `#patch` tag is contained in the commit messages, it will bump whichever `DEFAULT_BUMP` is set to (which is `minor` by default). Disable this by setting `DEFAULT_BUMP` to `none`. -> ***Note:*** This action **will not** bump the tag if the `HEAD` commit has already been tagged. +> **_Note:_** This action **will not** bump the tag if the `HEAD` commit has already been tagged. ### Workflow -* Add this action to your repo -* Commit some changes -* Either push to master or open a PR -* On push (or merge), the action will: - * Get latest tag - * Bump tag with minor version unless any commit message contains `#major` or `#patch` - * Pushes tag to github - * If triggered on your repo's default branch (`master` or `main` if unchanged), the bump version will be a release tag. - * If triggered on any other branch, a prerelease will be generated, depending on the bump, starting with `*-.1`, `*-.2`, ... +- Add this action to your repo +- Commit some changes +- Either push to master or open a PR +- On push (or merge), the action will: + - Get latest tag + - Bump tag with minor version unless any commit message contains `#major` or `#patch` + - Pushes tag to github + - If triggered on your repo's default branch (`master` or `main` if unchanged), the bump version will be a release tag. + - If triggered on any other branch, a prerelease will be generated, depending on the bump, starting with `*-.1`, `*-.2`, ... ### Credits @@ -87,8 +87,8 @@ If `#none` is contained in the commit message, it will skip bumping regardless ` A list of projects using github-tag-action for reference. -* another/github-tag-action (uses itself to create tags) +- another/github-tag-action (uses itself to create tags) -* [anothrNick/json-tree-service](https://github.com/anothrNick/json-tree-service) +- [anothrNick/json-tree-service](https://github.com/anothrNick/json-tree-service) > Access JSON structure with HTTP path parameters as keys/indices to the JSON.