Optimize Svelte docgen to only run on components referenced in stories with comprehensive dev mode support #2333
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: Publish canary release of PR | |
| run-name: "Canary release: PR #${{ github.event_name == 'workflow_dispatch' && inputs.pr || github.event.pull_request.number }}, triggered by ${{ github.triggering_actor }}" | |
| on: | |
| workflow_dispatch: | |
| inputs: | |
| pr: | |
| description: 'Pull request number to create a canary release for' | |
| required: true | |
| type: number | |
| pull_request: | |
| types: [opened, synchronize, reopened] | |
| env: | |
| PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: 1 | |
| PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: 1 | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event_name == 'workflow_dispatch' && inputs.pr || github.event.pull_request.number }} | |
| cancel-in-progress: true | |
| permissions: | |
| pull-requests: write | |
| jobs: | |
| release-canary: | |
| name: Release canary version | |
| runs-on: ubuntu-latest | |
| environment: release | |
| if: github.event_name == 'workflow_dispatch' || endsWith(github.head_ref, 'with-canary-release') | |
| steps: | |
| - name: Fail if triggering actor is not administrator | |
| uses: prince-chrismc/[email protected] | |
| with: | |
| permission: admin | |
| - name: Get pull request information | |
| id: info | |
| env: | |
| GH_TOKEN: ${{ secrets.GH_TOKEN }} | |
| run: | | |
| PR_NUMBER=${{ github.event_name == 'workflow_dispatch' && inputs.pr || github.event.pull_request.number }} | |
| PR_INFO=$(gh pr view $PR_NUMBER --repo ${{ github.repository }} --json isCrossRepository,headRefOid,headRefName,headRepository,headRepositoryOwner --jq '{isFork: .isCrossRepository, owner: .headRepositoryOwner.login, repoName: .headRepository.name, branch: .headRefName, sha: .headRefOid}') | |
| echo $PR_INFO | |
| # Loop through each key-value pair in PR_INFO and set as step output | |
| for key in $(echo "$PR_INFO" | jq -r 'keys[]'); do | |
| value=$(echo "$PR_INFO" | jq -r ".$key") | |
| echo "$key=$value" >> "$GITHUB_OUTPUT" | |
| done | |
| echo "repository=$(echo "$PR_INFO" | jq -r ".owner")/$(echo "$PR_INFO" | jq -r ".repoName")" >> $GITHUB_OUTPUT | |
| echo "shortSha=$(echo "$PR_INFO" | jq -r ".sha" | cut -c 1-8)" >> $GITHUB_OUTPUT | |
| echo "date=$(date)" >> $GITHUB_OUTPUT | |
| echo "timestamp=$(date +%s)" >> $GITHUB_OUTPUT | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: ${{ steps.info.outputs.isFork == 'true' && steps.info.outputs.repository || null }} | |
| ref: ${{ steps.info.outputs.sha }} | |
| token: ${{ secrets.GH_TOKEN }} | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version-file: '.nvmrc' | |
| - name: Cache dependencies | |
| uses: actions/cache@v4 | |
| with: | |
| path: | | |
| ~/.yarn/berry/cache | |
| key: yarn-v1-${{ hashFiles('scripts/yarn.lock') }}-${{ hashFiles('code/yarn.lock') }} | |
| restore-keys: | | |
| yarn-v1-${{ hashFiles('scripts/yarn.lock') }}-${{ hashFiles('code/yarn.lock') }} | |
| yarn-v1-${{ hashFiles('scripts/yarn.lock') }} | |
| yarn-v1 | |
| - name: Install dependencies | |
| run: yarn task --task=install --start-from=install | |
| - name: Set version | |
| id: version | |
| working-directory: scripts | |
| run: | | |
| PR_NUMBER=${{ github.event_name == 'workflow_dispatch' && inputs.pr || github.event.pull_request.number }} | |
| yarn release:version --exact 0.0.0-pr-$PR_NUMBER-sha-${{ steps.info.outputs.shortSha }} --verbose | |
| - name: Publish v${{ steps.version.outputs.next-version }} | |
| env: | |
| YARN_NPM_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} | |
| working-directory: scripts | |
| run: yarn release:publish --tag canary --verbose | |
| - name: Replace Pull Request Body | |
| # TODO: replace with ivangabriele/find-and-replace-pull-request-body@vX when https://github.com/ivangabriele/find-and-replace-pull-request-body/pull/11 has been released | |
| uses: mcky/[email protected] | |
| with: | |
| githubToken: ${{ secrets.GH_TOKEN }} | |
| prNumber: ${{ github.event_name == 'workflow_dispatch' && inputs.pr || '' }} | |
| find: 'CANARY_RELEASE_SECTION' | |
| isHtmlCommentTag: true | |
| replace: | | |
| This pull request has been released as version `${{ steps.version.outputs.next-version }}`. Try it out in a new sandbox by running `npx storybook@${{ steps.version.outputs.next-version }} sandbox` or in an existing project with `npx storybook@${{ steps.version.outputs.next-version }} upgrade`. | |
| <details> | |
| <summary>More information</summary> | |
| | | | | |
| | --- | --- | | |
| | **Published version** | [`${{ steps.version.outputs.next-version }}`](https://npmjs.com/package/storybook/v/${{ steps.version.outputs.next-version }}) | | |
| | **Triggered by** | @${{ github.triggering_actor }} | | |
| | **Repository** | [${{ steps.info.outputs.repository }}](https://github.com/${{ steps.info.outputs.repository }}) | | |
| | **Branch** | [`${{ steps.info.outputs.branch }}`](https://github.com/${{ steps.info.outputs.repository }}/tree/${{ steps.info.outputs.branch }}) | | |
| | **Commit** | [`${{ steps.info.outputs.shortSha }}`](https://github.com/${{ steps.info.outputs.repository }}/commit/${{ steps.info.outputs.sha }}) | | |
| | **Datetime** | ${{ steps.info.outputs.date }} (`${{ steps.info.outputs.timestamp }}`) | | |
| | **Workflow run** | [${{ github.run_id }}](https://github.com/storybookjs/storybook/actions/runs/${{ github.run_id }}) | | |
| To request a new release of this pull request, mention the `@storybookjs/core` team. | |
| _core team members can create a new canary release [here](https://github.com/storybookjs/storybook/actions/workflows/canary-release-pr.yml) or locally with `gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=${{ github.event_name == 'workflow_dispatch' && inputs.pr || github.event.pull_request.number }}`_ | |
| </details> | |
| - name: Create failing comment on PR | |
| if: failure() | |
| env: | |
| GH_TOKEN: ${{ secrets.GH_TOKEN }} | |
| run: | | |
| PR_NUMBER=${{ github.event_name == 'workflow_dispatch' && inputs.pr || github.event.pull_request.number }} | |
| gh pr comment $PR_NUMBER\ | |
| --repo "${{github.repository }}"\ | |
| --body "Failed to publish canary version of this pull request, triggered by @${{ github.triggering_actor }}. See the failed workflow run at: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" |