{"id":18816053,"url":"https://github.com/0-vortex/release","last_synced_at":"2025-04-13T22:21:31.387Z","repository":{"id":43348370,"uuid":"390507351","full_name":"0-vortex/release","owner":"0-vortex","description":"Experimenting with semantic-release configuration repository for opensauced.pizza","archived":false,"fork":false,"pushed_at":"2023-05-20T01:45:10.000Z","size":1078,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-09T04:03:26.125Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/0-vortex.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2021-07-28T21:15:08.000Z","updated_at":"2023-11-20T21:10:45.000Z","dependencies_parsed_at":"2024-10-09T11:31:36.041Z","dependency_job_id":null,"html_url":"https://github.com/0-vortex/release","commit_stats":null,"previous_names":["0-vortex/open-sauced-semantic-config-test"],"tags_count":182,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0-vortex%2Frelease","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0-vortex%2Frelease/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0-vortex%2Frelease/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0-vortex%2Frelease/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/0-vortex","download_url":"https://codeload.github.com/0-vortex/release/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248789750,"owners_count":21161886,"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-11-07T23:52:04.477Z","updated_at":"2025-04-13T22:21:31.329Z","avatar_url":"https://github.com/0-vortex.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/0-vortex/0-vortex/main/static/logo.svg\" width=\"400\"\u003e\n\n# 0-vortex/release\n\n\u003e [**semantic-release**](https://github.com/semantic-release/semantic-release) shareable config to publish to `npm` and/or `ghcr`.\n\n\u003e now available as a [GitHub Marketplace action](https://github.com/marketplace/actions/0-vortex-release)\n\n[![Commits](https://img.shields.io/github/commit-activity/w/0-vortex/release?style=flat)](https://github.com/0-vortex/release/pulse)\n[![Issues](https://img.shields.io/github/issues/0-vortex/release.svg?style=flat)](https://github.com/0-vortex/release/issues)\n[![Releases](https://img.shields.io/github/v/release/0-vortex/release.svg?style=flat)](https://github.com/0-vortex/release/releases)\n\n\u003c/div\u003e\n\n## 📦 Plugins\n\nThis shareable configuration use the following plugins:\n\n- [`@semantic-release/commit-analyzer`](https://github.com/semantic-release/commit-analyzer)\n- [`@semantic-release/release-notes-generator`](https://github.com/semantic-release/release-notes-generator)\n- [`@semantic-release/changelog`](https://github.com/semantic-release/changelog)\n- [`conventional-changelog-conventionalcommits`](https://github.com/conventional-changelog/conventional-changelog)\n- [`@semantic-release/npm`](https://github.com/semantic-release/npm)\n- [`@google/semantic-release-replace-plugin`](https://github.com/google/semantic-release-replace-plugin)\n- [`@semantic-release/git`](https://github.com/semantic-release/git)\n- [`@semantic-release/github`](https://github.com/semantic-release/github)\n- [`@eclass/semantic-release-docker`](https://github.com/eclass/semantic-release-docker)\n- [`@semantic-release/exec`](https://github.com/semantic-release/exec)\n- [`semantic-release-major-tag`](https://github.com/doteric/semantic-release-major-tag)\n- [`npmlog`](https://github.com/npm/npmlog)\n\n## 🖥️ Requirements\n\nMost important limitations are:\n- `GITHUB_TOKEN` for everything\n- `NPM_TOKEN` for public `npm` library\n- `docker` containers need to be built beforehand\n\nYou can skip here if you are using elevated [Private Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token), however we don't recommend going down that path.\n\nNo force push or admin cherries branch protections for the following branches:\n- `main` - required\n- `next` - optional, next channel\n- `next-major` - optional, next major\n- `alpha` - optional, pre-release branch\n- `beta` - optional, pre-release branch\n- `vX[.X.X]` - maintenance releases\n\nIf you use more than the main branch, optionally create an environment that is limiting where pushes can come from and enable the merge strategy.\n\nWe are using `production` in our examples, if you copy paste them you will find this new environment generated in your settings! 🍕\n\n## 🧪 GitHub actions usage\n\nSince version 3 it is possible to use semantic-release without any trace of it or the open-sauced configuration anywhere in the dependency tree.\n\nDocker containers are pushed as part of the release so they mirror the availability of `npm` packages.\n\nThe simplest use case for a typical NPM package, almost zero install downtime from ghcr and no more local tooling:\n\n```yaml\nname: \"Release container\"\n\non:\n  push:\n    branches:\n      - main\n      - next\n      - next-major\n      - alpha\n      - beta\n\njobs:\n  release:\n    environment:\n      name: production\n      url: https://github.com/${{ github.repository }}/releases/tag/${{ env.RELEASE_TAG }}\n    runs-on: ubuntu-latest\n    steps:\n      - name: \"☁️ checkout repository\"\n        uses: actions/checkout@v3\n        with:\n          fetch-depth: 0\n\n      - name: \"🚀 release\"\n        id: semantic-release\n        uses: docker://ghcr.io/0-vortex/release:11.0.0\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}\n\n      - name: '♻️ cleanup'\n        run: |\n          echo ${{ env.RELEASE_TAG }}\n          echo ${{ env.RELEASE_VERSION }}\n```\n\nMarketplace actions should default to the major tag and are essentially more stable as we have to curate every release.\n\nA more traditional approach, only thing really different here is a minor pull overhead and using set outputs instead of environment variables:\n\n```yaml\nname: \"Release\"\n\non:\n  push:\n    branches:\n      - main\n      - next\n      - next-major\n      - alpha\n      - beta\n\njobs:\n  release:\n    environment:\n      name: production\n      url: https://github.com/${{ github.repository }}/releases/tag/${{ steps.semantic-release.outputs.release-tag }}\n    name: Semantic release\n    runs-on: ubuntu-latest\n    steps:\n      - name: \"☁️ checkout repository\"\n        uses: actions/checkout@v3\n        with:\n          fetch-depth: 0\n\n      - name: \"🚀 release\"\n        id: semantic-release\n        uses: 0-vortex/release@v11\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}\n\n      - name: '♻️ cleanup'\n        run: |\n          echo ${{ steps.semantic-release.outputs.release-tag }}\n          echo ${{ steps.semantic-release.outputs.release-version }}\n```\n\n## 📦 NPM usage\n\nYou can opt to use this package in your local tooling. Proceed as you would normally would, replacing `npm` with your package manager of choice and install the package:\n\n```bash\nnpm install --save-dev release\n```\n\nThe shareable config can then be configured in the [**semantic-release** configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration):\n\n```json\n{\n  \"extends\": \"release\"\n}\n```\n\nNow all you need to do is create a release:\n\n```shell\nnpx semantic-release\n```\n\n## 🔧 Configuration\n\nSee each [plugin](#-plugins) documentation for required installation and configuration steps.\n\n### NPM\n\nSet `private` to true in `package.json` if you want to disable `npm`, or, change the scope of package using `publishConfig`.\n\nKeep one of `files` or `main` keys in your `package.json` accurate depending on whether you are building a library or an application.\n\nIf you publish, make sure to also provide a valid `NPM_TOKEN` as `.npmrc` authentication is ignored in our config!\n\n### GitHub Actions\n\nUnless you have an `action.yml` present in your root folder, this module is not added to the release config.\n\nIf you have an `action.yml` present, our config will attempt to adjust the container version to the newly pushed `npm` and `docker` tags.\n\n### Docker\n\nUnless you have a `Dockerfile` present in your root folder, this module is not added to the release config.\n\nIf you have a `Dockerfile` present, our config will attempt to push to `ghcr.io`.\n\n### Environment variables\n\nUsing our configuration comes with some sensible defaults:\n\n- `DOCKER_USERNAME=$GITHUB_REPOSITORY_OWNER`\n- `DOCKER_PASSWORD=$GITHUB_TOKEN`\n- `GIT_COMMITTER_NAME=\"open-sauced[bot]\"`\n- `GIT_COMMITTER_EMAIL=\"63161813+open-sauced[bot]@users.noreply.github.com\"`\n- `GIT_AUTHOR_NAME` - parsed from commit `$GITHUB_SHA`\n- `GIT_AUTHOR_EMAIL` - parsed from commit `$GITHUB_SHA`\n\nFeel free to change any of the above to whatever suits your purpose, our motivation is to keep `GITHUB_TOKEN` and/or `NPM_TOKEN` the only necessary requirements.\n\nWe are actively investigating ways to drop the 2 remaining variables as well!\n\n## 🤝 Contributing\n\nIf you decide to fix a bug, make sure to use the conventional commit available at:\n\n```shell\nnpm run push\n```\n\n## 🍕 Community\n\nGot Questions? Join the conversation in our [Discord](https://discord.gg/U2peSNf23P).  \nFind Open Sauced videos and release overviews on our [YouTube Channel](https://www.youtube.com/channel/UCklWxKrTti61ZCROE1e5-MQ).\n\n## ⚖️ LICENSE\n\nMIT © [TED (Teodor-Eugen Dutulescu) Vortex](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0-vortex%2Frelease","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F0-vortex%2Frelease","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0-vortex%2Frelease/lists"}