scratch-semantic-release-config

Remixed from: @jedmao/semantic-release-npm-github-config

Plugins

This shareable configuration uses the following plugins:

• @semantic-release/commit-analyzer
• @semantic-release/release-notes-generator
• @semantic-release/npm
• @semantic-release/github
• @semantic-release/git

Summary

• Provides 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").
• Creates a tarball that gets uploaded with each GitHub release.
• Publishes the same tarball to npm.
• Commits the version change in package.json.
• Creates or updates a changelog file.

Install

1npm install --save-dev semantic-release scratch-semantic-release-config

Usage

The shareable config can be configured in the semantic-release configuration file:

1{
2  "extends": "scratch-semantic-release-config",
3  "branch": "main"
4}

Configuration

Ensure that your CI configuration has the following secret environment variables set:

• GH_TOKEN with public_repo access.
• NPM_TOKEN
• NODE_AUTH_TOKEN

See each plugin documentation for required installation and configuration steps.

GitHub workflows

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 main.

1name: Node CI
2
3on:
4  push:
5    branches:
6      - main
7
8jobs:
9  test:
10    name: Test on node ${{ matrix.node }} and ${{ matrix.os }}
11
12    runs-on: ${{ matrix.os }}
13
14    strategy:
15      matrix:
16        node: [8, 10, 12]
17        os:
18          - ubuntu-latest
19          - windows-latest
20          - macOS-latest
21
22    steps:
23      - name: Preserve line endings
24        run: git config --global core.autocrlf false
25      - name: Checkout
26        uses: actions/checkout@v1
27      - name: Setup Node
28        uses: actions/setup-node@v1
29        with:
30          node-version: ${{ matrix.node }}
31      - name: Install & test/cover
32        run: npm ci && npm run cover
33        env:
34          CI: true
35
36  release:
37    name: npm publish / GitHub release
38    needs: test
39    runs-on: ubuntu-latest
40    steps:
41      - name: Checkout
42        uses: actions/checkout@v1
43      - name: Setup Node
44        uses: actions/setup-node@v1
45        with:
46          node-version: 12
47          registry-url: https://registry.npmjs.org/
48      - name: Install
49        env:
50          CI: true
51        run: npm ci
52      - name: Build
53        if: success()
54        run: npm run build
55      - name: Semantic Release
56        if: success()
57        env:
58          GH_TOKEN: ${{ secrets.GH_TOKEN }}
59          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
60          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
61        run: npx semantic-release