Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/janszewczyk/semantic-release-config
Semantic-release shareable configuration to publish GitHub projects using GitHub Actions workflows.
https://github.com/janszewczyk/semantic-release-config
conventional-changelog github github-publish npm npm-publish release semantic-release semantic-release-config semantic-release-preset szum-tech
Last synced: 13 days ago
JSON representation
Semantic-release shareable configuration to publish GitHub projects using GitHub Actions workflows.
- Host: GitHub
- URL: https://github.com/janszewczyk/semantic-release-config
- Owner: JanSzewczyk
- License: mit
- Created: 2023-02-25T19:41:56.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-07T22:24:27.000Z (26 days ago)
- Last Synced: 2024-12-07T22:26:21.081Z (26 days ago)
- Topics: conventional-changelog, github, github-publish, npm, npm-publish, release, semantic-release, semantic-release-config, semantic-release-preset, szum-tech
- Language: JavaScript
- Homepage:
- Size: 323 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @szum-tech/semantic-release-config
[](https://github.com/JanSzewczyk/semantic-release-config/pulls)
[](https://github.com/JanSzewczyk/semantic-release-config/issues)
[](https://github.com/JanSzewczyk/semantic-release-config/actions/workflows/publish.yml)
[](https://www.npmjs.com/package/@szum-tech/semantic-release-config)
[](https://conventionalcommits.org)
[](https://github.com/JanSzewczyk/semantic-release-config/blob/main/LICENSE)
---
Semantic-release shareable configuration to publish GitHub projects using GitHub Actions workflows.
# Features
- Uses [Conventional Commits](https://www.conventionalcommits.org/) to generate
[release notes](https://github.com/semantic-release/release-notes-generator),
[changelogs](https://github.com/semantic-release/changelog) and
[determine the version for new releases](https://github.com/semantic-release/commit-analyzer).
- [Creates or updates a CHANGELOG.md file](https://github.com/semantic-release/changelog).
- [Publishes to npm (optional)](https://github.com/semantic-release/npm).
- [Creates a new release on GitHub](https://github.com/semantic-release/github)
- [Updates GitHub issues and PRs that are resolved by a new release](https://github.com/semantic-release/github#successcomment).
- [Commits and pushes the current `version` to `package.json`](https://github.com/semantic-release/git).
# Usage
## Installation
[@szum-tech/semantic-release-preset](https://www.npmjs.com/package/@szum-tech/semantic-release-preset) is available as
an [npm package](https://www.npmjs.com/package/@szum-tech/semantic-release-preset).
**npm:**
```sh
npm install -D semantic-release @szum-tech/semantic-release-config
```
**yarn:**
```sh
yarn add -D semantic-release @szum-tech/semantic-release-config
```
## Setup release configuration file
First create `release.config.js` file in main project root and add configuration:
```js
/** @type {import('semantic-release').Options} */
module.exports = {
branches: ["main"],
extends: "@szum-tech/semantic-release-config"
// OR
// if you don't want to publish your project on npm, please use:
// extends: "@szum-tech/semantic-release-preset/without-npm"
};
```
The `branches` array is [mandatory](https://semantic-release.gitbook.io/semantic-release/usage/configuration#branches),
and in most repositories you should put the default git branch here (`main`, or `master` if it's an older repository).
## Environment Variables Configuration
Ensure that your CI configuration has the following environment variables set:
- GITHUB_TOKEN:
[A GitHub personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
- NPM_TOKEN: [A npm personal access token](https://www.npmjs.com/package/settings) (**optional** if you don't publish
your project on npm)
## Minimal GitHub Release workflow
This is the bare minimum required steps to trigger a new release. This will push a new release every time an eligible
commit is pushed to git. Check the opinionated flow to see how to trigger releases manually. Create
`.github/workflows/publish.yml`:
```yaml
name: Publish 🚀
on:
push:
branches: [main]
jobs:
publish:
name: Publish 🚀
runs-on: ${{ matrix.os }}
strategy:
matrix:
node-version: [18.x]
os: [ubuntu-latest]
steps:
- name: Checkout code 📚
uses: actions/checkout@v3
- name: Set up Node 🟢
uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node-version }}
- name: Install packages ⚙️
run: npm ci
# run: yarn install --frozen-lockfile
- name: Publish package 🚀
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }} # OPTIONAL if you don't publish your project on npm
run: npx semantic-release
# run: yarn semantic-release
```
# Changelog
The [changelog](https://github.com/JanSzewczyk/semantic-release-preset/blob/main/CHANGELOG.md) is regularly updated to
reflect what's changed in each new release.
# License
This project is licensed under the terms of the
[MIT license](https://github.com/JanSzewczyk/semantic-release-preset/blob/main/LICENSE).