{"id":26402473,"url":"https://github.com/dxheroes/gh-action-auto-release","last_synced_at":"2026-04-15T05:31:57.997Z","repository":{"id":196148976,"uuid":"694529397","full_name":"DXHeroes/gh-action-auto-release","owner":"DXHeroes","description":"This GitHub action automatically creates a release in a PR and, after merging, publishes your package to the supported package registry and notifies you of the release in Slack.","archived":false,"fork":false,"pushed_at":"2023-11-15T21:16:06.000Z","size":333,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-17T15:18:52.292Z","etag":null,"topics":["automation","conventional-commits","github-actions","javascript","php","release","release-automation","ruby","sdk","semver","slack"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DXHeroes.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-09-21T07:20:40.000Z","updated_at":"2023-09-26T06:49:56.000Z","dependencies_parsed_at":"2023-11-15T07:47:07.604Z","dependency_job_id":null,"html_url":"https://github.com/DXHeroes/gh-action-auto-release","commit_stats":null,"previous_names":["dxheroes/gh-action-auto-release"],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DXHeroes%2Fgh-action-auto-release","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DXHeroes%2Fgh-action-auto-release/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DXHeroes%2Fgh-action-auto-release/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DXHeroes%2Fgh-action-auto-release/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DXHeroes","download_url":"https://codeload.github.com/DXHeroes/gh-action-auto-release/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244056432,"owners_count":20390720,"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","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":["automation","conventional-commits","github-actions","javascript","php","release","release-automation","ruby","sdk","semver","slack"],"created_at":"2025-03-17T15:18:56.664Z","updated_at":"2026-04-15T05:31:57.981Z","avatar_url":"https://github.com/DXHeroes.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![GitHub release (with filter)](https://img.shields.io/github/v/release/dxheroes/gh-action-auto-release?include_prereleases\u0026sort=semver\u0026label=version)\n\n# GH Action Auto Release v1.0.8 \u003c!-- {x-release-please-version} --\u003e\n\n**Time to implement: 10 minutes.**\n\n**Saved time: 1 hour per each release of any technology.**\n\nThis GitHub Action will automatically create a release and publish your package to the supported package registry.\n\n## How it works\n\nThis action uses [release-please](https://github.com/googleapis/release-please) under the hood. It will create a pull request with the release notes and you can check them before merging.\n\nWhen you merge the pull request, it will create a release with the release notes from the pull request.\n\nEach release will be tagged with a version from the commit message. You can use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) or just add a version number to the commit message.\n\nEvery release will be published to the supported package registry.\n\nYou can get your package published in a few minutes and you won't have to worry about it anymore. Just follow the instructions below and you're done.\n\n## Supported package types\n\n- ✅ node\n- ✅ php\n- ✅ ruby\n\n## Please request other package types in the issues\n\n- 🛠️ .NET\n- 🛠️ dart\n- 🛠️ elixir\n- 🛠️ go\n- 🛠️ helm\n- 🛠️ java\n- 🛠️ maven\n- 🛠️ krm-blueprint\n- 🛠️ maven\n- 🛠️ expo\n- 🛠️ ocaml\n- 🛠️ python\n- 🛠️ rust\n- 🛠️ sfdx\n- 🛠️ simple\n- 🛠️ terraform-module\n\n## Prerequisites\n\n### GitHub Actions\nYou must allow GitHub actions to create and approve pull requests. You can do this in the [organization or repository settings](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#preventing-github-actions-from-creating-or-approving-pull-requests).\n\n- Organization: https://github.com/organizations/YOUR_ORG/settings/actions (replace YOUR_ORG with your organization name) \u003e Workflow permissions \u003e check \"Allow GitHub Actions to create and approve pull requests\".\n- Personal repository: https://github.com/YOUR_OWNER/YOUR_REPO/settings/actions (replace YOUR_OWNER with your GitHub username and YOUR_REPO with your repository name) \u003e Workflow permissions \u003e check \"Allow GitHub Actions to create and approve pull requests\"..\n\n### Node.js package\n\nAdd these secret to your repository:\n\n- name: [NPM_TOKEN](https://docs.npmjs.com/creating-and-viewing-access-tokens#creating-access-tokens) - NPM token with write access to the package. \n  - _Required permissions for Granular Access Token: Packages and scopes \u003e 'Read and write'._\n  - Required permissions for Classic Token: 'Automation'.\n\n### PHP package\n\nAdd these secrets to your repository:\n\n- name: [PACKAGIST_USERNAME](https://packagist.org/profile/) - Packagist username.\n- name: [PACKAGIST_TOKEN](https://packagist.org/profile/) - Packagist token with write access to the package.\n\n### Ruby package\n\nAdd these secret to your repository:\n\n- name: [RUBYGEMS_API_KEY](https://rubygems.org/profile/api_keys) - RubyGems API key with write access to the package. \n  - _Required scope: 'Push rubygem'._\n\n## Usage\n\n### Create your GitHub Action\n\nCreate a new file in your repository `.github/workflows/release.yml` with the following content that fits your package type.\n\n### For Node.js package\n\n\u003c!-- {x-release-please-start-major} --\u003e\n```yaml\nname: Release\non:\n  push:\n    branches:\n      - main # set your default branch\n\npermissions:\n  contents: write\n  pull-requests: write\n\njobs:\n  release:\n    name: Release by DX Heroes\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v3\n      - uses: dxheroes/gh-action-auto-release@v1\n        with:\n          release-type: node\n          package-name: prs-test-js-lib # replace with your package name\n        env:\n          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}\n```\n\u003c!-- {x-release-please-end} --\u003e\n\n### For PHP package\n\u003c!-- {x-release-please-start-major} --\u003e\n```yaml\nname: Release\non:\n  push:\n    branches:\n      - main # set your default branch\n\npermissions:\n  contents: write\n  pull-requests: write\n\njobs:\n  release:\n    name: Release by DX Heroes\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v3\n      - uses: dxheroes/gh-action-auto-release@v1\n        with:\n          release-type: php\n          package-name: prs-test-php-lib\n        env:\n          PACKAGIST_USERNAME: ${{ secrets.PACKAGIST_USERNAME }}\n          PACKAGIST_TOKEN: ${{ secrets.PACKAGIST_TOKEN }}\n```\n\u003c!-- {x-release-please-end} --\u003e\n\n### For Ruby package\n\u003c!-- {x-release-please-start-major} --\u003e\n```yaml\nname: Release\non:\n  push:\n    branches:\n      - main # set your default branch\n\npermissions:\n  contents: write\n  pull-requests: write\n\njobs:\n  release:\n    name: Release by DX Heroes\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v3\n      - uses: dxheroes/gh-action-auto-release@v1\n        with:\n          release-type: ruby\n          package-name: prs-test-ruby-lib\n        env:\n          RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}\n```\n\u003c!-- {x-release-please-end} --\u003e\n\n## Advanced usage\n\n### Arguments for the action\n\n- `release-type` - Type of the release. Default: `node`\n- `package-name` - Name of the package. Required.\n- You can also set other `release-please` arguments. See [release-please documentation](https://github.com/google-github-actions/release-please-action#configuration) for more information.\n\n### Get notified about new releases\n\n#### Slack\n\nJust add this env variable to your workflow:\n\n```yaml\nenv:\n  SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}\n```\n\n[Please request other platforms in the issues](https://github.com/DXHeroes/gh-action-auto-release/issues)\n\nExample of setting up Slack notifications for node.js package:\n\u003c!-- {x-release-please-start-major} --\u003e\n```yaml\nname: Release\non:\n  push:\n    branches:\n      - main # set your default branch\n\npermissions:\n  contents: write\n  pull-requests: write\n\njobs:\n  release:\n    name: Release by DX Heroes\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v3\n      - uses: dxheroes/gh-action-auto-release@v1\n        with:\n          release-type: node\n          package-name: prs-test-js-lib # replace with your package name\n        env:\n          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}\n          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} ## Configure SLACK_WEBHOOK_URL\n```\n\u003c!-- {x-release-please-end} --\u003e\n\n### Customize package path when using monorepo or is not in the root directory\n\nSet `working-directory` to the path of the package. For example:\n\n```yaml\nname: Release\non:\n  push:\n    branches:\n      - main # set your default branch\n\npermissions:\n  contents: write\n  pull-requests: write\n\njobs:\n  release:\n    name: Release by DX Heroes\n    runs-on: ubuntu-latest\n    defaults:\n      run:\n        working-directory: libraries/js-lib # replace with your package path\n    steps:\n      # ...\n```\n\n## Contributing\n\nAll contributions are welcome. Please create an issue or submit a pull request.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdxheroes%2Fgh-action-auto-release","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdxheroes%2Fgh-action-auto-release","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdxheroes%2Fgh-action-auto-release/lists"}