{"id":13826022,"url":"https://github.com/mikeal/merge-release","last_synced_at":"2025-05-16T15:07:19.337Z","repository":{"id":47195283,"uuid":"167742837","full_name":"mikeal/merge-release","owner":"mikeal","description":"Automatically release all merges to master on npm.","archived":false,"fork":false,"pushed_at":"2023-06-12T12:41:02.000Z","size":95,"stargazers_count":480,"open_issues_count":20,"forks_count":66,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-05-12T18:04:41.425Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mikeal.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}},"created_at":"2019-01-26T21:50:24.000Z","updated_at":"2025-05-02T20:42:22.000Z","dependencies_parsed_at":"2024-01-18T04:07:14.618Z","dependency_job_id":"420ec558-7296-4120-b96e-fc87b2f07801","html_url":"https://github.com/mikeal/merge-release","commit_stats":{"total_commits":166,"total_committers":14,"mean_commits":"11.857142857142858","dds":"0.10240963855421692","last_synced_commit":"7f590a5adf6e9def8e399a0a569d22d0de016dc0"},"previous_names":["mikeal/auto-release"],"tags_count":34,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikeal%2Fmerge-release","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikeal%2Fmerge-release/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikeal%2Fmerge-release/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikeal%2Fmerge-release/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mikeal","download_url":"https://codeload.github.com/mikeal/merge-release/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254553959,"owners_count":22090417,"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":[],"created_at":"2024-08-04T09:01:30.927Z","updated_at":"2025-05-16T15:07:19.313Z","avatar_url":"https://github.com/mikeal.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"## merge-release\n\nGitHub Action for automated npm publishing.\n\nThis Action publishes a package to npm. It is meant to be used on every successful merge to master but \nyou'll need to configure that workflow yourself. You can look to the\n[`.github/workflows/push.yml`](./.github/workflows/mikeals-workflow.yml) file in this project as an example.\n\n### Workflow\n\n* Check for the latest version number published to npm.\n* Lookup all commits between the git commit that triggered the action and the latest publish.\n  * If the package hasn't been published or the prior publish does not include a git hash, we'll\n    only pull the commit data that triggered the action.\n* Based on the commit messages, increment the version from the lastest release.\n  * If the string \"BREAKING CHANGE\" is found anywhere in any of the commit messages or descriptions the major \n    version will be incremented.\n  * If a commit message begins with the string \"feat\" then the minor version will be increased. This works\n    for most common commit metadata for feature additions: `\"feat: new API\"` and `\"feature: new API\"`.\n  * All other changes will increment the patch version.\n* Publish to npm using the configured token.\n* Push a tag for the new version to GitHub.\n\n\n### Configuration\n\nYou can configure some aspects of merge-release action by passing some environmental variables.\n\n* **GITHUB_TOKEN (required)**\n  * Github token to allow tagging the version.\n* **NPM_AUTH_TOKEN (required)**\n  * NPM Auth Token to publish to NPM, read [here](https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) how to setup it as a secret.\n* **DEPLOY_DIR**\n  * The path where the dist `package.json` is to run npm publish. Defaults to the root dir.\n* **SRC_PACKAGE_DIR**\n  * The path where the src package.json is found. Defaults to the root dir.\n* **NPM_REGISTRY_URL**\n  * NPM Registry URL to use. defaults to: `https://registry.npmjs.org/`\n\n`merge-release` will use `npm publish` unless you've defined a `publish` script in your `package.json`.\n\n```yaml\n- uses: mikeal/merge-release@master\n  env:\n      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n      NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}\n      DEPLOY_DIR: my/deploy/dir\n      SRC_PACKAGE_DIR: my/src/package\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikeal%2Fmerge-release","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmikeal%2Fmerge-release","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikeal%2Fmerge-release/lists"}