Official release #23
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: Official release | |
| on: | |
| workflow_dispatch: # Manually on demand | |
| inputs: | |
| versionBump: | |
| description: 'Type of version bump' | |
| required: true | |
| default: 'patch' | |
| type: choice | |
| options: | |
| - patch | |
| - minor | |
| - major | |
| jobs: | |
| publish-config: | |
| runs-on: ubuntu-20.04 | |
| strategy: | |
| matrix: | |
| node: [18.x] # This should be LTS | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 # Fetch the history, or this action won't work | |
| - name: Use Node.js ${{ matrix.node }} | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: ${{ matrix.node }} | |
| - name: Prepare installation | |
| uses: ./.github/actions/install-redis-linux | |
| - name: Install dependencies | |
| run: npm ci --ignore-scripts # install typescript and @types do not `setup first` | |
| - name: Build TS files | |
| run: npm run build | |
| - name: Build Docs | |
| run: npm run build:doc | |
| - name: Run scripts | |
| run: npm run preinstall && npm run install | |
| - name: Test | |
| run: npm test | |
| - name: Determine the version bump | |
| id: version | |
| uses: actions/github-script@v7 | |
| env: | |
| VERSION_BUMP: ${{ inputs.versionBump }} | |
| with: | |
| result-encoding: string | |
| script: | | |
| const semver = require('semver'); | |
| const prevVersion = require(`${process.env.GITHUB_WORKSPACE}/lerna.json`).version; | |
| const parsed = semver.parse(prevVersion); | |
| // Figure out the next version | |
| const version = `${semver.inc(parsed, process.env.VERSION_BUMP)}`; | |
| return version; | |
| - name: Prepare io-package.json | |
| env: | |
| VERSION: ${{ steps.version.outputs.result }} | |
| uses: actions/github-script@v7 | |
| with: | |
| script: | | |
| const semver = require('semver'); | |
| const fs = require('fs-extra'); | |
| const MAX_NEWS = 20; | |
| const path = `${process.env.GITHUB_WORKSPACE}/packages/controller/io-package.json`; | |
| const ioPack = require(path); | |
| let news = ioPack.common.news; | |
| const prevNewsVersion = Object.keys(news)[0]; | |
| // add new news as first entry | |
| news = { [process.env.VERSION]: Object.values(news)[0], ...news }; | |
| const isPatch = semver.satisfies(process.env.VERSION, `~${prevNewsVersion}`); | |
| if (isPatch) { | |
| delete news[prevNewsVersion]; | |
| } | |
| // if too much news, remove them | |
| while (Object.keys(news).length > MAX_NEWS) { | |
| const newsVersions = Object.keys(news); | |
| delete news[newsVersions[newsVersions.length - 1]]; | |
| } | |
| ioPack.common.news = news; | |
| ioPack.common.version = process.env.VERSION; | |
| fs.writeFileSync(path, JSON.stringify(ioPack, null, 2)); | |
| - name: Prepare changelog | |
| env: | |
| VERSION: ${{ steps.version.outputs.result }} | |
| uses: actions/github-script@v7 | |
| with: | |
| script: | | |
| const fs = require('fs-extra'); | |
| const WIP_MARKER = '__WORK IN PROGRESS__'; | |
| const TEMP_PLACEHOLDER = '**TEMP_PLACEHOLDER_GH_ACTION**'; | |
| const changelog = fs | |
| .readFileSync(`${process.env.GITHUB_WORKSPACE}/CHANGELOG.md`, { encoding: 'utf-8' }) | |
| .replace(WIP_MARKER, TEMP_PLACEHOLDER); | |
| if (!changelog.includes(WIP_MARKER)) { | |
| throw new Error(`${WIP_MARKER} is missing in changelog`); | |
| } | |
| const dateStr = new Date().toISOString().split('T')[0]; | |
| const versionDateStr = `${process.env.VERSION} (${dateStr})`; | |
| fs.writeFileSync( | |
| `${process.env.GITHUB_WORKSPACE}/CHANGELOG.md`, | |
| changelog.replace(WIP_MARKER, versionDateStr).replace(TEMP_PLACEHOLDER, WIP_MARKER), | |
| { | |
| encoding: 'utf-8' | |
| } | |
| ); | |
| - name: Bump version locally | |
| env: | |
| VERSION: ${{ steps.version.outputs.result }} | |
| run: | | |
| git config --global user.email "[email protected]" | |
| git config --global user.name "Github Action" | |
| git add . | |
| git commit -m "v${VERSION}" && npx lerna version ${VERSION} --no-push --exact --ignore-scripts --no-commit-hooks --yes --amend --force-publish || npx lerna version ${VERSION} --exact --no-push --ignore-scripts --no-commit-hooks --yes --force-publish | |
| - name: Create Pull Request | |
| id: cpr | |
| uses: peter-evans/create-pull-request@v6 | |
| with: | |
| token: ${{ secrets.PR_TOKEN }} | |
| commit-message: "[OFFICIAL RELEASE] ${{ steps.version.outputs.result }}" | |
| committer: foxriver76 <[email protected]> | |
| author: foxriver76 <[email protected]> | |
| signoff: false | |
| branch: official-release | |
| delete-branch: true | |
| title: "[OFFICIAL RELEASE] ${{ steps.version.outputs.result }}" | |
| body: | | |
| Update version by release action | |
| labels: | | |
| automated pr | |
| assignees: foxriver76 | |
| draft: false |