diff --git a/.github/workflows/test-and-release.yml b/.github/workflows/test-and-release.yml index f70ea0e..97eddf0 100644 --- a/.github/workflows/test-and-release.yml +++ b/.github/workflows/test-and-release.yml @@ -1,92 +1,130 @@ -name: Test and Release - -# Run this job on all pushes and pull requests -# as well as tags with a semantic version -on: - push: - branches: - - "main" - 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: '20.x' - # Uncomment the following line if your adapter cannot be installed using 'npm ci' - # install-command: 'npm install' - lint: true - - # Runs adapter tests on all supported node versions and OSes - adapter-tests: - if: contains(github.event.head_commit.message, '[skip ci]') == false - - runs-on: ${{ matrix.os }} - strategy: - matrix: - node-version: [18.x, 20.x, 22.x] - os: [ubuntu-latest, windows-latest, macos-latest] - - 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 -# deploy: -# needs: [check-and-lint, adapter-tests] -# -# # Trigger this step only when a commit on any branch 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') -# -# runs-on: ubuntu-latest -# -# # Write permissions are required to create Github releases -# permissions: -# contents: write -# -# steps: -# - uses: ioBroker/testing-action-deploy@v1 -# with: -# node-version: '20.x' -# # Uncomment the following line if your adapter cannot be installed using 'npm ci' -# # install-command: 'npm install' -# npm-token: ${{ secrets.NPM_TOKEN }} -# github-token: ${{ secrets.GITHUB_TOKEN }} -# -# # When using Sentry for error reporting, Sentry can be informed about new releases -# # To enable create a API-Token in Sentry (User settings, API keys) -# # Enter this token as a GitHub secret (with name SENTRY_AUTH_TOKEN) in the repository options -# # Then uncomment and customize the following block: -# sentry: true -# sentry-token: ${{ secrets.SENTRY_AUTH_TOKEN }} -# sentry-project: "iobroker-jsontemplate" -# sentry-version-prefix: "iobroker.jsontemplate" -# # If your sentry project is linked to a GitHub repository, you can enable the following option -# # sentry-github-integration: true +# This is a composition of lint and test scripts +# Make sure to update this file along with the others + +name: Test and Release + +# Run this job on all pushes and pull requests +# as well as tags with a semantic version +on: + push: + branches: + - '*' + 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: + # Runs adapter tests on all supported node versions and OSes + adapter-tests: + if: contains(github.event.head_commit.message, '[skip ci]') == false + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - name: Use Node.js 20.x + uses: actions/setup-node@v4 + with: + node-version: 20.x + + - name: Install Dependencies + run: npm i + + - name: Build + run: NODE_OPTIONS=--max_old_space_size=4096 npm run build + + - name: Run local tests + run: npm test + + - name: Archive screenshots + if: always() + # if: failure() + uses: actions/upload-artifact@v4 + with: + path: tmp/screenshots/**/*.png + retention-days: 3 + + # Deploys the final package to NPM + deploy: + needs: [adapter-tests] + + # 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/') + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Use Node.js 20.x + uses: actions/setup-node@v4 + with: + node-version: 20.x + + - name: Install Dependencies + run: npm i + + - name: Extract the version and commit body from the tag + id: extract_release + # The body may be multiline, therefore we need to escape some characters + run: | + VERSION="${{ github.ref }}" + VERSION=${VERSION##*/v} + echo "VERSION=$VERSION" >> $GITHUB_OUTPUT + EOF=$(od -An -N6 -x /dev/urandom | tr -d ' ') + BODY=$(git show -s --format=%b) + echo "BODY<<$EOF" >> $GITHUB_OUTPUT + echo "$BODY" >> $GITHUB_OUTPUT + echo "$EOF" >> $GITHUB_OUTPUT + if [[ $VERSION == *"-"* ]] ; then + echo "TAG=--tag next" >> $GITHUB_OUTPUT + fi + + # - name: Create a clean build + # run: npm run build + - name: Publish package to npm + run: | + npm config set //registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }} + npm whoami + npm publish + + # - name: Create Github Release + # uses: softprops/action-gh-release@v1 + # env: + # GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + # with: + # tag_name: ${{ github.ref }} + # name: Release v${{ steps.extract_release.outputs.VERSION }} + # draft: false + # # Prerelease versions create pre-releases on GitHub + # prerelease: ${{ contains(steps.extract_release.outputs.VERSION, '-') }} + # body: ${{ steps.extract_release.outputs.BODY }} + + # - name: Notify Sentry.io about the release + # run: | + # npm i -g @sentry/cli + # export SENTRY_AUTH_TOKEN=${{ secrets.SENTRY_AUTH_TOKEN }} + # export SENTRY_URL=https://sentry.iobroker.net + # export SENTRY_ORG=iobroker + # export SENTRY_PROJECT=iobroker-admin + # export SENTRY_VERSION=iobroker.admin@${{ steps.extract_release.outputs.VERSION }} + # sentry-cli releases new $SENTRY_VERSION + # sentry-cli releases finalize $SENTRY_VERSION + + # Add the following line BEFORE finalize if repositories are connected in Sentry + # sentry-cli releases set-commits $SENTRY_VERSION --auto + + # Add the following line BEFORE finalize if sourcemap uploads are needed + # sentry-cli releases files $SENTRY_VERSION upload-sourcemaps build/ \ No newline at end of file