Release Process #162
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: Release Process | |
| on: | |
| workflow_dispatch: | |
| inputs: | |
| mode: | |
| description: What type of release | |
| required: true | |
| default: rc | |
| type: choice | |
| options: | |
| - rc | |
| - final | |
| docs: | |
| description: Publish docs | |
| required: true | |
| type: boolean | |
| default: true | |
| npm: | |
| description: Publish to npm | |
| required: true | |
| type: boolean | |
| default: true | |
| concurrency: ${{ github.workflow }} | |
| permissions: {} # No permissions required | |
| jobs: | |
| release: | |
| uses: matrix-org/matrix-js-sdk/.github/workflows/release-make.yml@develop | |
| permissions: | |
| contents: write | |
| issues: write | |
| pull-requests: read | |
| secrets: inherit | |
| with: | |
| final: ${{ inputs.mode == 'final' }} | |
| npm: ${{ inputs.npm }} | |
| bump-downstreams: | |
| name: Update npm dependency in downstream projects | |
| needs: release | |
| runs-on: ubuntu-24.04 | |
| strategy: | |
| matrix: | |
| repo: | |
| - element-hq/element-web | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| repository: ${{ matrix.repo }} | |
| ref: staging | |
| token: ${{ secrets.ELEMENT_BOT_TOKEN }} | |
| - uses: actions/setup-node@v4 | |
| with: | |
| cache: "yarn" | |
| node-version: "lts/*" | |
| - name: Bump dependency | |
| env: | |
| DEPENDENCY: ${{ needs.release.outputs.npm-id }} | |
| run: | | |
| git config --global user.email "releases@riot.im" | |
| git config --global user.name "RiotRobot" | |
| yarn upgrade "$DEPENDENCY" --exact | |
| git add package.json yarn.lock | |
| git commit -am"Upgrade dependency to $DEPENDENCY" | |
| git push origin staging | |
| docs: | |
| name: Publish Documentation | |
| needs: release | |
| if: inputs.docs | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - name: 🧮 Checkout code | |
| uses: actions/checkout@v4 | |
| - name: 🔧 Yarn cache | |
| uses: actions/setup-node@v4 | |
| with: | |
| cache: "yarn" | |
| node-version-file: package.json | |
| - name: 🔨 Install dependencies | |
| run: "yarn install --frozen-lockfile" | |
| - name: 📖 Generate docs | |
| run: yarn gendoc | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: _docs | |
| docs-deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-24.04 | |
| needs: docs | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |