https://github.com/hasithaishere/pr-metadata-action
Github action for managing the release version and tags based on the release type.
https://github.com/hasithaishere/pr-metadata-action
github-action release release-automation tagging
Last synced: 9 months ago
JSON representation
Github action for managing the release version and tags based on the release type.
- Host: GitHub
- URL: https://github.com/hasithaishere/pr-metadata-action
- Owner: hasithaishere
- License: mit
- Created: 2023-04-26T15:39:35.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-05T05:20:13.000Z (about 3 years ago)
- Last Synced: 2025-09-01T12:52:50.129Z (10 months ago)
- Topics: github-action, release, release-automation, tagging
- Language: JavaScript
- Homepage:
- Size: 645 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Release Management Action
Github action for managing the release version and tags based on the release type. In GitHub action inspires from the [release-please-action](https://github.com/google-github-actions/release-please-action) Github action.
## Setting up this action
1. If you haven't already done so, create a `.github/workflows` folder in your
repository (_this is where your actions will live_).
2. Now create a `.github/workflows/release-tagging.yml` file with these contents:
``` yaml
name: Tag and Release
on:
pull_request:
types: [ closed ]
jobs:
release:
if: github.event.pull_request.merged && (startsWith(github.event.pull_request.head.ref, 'flight/') || startsWith(github.event.pull_request.head.ref, 'hotfix/'))
runs-on: ubuntu-latest
name: Tag and Release
steps:
- name: Release
uses: respond-io/release-management-action@main
with:
owner: ${{ github.repository_owner }}
repo: ${{ github.event.repository.name }}
token: ${{ secrets.GITHUB_TOKEN }}
```
For functioning this this action it requires, Github access token with following permissions.
- **Read access** to codespaces, commit statuses, and metadata
- **Read and Write access** to code and pull requests
> **Note:** Please always create a fine grained token in Github level with only specific repository.
Figure 1 : GitHub Token Permission
Figure 2 : GitHub Token Type
## Features
- Automatically managed Github tagging and releasing based on the pull request's branch prefix.
> _As an example,_
if it have been merged branch which starts from `flight/` it increase the minor version number. ex - `v1.0.1` to `v1.2.0`.
If the PR branch starts with `hotfix/` prefix, it increase the patch release number.
ex - `v1.0.1` to `v1.0.2`
Figure 3 : Semantic Versioning
- Update CHANGELOG.md file based on release feature and fixes. This categorization will handle based on the commit name prefixes.
- Automatically update `package.json` file's `version` property
> **Note:**
As an example this will update,
-- Root level `package.json` file
-- ECS service's root level `package.json`
-- Lambda's root level or function level or layer level `package.json` files
>_( In Lambda `package.json` file only update if the action identify when the function level or layer level changes )_
#### How should Developer write commits?
The most important prefixes you should have in mind are:
* `fix:` which represents bug fixes, and correlates to a [SemVer](https://semver.org/)
patch. These Commits automatically identifies as _Bug Fixes_.
* `feat:` which represents a new feature, and correlates to a SemVer minor. These commits identifies as _Features_.
* `chore:` or any other prefix based commits are identified as _Other Commits_.
> [Respond.io Git Workflows](https://www.notion.so/respond/Respond-io-Git-Workflows-c1e4bcd290094236a6a6e78b06107f42) Notion post's rules and suggestions also supports to above commit name strategies.
## For Maintainers
As general, this Github action also use ncc to package the code in to single js file. So in the development please globally install ncc first.
```sh
npm i -g @vercel/ncc --save
```
After your development, please execute following command for building the package file, then push the code to GitHub.
```sh
npm run build
```
## Developers
- [Hasitha Gamage](hasitha@rocketbots.io)