Improve extension release workflow #1
Workflow file for this run
This file contains hidden or 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 VS Code extension | |
| on: | |
| push: | |
| tags: | |
| - vscode-ruby-lsp-v[0-9]+.[0-9]+.[0-9]+ | |
| - vscode-ruby-lsp-v[0-9]+.[0-9]+.[0-9]+-preview | |
| jobs: | |
| release_extension: | |
| if: github.repository == 'Shopify/ruby-lsp' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | |
| name: Checkout | |
| - uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0 | |
| name: Use Node.js | |
| env: | |
| DISABLE_V8_COMPILE_CACHE: "1" | |
| with: | |
| node-version: "22.21" | |
| cache: "yarn" | |
| cache-dependency-path: "vscode" | |
| - name: Create CHANGELOG.md | |
| uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0 | |
| with: | |
| github-token: "${{ secrets.GITHUB_TOKEN }}" | |
| script: | | |
| const fs = require("fs"); | |
| const { data: releases } = await github.rest.repos.listReleases({ | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| }); | |
| const includePrereleases = context.payload.release.prerelease; | |
| const changelog = releases | |
| .filter((release) => release.tag_name.startsWith("vscode-ruby-lsp") && (includePrereleases || !release.prerelease)) | |
| .map((release) => `${release.body}\n`) | |
| .join("\n"); | |
| fs.writeFileSync("vscode/CHANGELOG.md", changelog); | |
| - name: Copy files needed for release | |
| run: | | |
| cp CODE_OF_CONDUCT.md vscode/CODE_OF_CONDUCT.md | |
| - name: 📦 Install dependencies | |
| working-directory: ./vscode | |
| run: yarn --frozen-lockfile | |
| # Stable releases | |
| - name: Publish extension in the marketplace | |
| if: ${{ !endsWith(github.ref_name, '-preview') }} | |
| working-directory: ./vscode | |
| run: | | |
| yarn run package | |
| node_modules/.bin/vsce publish --packagePath vscode-ruby-lsp.vsix | |
| env: | |
| VSCE_PAT: ${{ secrets.VSCE_PAT }} | |
| # Prereleases | |
| - name: Package and publish prerelease extension in the marketplace | |
| if: ${{ endsWith(github.ref_name, '-preview') }} | |
| working-directory: ./vscode | |
| run: | | |
| yarn run package_prerelease | |
| node_modules/.bin/vsce publish --pre-release --packagePath vscode-ruby-lsp.vsix | |
| env: | |
| VSCE_PAT: ${{ secrets.VSCE_PAT }} | |
| # Stable releases for OpenVSX | |
| - name: Publish extension on OpenVSX | |
| if: ${{ !endsWith(github.ref_name, '-preview') }} | |
| working-directory: ./vscode | |
| run: | | |
| yarn run package | |
| node_modules/.bin/ovsx publish vscode-ruby-lsp.vsix -p ${{ secrets.OPENVSX_TOKEN }} --yarn | |
| release_github: | |
| name: Create GitHub release | |
| if: github.repository == 'Shopify/ruby-lsp' | |
| needs: release_extension | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Create GitHub release | |
| uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0 | |
| with: | |
| github-token: "${{ secrets.GITHUB_TOKEN }}" | |
| script: | | |
| const { data } = await github.rest.repos.listReleases({ | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| }); | |
| const previousRelease = data.find((release) => release.tag_name.startsWith("vscode-ruby-lsp") && release.tag_name !== "${{ github.ref_name }}"); | |
| const commitResponse = await github.rest.repos.compareCommits({ | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| base: previousRelease.tag_name, | |
| head: "${{ github.ref_name }}" | |
| }); | |
| console.log(`Found ${commitResponse.data.commits.length} commits`); | |
| const pullRequests = []; | |
| for (const commit of commitResponse.data.commits) { | |
| const pullsResponse = await github.request(`GET /repos/shopify/ruby-lsp/commits/${commit.sha}/pulls`); | |
| pullsResponse.data.forEach((pr) => { | |
| if (!pullRequests.some((pull) => pull.url === pr.html_url)) { | |
| pullRequests.push({ | |
| title: pr.title, | |
| url: pr.html_url, | |
| labels: pr.labels.map((label) => label.name), | |
| author: pr.user.login | |
| }); | |
| } | |
| }); | |
| } | |
| console.log(`Found ${pullRequests.length} pull requests`); | |
| const relevantPulls = pullRequests.filter((pull) => { | |
| return pull.labels.some((label) => label === "vscode") && | |
| !pull.labels.some((label) => label === "dependencies") && | |
| !pull.labels.some((label) => label === "chore") | |
| }); | |
| const breakingChanges = relevantPulls.filter((pull) => pull.labels.some((label) => label === "breaking-change")); | |
| const bugFixes = relevantPulls.filter((pull) => pull.labels.some((label) => label === "bugfix")); | |
| const enhancements = relevantPulls.filter((pull) => pull.labels.some((label) => label === "enhancement")); | |
| const otherChanges = relevantPulls.filter((pull) => !pull.labels.some((label) => ["bugfix", "enhancement", "breaking-change"].includes(label))); | |
| let content = `# ${{ github.ref_name }}\n`; | |
| if (breakingChanges.length > 0) { | |
| content += `## 🚧 Breaking Changes\n\n${breakingChanges.map((pull) => `- ${pull.title} (${pull.url}) by @${pull.author}`).join("\n")}\n\n`; | |
| } | |
| if (enhancements.length > 0) { | |
| content += `## ✨ Enhancements\n\n${enhancements.map((pull) => `- ${pull.title} (${pull.url}) by @${pull.author}`).join("\n")}\n\n`; | |
| } | |
| if (bugFixes.length > 0) { | |
| content += `## 🐛 Bug Fixes\n\n${bugFixes.map((pull) => `- ${pull.title} (${pull.url}) by @${pull.author}`).join("\n")}\n\n`; | |
| } | |
| if (otherChanges.length > 0) { | |
| content += `## 📦 Other Changes\n\n${otherChanges.map((pull) => `- ${pull.title} (${pull.url}) by @${pull.author}`).join("\n")}\n\n`; | |
| } | |
| await github.rest.repos.createRelease({ | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| tag_name: "${{ github.ref }}", | |
| name: "${{ github.ref_name }}", | |
| body: content, | |
| prerelease: "${{ github.ref_name }}".endsWith("-preview") | |
| }); |