{"id":19404300,"url":"https://github.com/hasithaishere/pr-metadata-action","last_synced_at":"2025-09-12T02:42:51.696Z","repository":{"id":156453573,"uuid":"633013887","full_name":"hasithaishere/pr-metadata-action","owner":"hasithaishere","description":"Github action for managing the release version and tags based on the release type.","archived":false,"fork":false,"pushed_at":"2023-05-05T05:20:13.000Z","size":660,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-01T12:52:50.129Z","etag":null,"topics":["github-action","release","release-automation","tagging"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hasithaishere.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-26T15:39:35.000Z","updated_at":"2023-05-05T05:26:03.000Z","dependencies_parsed_at":null,"dependency_job_id":"d37ecb49-9b06-4263-ab56-639b49e3d700","html_url":"https://github.com/hasithaishere/pr-metadata-action","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/hasithaishere/pr-metadata-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hasithaishere%2Fpr-metadata-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hasithaishere%2Fpr-metadata-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hasithaishere%2Fpr-metadata-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hasithaishere%2Fpr-metadata-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hasithaishere","download_url":"https://codeload.github.com/hasithaishere/pr-metadata-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hasithaishere%2Fpr-metadata-action/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274744062,"owners_count":25341136,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-12T02:00:09.324Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-action","release","release-automation","tagging"],"created_at":"2024-11-10T11:33:57.973Z","updated_at":"2025-09-12T02:42:51.667Z","avatar_url":"https://github.com/hasithaishere.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Release Management Action\nGithub 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.\n\n## Setting up this action\n\n1. If you haven't already done so, create a `.github/workflows` folder in your\n  repository (_this is where your actions will live_).\n\n2. Now create a `.github/workflows/release-tagging.yml` file with these contents:\n``` yaml\nname: Tag and Release\n\non:\n  pull_request:\n    types: [ closed ]\n\njobs:\n  release:\n    if: github.event.pull_request.merged \u0026\u0026 (startsWith(github.event.pull_request.head.ref, 'flight/') || startsWith(github.event.pull_request.head.ref, 'hotfix/'))\n    runs-on: ubuntu-latest\n    name: Tag and Release\n    steps:\n      - name: Release\n        uses: respond-io/release-management-action@main\n        with:\n          owner: ${{ github.repository_owner }}\n          repo: ${{ github.event.repository.name }}\n          token: ${{ secrets.GITHUB_TOKEN }}\n```\n\nFor functioning this this action it requires, Github access token with following permissions.\n- **Read access** to codespaces, commit statuses, and metadata\n- **Read and Write access** to code and pull requests\n\n\u003e **Note:** Please always create a fine grained token in Github level with only specific repository.\n\n\u003cp align='center'\u003e \u003cimg src=\"docs/github-token-permission.png\"/\u003e\u003c/p\u003e \u003cp align='center'\u003e Figure 1 : GitHub Token Permission \u003c/p\u003e \n\u003chr\u003e\n\u003cp align='center'\u003e \u003cimg src=\"docs/github-token-type.png\"/\u003e\u003c/p\u003e \u003cp align='center'\u003e Figure 2 : GitHub Token Type \u003c/p\u003e \n\n## Features\n- Automatically managed Github tagging and releasing based on the pull request's branch prefix.\n\u003e _As an example,_\nif it have been merged branch which starts from `flight/` it increase the minor version number. ex - `v1.0.1` to `v1.2.0`.\nIf the PR branch starts with `hotfix/` prefix, it increase the patch release number.\nex - `v1.0.1` to `v1.0.2`\n\n\u003cp align='center'\u003e \u003cimg src=\"docs/semantic-versioning-structure.jpg\"/\u003e\u003c/p\u003e \u003cp align='center'\u003e Figure 3 : Semantic Versioning \u003c/p\u003e \n\n- Update CHANGELOG.md file based on release feature and fixes. This categorization will handle based on the commit name prefixes.\n- Automatically update `package.json` file's `version` property\n\u003e **Note:**\nAs an example this will update,\n-- Root level `package.json` file\n-- ECS service's root level `package.json`\n-- Lambda's root level or function level or layer level `package.json` files\n\n\u003e_( In Lambda `package.json` file only update if the action identify when the function level or layer level changes )_\n\n#### How should Developer write commits?\n\nThe most important prefixes you should have in mind are:\n\n* `fix:` which represents bug fixes, and correlates to a [SemVer](https://semver.org/)\n  patch. These Commits automatically identifies as _Bug Fixes_.\n* `feat:` which represents a new feature, and correlates to a SemVer minor. These commits identifies as _Features_.\n* `chore:` or any other prefix based commits are identified as _Other Commits_.\n\n\u003e [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. \n\n## For Maintainers\n\nAs 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.\n\n```sh\nnpm i -g @vercel/ncc --save\n```\n\nAfter your development, please execute following command for building the package file, then push the code to GitHub.\n\n```sh\nnpm run build\n```\n\n## Developers\n\n- [Hasitha Gamage](hasitha@rocketbots.io)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhasithaishere%2Fpr-metadata-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhasithaishere%2Fpr-metadata-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhasithaishere%2Fpr-metadata-action/lists"}