From fa5bb3b94c01dbc5fc22f1a932b91be280f450d1 Mon Sep 17 00:00:00 2001 From: Jonathan Hui Date: Thu, 21 May 2026 13:16:45 -0700 Subject: [PATCH] [github-actions] add monthly CalVer release workflow (#13125) This commit introduces a new GitHub Actions workflow to automate the monthly release process using Calendar Versioning (CalVer). The workflow: - Runs automatically at 00:00 UTC on the 1st day of every month. - Supports manual execution via `workflow_dispatch`. - Automatically generates a CalVer tag (e.g., vYYYY.MM.0). - Employs the GitHub CLI to create a release and auto-generate release notes based on merged pull requests. --- .github/release.yml | 49 +++++++++++++++ .github/workflows/monthly-release.yml | 89 +++++++++++++++++++++++++++ 2 files changed, 138 insertions(+) create mode 100644 .github/release.yml create mode 100644 .github/workflows/monthly-release.yml diff --git a/.github/release.yml b/.github/release.yml new file mode 100644 index 000000000..4791e9873 --- /dev/null +++ b/.github/release.yml @@ -0,0 +1,49 @@ +# +# Copyright (c) 2026, The OpenThread Authors. +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# 1. Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# 2. Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# 3. Neither the name of the copyright holder nor the +# names of its contributors may be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +# POSSIBILITY OF SUCH DAMAGE. +# + +changelog: + exclude: + labels: + - duplicate + - question + - invalid + - wontfix + authors: + - dependabot[bot] + categories: + - title: "🚀 Features" + labels: + - feature + - enhancement + - title: "🐛 Bug Fixes" + labels: + - bug + - fix + - title: "📖 Documentation" + labels: + - documentation diff --git a/.github/workflows/monthly-release.yml b/.github/workflows/monthly-release.yml new file mode 100644 index 000000000..bc99a711d --- /dev/null +++ b/.github/workflows/monthly-release.yml @@ -0,0 +1,89 @@ +# +# Copyright (c) 2026, The OpenThread Authors. +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# 1. Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# 2. Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# 3. Neither the name of the copyright holder nor the +# names of its contributors may be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +# POSSIBILITY OF SUCH DAMAGE. +# + +name: Monthly CalVer Release + +on: + schedule: + # Runs at 00:00 UTC on the 1st day of every month + - cron: '0 0 1 * *' + + # Allows you to trigger the workflow manually from the GitHub Actions UI + workflow_dispatch: + inputs: + tag_override: + description: 'Custom Tag Name (e.g., v2026.05.1). Leave blank for auto CalVer.' + required: false + type: string + +jobs: + create-release: + name: Create Monthly Release + runs-on: ubuntu-24.04 + + # Required permission to create tags and releases + permissions: + contents: write + + steps: + - name: Harden Runner + uses: step-security/harden-runner@5ef0c079ce82195b2a36a210272d6b661572d83e # v2.14.2 + with: + egress-policy: block + allowed-endpoints: > + api.github.com:443 + github.com:443 + + - name: Checkout repository + uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 + with: + persist-credentials: false + + - name: Generate CalVer Tag Name + id: generate_tag + env: + TAG_OVERRIDE: ${{ inputs.tag_override }} + # Formats the date as vYYYY.MM.0 (e.g., v2026.06.0) or uses override if provided + run: | + if [ -n "$TAG_OVERRIDE" ]; then + CALVER_TAG="$TAG_OVERRIDE" + else + CALVER_TAG="v$(date +'%Y.%m').0" + fi + echo "TAG_NAME=$CALVER_TAG" >> $GITHUB_ENV + echo "Generated tag: $CALVER_TAG" + + - name: Create GitHub Release + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + # Uses the built-in GitHub CLI to create the tag and release simultaneously + run: | + gh release create "$TAG_NAME" \ + --target "${{ github.ref_name }}" \ + --title "OpenThread $TAG_NAME" \ + --generate-notes