release(framework): add description sync #93
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
| # Generated by async-pipeline. Do not edit by hand. | |
| # Run: async-pipeline github generate | |
| name: Async Pipeline | |
| on: | |
| pull_request: | |
| push: | |
| branches: | |
| - "main" | |
| release: | |
| types: | |
| - "published" | |
| workflow_dispatch: | |
| inputs: | |
| job: | |
| description: "Pipeline job to run" | |
| required: true | |
| type: choice | |
| options: | |
| - "pages" | |
| - "publish" | |
| - "release-doctor" | |
| - "verify" | |
| permissions: | |
| contents: read | |
| jobs: | |
| publish: | |
| name: publish | |
| if: (github.event_name == 'workflow_dispatch' && github.event.inputs.job == 'publish') || (github.event_name == 'release' && (github.event.action == 'published')) | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: "npm-publish" | |
| url: "https://www.npmjs.com/package/@async/framework" | |
| permissions: | |
| contents: write | |
| id-token: write | |
| packages: write | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | |
| - name: Setup pnpm runtime | |
| uses: pnpm/setup@cf03a9b516e09bc5a90f041fc26fc930c9dc631b # v1.0.0 | |
| with: | |
| version: 11.1.0 | |
| runtime: node@24 | |
| install: false | |
| cache: true | |
| cache-dependency-path: "pnpm-lock.yaml" | |
| - name: Use current npm | |
| run: npm install -g npm@11.16.0 | |
| - name: Install dependencies | |
| run: pnpm install --frozen-lockfile | |
| - name: Write task cache manifest | |
| run: pnpm async-pipeline cache manifest --job publish --output .async/actions/cache/publish-cache-manifest.json --trust read-only | |
| - name: Restore Async task cache | |
| id: async-cache-restore | |
| uses: async/actions/cache@f81b4ae15d6a8c512a94bc3a2e866f807ad398a4 # v0.1.16 | |
| with: | |
| mode: restore | |
| manifest: .async/actions/cache/publish-cache-manifest.json | |
| trust: read-only | |
| - name: Plan release package | |
| uses: async/actions/doctor@f81b4ae15d6a8c512a94bc3a2e866f807ad398a4 # v0.1.16 | |
| with: | |
| mode: plan | |
| package-path: "./dist" | |
| evidence-dir: .async/release | |
| release-command: "npx --yes github:async/release#e8c938ae44f11558fbbac1c805e0ce81ad765080" | |
| env: | |
| CI: true | |
| - name: Inspect release package | |
| uses: async/actions/doctor@f81b4ae15d6a8c512a94bc3a2e866f807ad398a4 # v0.1.16 | |
| with: | |
| mode: inspect | |
| package-path: "./dist" | |
| evidence-dir: .async/release | |
| release-command: "npx --yes github:async/release#e8c938ae44f11558fbbac1c805e0ce81ad765080" | |
| env: | |
| CI: true | |
| - name: Check release changelog | |
| uses: async/actions/doctor@f81b4ae15d6a8c512a94bc3a2e866f807ad398a4 # v0.1.16 | |
| with: | |
| mode: changelog | |
| package-path: "./dist" | |
| evidence-dir: .async/release | |
| release-command: "npx --yes github:async/release#e8c938ae44f11558fbbac1c805e0ce81ad765080" | |
| env: | |
| CI: true | |
| - name: Render release notes | |
| uses: async/actions/doctor@f81b4ae15d6a8c512a94bc3a2e866f807ad398a4 # v0.1.16 | |
| with: | |
| mode: notes | |
| package-path: "./dist" | |
| evidence-dir: .async/release | |
| release-command: "npx --yes github:async/release#e8c938ae44f11558fbbac1c805e0ce81ad765080" | |
| env: | |
| CI: true | |
| - name: Run pipeline task release-evidence | |
| uses: async/actions/run@f81b4ae15d6a8c512a94bc3a2e866f807ad398a4 # v0.1.16 | |
| with: | |
| command: "pnpm async-pipeline github check && pnpm async-pipeline run-task release-evidence" | |
| check-generated: false | |
| artifact-name: async-pipeline-${{ github.job }}-release-evidence-runs | |
| env: | |
| CI: true | |
| - name: Create or update GitHub Release | |
| uses: async/actions/publish@f81b4ae15d6a8c512a94bc3a2e866f807ad398a4 # v0.1.16 | |
| with: | |
| package-path: "./dist" | |
| mode: github-release | |
| registry: "https://registry.npmjs.org" | |
| dist-tag: "latest" | |
| notes-file: .async/release/release-notes.md | |
| env: | |
| CI: true | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Publish GitHub Packages mirror | |
| uses: async/actions/publish@f81b4ae15d6a8c512a94bc3a2e866f807ad398a4 # v0.1.16 | |
| with: | |
| package-path: "./dist" | |
| mode: github-packages | |
| registry: "https://npm.pkg.github.com" | |
| dist-tag: "latest" | |
| token-env-name: GITHUB_TOKEN | |
| env: | |
| CI: true | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Publish npm package | |
| uses: async/actions/publish@f81b4ae15d6a8c512a94bc3a2e866f807ad398a4 # v0.1.16 | |
| with: | |
| package-path: "./dist" | |
| mode: npm | |
| registry: "https://registry.npmjs.org" | |
| dist-tag: "latest" | |
| token-env-name: NODE_AUTH_TOKEN | |
| provenance: true | |
| env: | |
| CI: true | |
| NODE_AUTH_TOKEN: ${{ secrets.npm_token }} | |
| - name: Run release doctor | |
| uses: async/actions/doctor@f81b4ae15d6a8c512a94bc3a2e866f807ad398a4 # v0.1.16 | |
| with: | |
| mode: doctor | |
| package-path: "./dist" | |
| evidence-dir: .async/release | |
| release-command: "npx --yes github:async/release#e8c938ae44f11558fbbac1c805e0ce81ad765080" | |
| network: live | |
| env: | |
| CI: true | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Save Async task cache | |
| if: ${{ success() && github.event_name != 'pull_request' && steps.async-cache-restore.outputs.cache-hit != 'true' }} | |
| uses: async/actions/cache@f81b4ae15d6a8c512a94bc3a2e866f807ad398a4 # v0.1.16 | |
| with: | |
| mode: save | |
| manifest: .async/actions/cache/publish-cache-manifest.json | |
| trust: read-write | |
| release-doctor: | |
| name: release-doctor | |
| if: github.event_name == 'workflow_dispatch' && github.event.inputs.job == 'release-doctor' | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| packages: read | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | |
| - name: Setup pnpm runtime | |
| uses: pnpm/setup@cf03a9b516e09bc5a90f041fc26fc930c9dc631b # v1.0.0 | |
| with: | |
| version: 11.1.0 | |
| runtime: node@24 | |
| install: false | |
| cache: true | |
| cache-dependency-path: "pnpm-lock.yaml" | |
| - name: Install dependencies | |
| run: pnpm install --frozen-lockfile | |
| - name: Write task cache manifest | |
| run: pnpm async-pipeline cache manifest --job release-doctor --output .async/actions/cache/release-doctor-cache-manifest.json --trust read-only | |
| - name: Restore Async task cache | |
| id: async-cache-restore | |
| uses: async/actions/cache@f81b4ae15d6a8c512a94bc3a2e866f807ad398a4 # v0.1.16 | |
| with: | |
| mode: restore | |
| manifest: .async/actions/cache/release-doctor-cache-manifest.json | |
| trust: read-only | |
| - name: Run pipeline task pack | |
| uses: async/actions/run@f81b4ae15d6a8c512a94bc3a2e866f807ad398a4 # v0.1.16 | |
| with: | |
| command: "pnpm async-pipeline github check && pnpm async-pipeline run-task pack" | |
| check-generated: false | |
| artifact-name: async-pipeline-${{ github.job }}-pack-runs | |
| env: | |
| CI: true | |
| - name: Run release doctor | |
| uses: async/actions/doctor@f81b4ae15d6a8c512a94bc3a2e866f807ad398a4 # v0.1.16 | |
| with: | |
| mode: doctor | |
| package-path: "./dist" | |
| evidence-dir: .async/release | |
| release-command: "npx --yes github:async/release#e8c938ae44f11558fbbac1c805e0ce81ad765080" | |
| network: live | |
| env: | |
| CI: true | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Save Async task cache | |
| if: ${{ success() && github.event_name != 'pull_request' && steps.async-cache-restore.outputs.cache-hit != 'true' }} | |
| uses: async/actions/cache@f81b4ae15d6a8c512a94bc3a2e866f807ad398a4 # v0.1.16 | |
| with: | |
| mode: save | |
| manifest: .async/actions/cache/release-doctor-cache-manifest.json | |
| trust: read-write | |
| verify: | |
| name: verify | |
| if: (github.event_name == 'pull_request') || (github.event_name == 'push' && (github.ref == 'refs/heads/main')) || (github.event_name == 'release' && (github.event.action == 'published')) || (github.event_name == 'workflow_dispatch' && github.event.inputs.job == 'verify') | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | |
| - name: Setup pnpm runtime | |
| uses: pnpm/setup@cf03a9b516e09bc5a90f041fc26fc930c9dc631b # v1.0.0 | |
| with: | |
| version: 11.1.0 | |
| runtime: node@24 | |
| install: false | |
| cache: true | |
| cache-dependency-path: "pnpm-lock.yaml" | |
| - name: Install dependencies | |
| run: pnpm install --frozen-lockfile | |
| - name: Write task cache manifest | |
| run: pnpm async-pipeline cache manifest --job verify --output .async/actions/cache/verify-cache-manifest.json --trust read-only | |
| - name: Restore Async task cache | |
| id: async-cache-restore | |
| uses: async/actions/cache@f81b4ae15d6a8c512a94bc3a2e866f807ad398a4 # v0.1.16 | |
| with: | |
| mode: restore | |
| manifest: .async/actions/cache/verify-cache-manifest.json | |
| trust: read-only | |
| - name: Run pipeline job | |
| uses: async/actions/run@f81b4ae15d6a8c512a94bc3a2e866f807ad398a4 # v0.1.16 | |
| with: | |
| command: "pnpm async-pipeline github check && pnpm async-pipeline run verify" | |
| check-generated: false | |
| artifact-name: async-pipeline-${{ github.job }}-runs | |
| env: | |
| CI: true | |
| - name: Save Async task cache | |
| if: ${{ success() && github.event_name != 'pull_request' && steps.async-cache-restore.outputs.cache-hit != 'true' }} | |
| uses: async/actions/cache@f81b4ae15d6a8c512a94bc3a2e866f807ad398a4 # v0.1.16 | |
| with: | |
| mode: save | |
| manifest: .async/actions/cache/verify-cache-manifest.json | |
| trust: read-write | |
| pages: | |
| name: pages | |
| if: (github.event_name == 'workflow_dispatch' && github.event.inputs.job == 'pages') | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | |
| - name: Setup pnpm runtime | |
| uses: pnpm/setup@cf03a9b516e09bc5a90f041fc26fc930c9dc631b # v1.0.0 | |
| with: | |
| version: 11.1.0 | |
| runtime: node@24 | |
| install: false | |
| cache: true | |
| cache-dependency-path: "pnpm-lock.yaml" | |
| - name: Install dependencies | |
| run: pnpm install --frozen-lockfile | |
| - name: Write task cache manifest | |
| run: pnpm async-pipeline cache manifest --task docs.site --output .async/actions/cache/docs.site-cache-manifest.json --trust read-only | |
| - name: Restore Async task cache | |
| id: async-cache-restore | |
| uses: async/actions/cache@f81b4ae15d6a8c512a94bc3a2e866f807ad398a4 # v0.1.16 | |
| with: | |
| mode: restore | |
| manifest: .async/actions/cache/docs.site-cache-manifest.json | |
| trust: read-only | |
| - name: Run Pages target | |
| uses: async/actions/run@f81b4ae15d6a8c512a94bc3a2e866f807ad398a4 # v0.1.16 | |
| with: | |
| command: "pnpm async-pipeline github check && pnpm async-pipeline run-task docs.site" | |
| check-generated: false | |
| artifact-name: async-pipeline-${{ github.job }}-runs | |
| env: | |
| CI: true | |
| - name: Save Async task cache | |
| if: ${{ success() && github.event_name != 'pull_request' && steps.async-cache-restore.outputs.cache-hit != 'true' }} | |
| uses: async/actions/cache@f81b4ae15d6a8c512a94bc3a2e866f807ad398a4 # v0.1.16 | |
| with: | |
| mode: save | |
| manifest: .async/actions/cache/docs.site-cache-manifest.json | |
| trust: read-write | |
| - name: Upload Pages artifact | |
| uses: async/actions/pages@f81b4ae15d6a8c512a94bc3a2e866f807ad398a4 # v0.1.16 | |
| with: | |
| mode: static | |
| path: ".async/pages" | |
| pages-deploy: | |
| name: pages-deploy | |
| needs: "pages" | |
| if: github.event_name != 'pull_request' | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: "github-pages" | |
| url: "${{ steps.deployment.outputs.page_url }}" | |
| permissions: | |
| pages: write | |
| id-token: write | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: async/actions/pages@f81b4ae15d6a8c512a94bc3a2e866f807ad398a4 # v0.1.16 | |
| with: | |
| upload: false | |
| deploy: true |