A Semantic Release configuration for releasing code within the Galaxy.
npm install --save-dev @theholocron/semantic-release-configIn your project package.json add the following:
{
"release": {
"extends": "@theholocron/semantic-release-config",
"branch": "master"
},
}We use the following plugins within the Semantic Release ecosystem:
@semantic-release/commit-analyzer@semantic-release/release-notes-generator@semantic-release/npm@semantic-release/github@semantic-release/git
This allows us to:
- Provide an informative git commit message for the release commit that does not trigger continuous integration and conforms to the conventional commits specification (e.g.,
"chore(release): 1.2.3 [skip ci]\n\nnotes"). - Create a tarball that gets uploaded with each GitHub release.
- Publish the same tarball to npm.
- Commit the version change in
package.json. - Create or update a CHANGELOG file.
Ensure that your CI configuration has the following secret environment variables set:
GH_TOKENwithpublic_repoaccess.NPM_TOKENNODE_AUTH_TOKEN
See above for each plugins documentation for required installation and configuration steps.
If you're configuring a GitHub workflow you might want to do a test build matrix first and then publish only if those tests succeed across all environments. The following will do just that, immediately after something is merged into master.
name: Node CI
on:
push:
branches:
- master
jobs:
test:
name: Test on node ${{ matrix.node }} and ${{ matrix.os }}
runs-on: ${{ matrix.os }}
strategy:
matrix:
node: [8, 10, 12]
os:
- ubuntu-latest
- windows-latest
- macOS-latest
steps:
- name: Preserve line endings
run: git config --global core.autocrlf false
- name: Checkout
uses: actions/checkout@v1
- name: Setup Node
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node }}
- name: Install & test/cover
run: npm ci && npm run cover
env:
CI: true
release:
name: npm publish / GitHub release
needs: test
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v1
- name: Setup Node
uses: actions/setup-node@v1
with:
node-version: 12
registry-url: https://registry.npmjs.org/
- name: Install
env:
CI: true
run: npm ci
- name: Build
if: success()
run: npm run build
- name: Semantic Release
if: success()
env:
GH_TOKEN: ${{ secrets.GH_TOKEN }}
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
run: npx semantic-release
This project uses a CHANGELOG and GitHub releases which contains a curated, chronologically ordered list of notable changes for each version of a project. Read more about changelogs.
We use SemVer for its versioning providing us an opt-in approach to releases. This means we add a version number according to the spec, as you see below. So rather than force developers to consume the latest and greatest, they can choose which version to consume and test any newer ones before upgrading. Please the read the spec as it goes into further detail.
Given a version number MAJOR.MINOR.PATCH, increment the:
- MAJOR version when you make incompatible API changes.
- MINOR version when you add functionality in a backward-compatible manner.
- PATCH version when you make backward-compatible bug fixes.
Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
Have a bug or a feature request? Looking to contribute to advance the project? Read our contribution guide or maintenance guide first in order to understand how we do things around here. Or you could look at some of our other guides below:
How do I… (click to expand)
Looking to talk to someone or need some help? Please read our support guidelines.
©2020 GNU General Public License v3. See LICENSE for specifics.