https://github.com/0-vortex/release
Experimenting with semantic-release configuration repository for opensauced.pizza
https://github.com/0-vortex/release
Last synced: about 1 year ago
JSON representation
Experimenting with semantic-release configuration repository for opensauced.pizza
- Host: GitHub
- URL: https://github.com/0-vortex/release
- Owner: 0-vortex
- License: mit
- Created: 2021-07-28T21:15:08.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-05-20T01:45:10.000Z (about 3 years ago)
- Last Synced: 2025-04-09T04:03:26.125Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 1.03 MB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 0-vortex/release
> [**semantic-release**](https://github.com/semantic-release/semantic-release) shareable config to publish to `npm` and/or `ghcr`.
> now available as a [GitHub Marketplace action](https://github.com/marketplace/actions/0-vortex-release)
[](https://github.com/0-vortex/release/pulse)
[](https://github.com/0-vortex/release/issues)
[](https://github.com/0-vortex/release/releases)
## 📦 Plugins
This shareable configuration use the following plugins:
- [`@semantic-release/commit-analyzer`](https://github.com/semantic-release/commit-analyzer)
- [`@semantic-release/release-notes-generator`](https://github.com/semantic-release/release-notes-generator)
- [`@semantic-release/changelog`](https://github.com/semantic-release/changelog)
- [`conventional-changelog-conventionalcommits`](https://github.com/conventional-changelog/conventional-changelog)
- [`@semantic-release/npm`](https://github.com/semantic-release/npm)
- [`@google/semantic-release-replace-plugin`](https://github.com/google/semantic-release-replace-plugin)
- [`@semantic-release/git`](https://github.com/semantic-release/git)
- [`@semantic-release/github`](https://github.com/semantic-release/github)
- [`@eclass/semantic-release-docker`](https://github.com/eclass/semantic-release-docker)
- [`@semantic-release/exec`](https://github.com/semantic-release/exec)
- [`semantic-release-major-tag`](https://github.com/doteric/semantic-release-major-tag)
- [`npmlog`](https://github.com/npm/npmlog)
## 🖥️ Requirements
Most important limitations are:
- `GITHUB_TOKEN` for everything
- `NPM_TOKEN` for public `npm` library
- `docker` containers need to be built beforehand
You 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.
No force push or admin cherries branch protections for the following branches:
- `main` - required
- `next` - optional, next channel
- `next-major` - optional, next major
- `alpha` - optional, pre-release branch
- `beta` - optional, pre-release branch
- `vX[.X.X]` - maintenance releases
If you use more than the main branch, optionally create an environment that is limiting where pushes can come from and enable the merge strategy.
We are using `production` in our examples, if you copy paste them you will find this new environment generated in your settings! 🍕
## 🧪 GitHub actions usage
Since version 3 it is possible to use semantic-release without any trace of it or the open-sauced configuration anywhere in the dependency tree.
Docker containers are pushed as part of the release so they mirror the availability of `npm` packages.
The simplest use case for a typical NPM package, almost zero install downtime from ghcr and no more local tooling:
```yaml
name: "Release container"
on:
push:
branches:
- main
- next
- next-major
- alpha
- beta
jobs:
release:
environment:
name: production
url: https://github.com/${{ github.repository }}/releases/tag/${{ env.RELEASE_TAG }}
runs-on: ubuntu-latest
steps:
- name: "☁️ checkout repository"
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: "🚀 release"
id: semantic-release
uses: docker://ghcr.io/0-vortex/release:11.0.0
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
- name: '♻️ cleanup'
run: |
echo ${{ env.RELEASE_TAG }}
echo ${{ env.RELEASE_VERSION }}
```
Marketplace actions should default to the major tag and are essentially more stable as we have to curate every release.
A more traditional approach, only thing really different here is a minor pull overhead and using set outputs instead of environment variables:
```yaml
name: "Release"
on:
push:
branches:
- main
- next
- next-major
- alpha
- beta
jobs:
release:
environment:
name: production
url: https://github.com/${{ github.repository }}/releases/tag/${{ steps.semantic-release.outputs.release-tag }}
name: Semantic release
runs-on: ubuntu-latest
steps:
- name: "☁️ checkout repository"
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: "🚀 release"
id: semantic-release
uses: 0-vortex/release@v11
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
- name: '♻️ cleanup'
run: |
echo ${{ steps.semantic-release.outputs.release-tag }}
echo ${{ steps.semantic-release.outputs.release-version }}
```
## 📦 NPM usage
You 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:
```bash
npm install --save-dev release
```
The 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):
```json
{
"extends": "release"
}
```
Now all you need to do is create a release:
```shell
npx semantic-release
```
## 🔧 Configuration
See each [plugin](#-plugins) documentation for required installation and configuration steps.
### NPM
Set `private` to true in `package.json` if you want to disable `npm`, or, change the scope of package using `publishConfig`.
Keep one of `files` or `main` keys in your `package.json` accurate depending on whether you are building a library or an application.
If you publish, make sure to also provide a valid `NPM_TOKEN` as `.npmrc` authentication is ignored in our config!
### GitHub Actions
Unless you have an `action.yml` present in your root folder, this module is not added to the release config.
If you have an `action.yml` present, our config will attempt to adjust the container version to the newly pushed `npm` and `docker` tags.
### Docker
Unless you have a `Dockerfile` present in your root folder, this module is not added to the release config.
If you have a `Dockerfile` present, our config will attempt to push to `ghcr.io`.
### Environment variables
Using our configuration comes with some sensible defaults:
- `DOCKER_USERNAME=$GITHUB_REPOSITORY_OWNER`
- `DOCKER_PASSWORD=$GITHUB_TOKEN`
- `GIT_COMMITTER_NAME="open-sauced[bot]"`
- `GIT_COMMITTER_EMAIL="63161813+open-sauced[bot]@users.noreply.github.com"`
- `GIT_AUTHOR_NAME` - parsed from commit `$GITHUB_SHA`
- `GIT_AUTHOR_EMAIL` - parsed from commit `$GITHUB_SHA`
Feel 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.
We are actively investigating ways to drop the 2 remaining variables as well!
## 🤝 Contributing
If you decide to fix a bug, make sure to use the conventional commit available at:
```shell
npm run push
```
## 🍕 Community
Got Questions? Join the conversation in our [Discord](https://discord.gg/U2peSNf23P).
Find Open Sauced videos and release overviews on our [YouTube Channel](https://www.youtube.com/channel/UCklWxKrTti61ZCROE1e5-MQ).
## ⚖️ LICENSE
MIT © [TED (Teodor-Eugen Dutulescu) Vortex](./LICENSE)