Update README.md #1247
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Test and Release | |
# Run this job on all pushes and pull requests | |
# as well as tags with a semantic version | |
on: | |
push: | |
branches: | |
- master | |
tags: | |
# normal versions | |
- "v[0-9]+.[0-9]+.[0-9]+" | |
# pre-releases | |
- "v[0-9]+.[0-9]+.[0-9]+-**" | |
pull_request: {} | |
# Cancel previous PR/branch runs when a new commit is pushed | |
concurrency: | |
group: ${{ github.ref }} | |
cancel-in-progress: true | |
jobs: | |
# Performs quick checks before the expensive test runs | |
check-and-lint: | |
if: contains(github.event.head_commit.message, '[skip ci]') == false | |
runs-on: ubuntu-latest | |
steps: | |
- uses: ioBroker/testing-action-check@v1 | |
with: | |
node-version: "16.x" | |
# Uncomment the following line if your adapter cannot be installed using 'npm ci' | |
# install-command: 'npm install' | |
lint: true | |
adapter-tests: | |
if: contains(github.event.head_commit.message, '[skip ci]') == false | |
runs-on: ${{ matrix.os }} | |
strategy: | |
matrix: | |
node-version: [16.x, 18.x, 20.x] | |
os: [ubuntu-latest, windows-latest, macos-latest] | |
# Uncomment the following line if your adapter cannot be installed using 'npm ci' | |
# install-command: 'npm install' | |
steps: | |
- uses: ioBroker/testing-action-adapter@v1 | |
with: | |
node-version: ${{ matrix.node-version }} | |
os: ${{ matrix.os }} | |
# Uncomment the following line if your adapter cannot be installed using 'npm ci' | |
# install-command: 'npm install' | |
# TODO: To enable automatic npm releases, create a token on npmjs.org | |
# Enter this token as a GitHub secret (with name NPM_TOKEN) in the repository options | |
# Then uncomment the following block: | |
# Deploys the final package to NPM | |
# Deploys the final package to NPM and Github Actions | |
deploy: | |
# Trigger this step only when a commit on master is tagged with a version number | |
if: | | |
contains(github.event.head_commit.message, '[skip ci]') == false && | |
github.event_name == 'push' && | |
startsWith(github.ref, 'refs/tags/v') | |
# Define which jobst must succeed before the release | |
needs: [adapter-tests] | |
runs-on: ubuntu-latest | |
strategy: | |
matrix: | |
node-version: [16.x] | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v3 | |
- name: Use Node.js ${{ matrix.node-version }} | |
uses: actions/setup-node@v3 | |
with: | |
node-version: ${{ matrix.node-version }} | |
- name: Extract the version and commit body from the tag | |
id: extract_release | |
# The body may be multiline, therefore newlines and % need to be escaped | |
run: | | |
VERSION="${{ github.ref }}" | |
VERSION=${VERSION##*/v} | |
echo "::set-output name=VERSION::$VERSION" | |
BODY=$(git show -s --format=%b) | |
BODY="${BODY//'%'/'%25'}" | |
BODY="${BODY//$'\n'/'%0A'}" | |
BODY="${BODY//$'\r'/'%0D'}" | |
echo "::set-output name=BODY::$BODY" | |
# If you like, activate automated version publish to NPM | |
# Only if commit contains a version, see : https://github.com/AlCalzone/release-script | |
- name: Publish package to npm | |
run: | | |
npm config set //registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }} | |
npm whoami | |
npm publish | |
# b) For monorepos managed with lerna (requires lerna to be installed globally) | |
#- name: Publish packages to npm | |
# run: | | |
# npm config set //registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }} | |
# npm whoami | |
# lerna publish from-package --yes | |
# c) For monorepos managed with yarn v3.1+ (no lerna) | |
#- name: Publish packages to npm | |
# run: | | |
# yarn config set npmAuthToken "${{ secrets.NPM_TOKEN }}" | |
# yarn npm whoami | |
# yarn workspaces foreach -vti --no-private npm publish --tolerate-republish | |
- name: Create Github Release | |
uses: actions/create-release@v1 | |
env: | |
GITHUB_TOKEN: ${{ secrets.ACCESS_TOKEN }} | |
with: | |
tag_name: ${{ github.ref }} | |
release_name: Release v${{ steps.extract_release.outputs.VERSION }} | |
draft: false | |
# Prerelease versions create prereleases on Github | |
prerelease: ${{ contains(steps.extract_release.outputs.VERSION, '-') }} | |
body: ${{ steps.extract_release.outputs.BODY }} |