From f44190078118a04bdf6e2dad14c9334aa6cc2d2e Mon Sep 17 00:00:00 2001 From: Martin Schuhfuss Date: Fri, 16 Feb 2024 00:10:02 +0100 Subject: [PATCH] chore: replace semantic-release with release-please (#820) Co-authored-by: Angela Yu <5506675+wangela@users.noreply.github.com> --- .github/workflows/dependabot.yml | 4 ++ .github/workflows/docs.yml | 35 +++++++------ .github/workflows/release-please.yml | 75 ++++++++++++++++++++++++++++ .github/workflows/release.yml | 60 ---------------------- .github/workflows/test.yml | 34 ++++++++----- 5 files changed, 122 insertions(+), 86 deletions(-) create mode 100644 .github/workflows/release-please.yml delete mode 100644 .github/workflows/release.yml diff --git a/.github/workflows/dependabot.yml b/.github/workflows/dependabot.yml index 6b46ebbb..79d39944 100644 --- a/.github/workflows/dependabot.yml +++ b/.github/workflows/dependabot.yml @@ -19,7 +19,11 @@ permissions: contents: write jobs: + test: + uses: ./.github/workflows/test.yml + dependabot: + needs: test runs-on: ubuntu-latest if: ${{ github.actor == 'dependabot[bot]' }} env: diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index eab6d5cd..662befb7 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -15,24 +15,31 @@ name: Docs on: [push, pull_request] jobs: - test: + docs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 - - uses: actions/cache@v3 + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup Node + uses: actions/setup-node@v3 with: - path: ~/.npm - key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} - restore-keys: | - ${{ runner.os }}-node- - - run: | - npm i - npm run docs - - uses: peaceiris/actions-gh-pages@v3 - if: github.ref == 'refs/heads/main' + node-version: 20 + cache: npm + + - name: Install Dependencies + run: npm ci + + - name: Build Documentation + run: npm run docs + + - if: github.ref == 'refs/heads/main' + name: Publish to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./docs - user_name: 'googlemaps-bot' - user_email: 'googlemaps-bot@users.noreply.github.com' + user_name: "googlemaps-bot" + user_email: "googlemaps-bot@users.noreply.github.com" commit_message: ${{ github.event.head_commit.message }} diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml new file mode 100644 index 00000000..48019059 --- /dev/null +++ b/.github/workflows/release-please.yml @@ -0,0 +1,75 @@ +# Copyright 2021 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +## Runs the release-please action for all new pushes to the main branch. +## This will create new release-PRs, create GitHub releases and update +## the CHANGELOG.md. + +on: + push: + branches: [main] + +permissions: + contents: write + pull-requests: write + +name: Release Please + +jobs: + release-please: + runs-on: ubuntu-latest + steps: + - id: release + name: Release Please + uses: google-github-actions/release-please-action@v3 + + with: + release-type: node + token: ${{ secrets.SYNCED_GITHUB_TOKEN_REPO }} + package-name: "@googlemaps/markerclusterer" + bump-minor-pre-major: true + + # Everything below is for NPM publishing when a release is cut. + # Note the "if" statement on all commands to make sure that publishing + # only happens when a release is cut. + + - if: ${{ steps.release.outputs.release_created }} + name: Checkout + uses: actions/checkout@v3 + + - if: ${{ steps.release.outputs.release_created }} + name: Setup Node for Dependency Installation + uses: actions/setup-node@v3 + with: + node-version: 20 + cache: npm + + - if: ${{ steps.release.outputs.release_created }} + name: Install Dependencies + run: npm ci + + # Now configure node with the registry used for publishing + - if: ${{ steps.release.outputs.release_created }} + name: Setup Node for Publishing + uses: actions/setup-node@v3 + with: + node-version: 20 + registry-url: "https://wombat-dressing-room.appspot.com/" + + - if: ${{ steps.release.outputs.release_created }} + name: Publish + # npm publish will trigger the build via the prepack hook + run: npm publish + env: + NODE_AUTH_TOKEN: ${{ secrets.NPM_WOMBAT_TOKEN }} diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index c315d930..00000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,60 +0,0 @@ -# Copyright 2021 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -name: Release -on: - push: - branches: - - main - - beta -concurrency: release -jobs: - build: - runs-on: ubuntu-latest - steps: - - uses: actions/setup-node@v3 - with: - node-version: '16' - - name: Checkout - uses: actions/checkout@v3 - with: - token: ${{ secrets.SYNCED_GITHUB_TOKEN_REPO }} - - uses: actions/cache@v3 - with: - path: ~/.npm - key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} - restore-keys: | - ${{ runner.os }}-node- - - name: Test - run: | - npm i - npm run lint - npm test - - name: Release - uses: cycjimmy/semantic-release-action@v3 - with: - semantic_version: 19 - extra_plugins: | - @semantic-release/commit-analyzer@^9 - semantic-release-interval - @semantic-release/release-notes-generator@^10 - @semantic-release/git - @semantic-release/github@^8 - @semantic-release/npm@^9 - @googlemaps/semantic-release-config - semantic-release-npm-deprecate - env: - GH_TOKEN: ${{ secrets.SYNCED_GITHUB_TOKEN_REPO }} - NPM_TOKEN: ${{ secrets.NPM_WOMBAT_TOKEN }} - RUNNER_DEBUG: 1 diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index bd662b0d..1324e199 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -13,19 +13,29 @@ # limitations under the License. name: Test -on: [push, pull_request] +on: [push, pull_request, workflow_call] jobs: test: runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - uses: actions/cache@v3 + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup Node + uses: actions/setup-node@v3 with: - path: ~/.npm - key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} - restore-keys: | - ${{ runner.os }}-node- - - run: npm i - - run: npm run lint - - run: npm test - - uses: codecov/codecov-action@v1 + node-version: 20 + cache: npm + + - name: Install Dependencies + run: + npm ci + + - name: Run eslint + run: npm run lint + + - name: Run Tests + run: npm test + + - name: Collect Coverage Data + uses: codecov/codecov-action@v1