Updated CONTRIBUTING.md with TOC & Readability Changes #11
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: 🦜 Publish Canary | |
| on: | |
| push: | |
| branches: [main, next] | |
| # We don't want this to run when we publish a release. | |
| tags-ignore: ['v**'] | |
| # No need to run on docs-only changes | |
| paths-ignore: ['docs/**'] | |
| # Cancel in-progress runs of this workflow. | |
| # See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#example-only-cancel-in-progress-jobs-or-runs-for-the-current-workflow. | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| publish-canary: | |
| name: 🦜 Publish Canary | |
| if: github.repository == 'redwoodjs/redwood' | |
| runs-on: ubuntu-latest | |
| outputs: | |
| version: ${{ steps.get-version.outputs.value }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| # `fetch-depth`—number of commits to fetch. `0` fetches all history for all branches and tags. | |
| # This is required because lerna uses tags to determine the version. | |
| with: | |
| fetch-depth: 0 | |
| - name: Enable Corepack | |
| run: corepack enable | |
| - name: Set up job | |
| uses: ./.github/actions/set-up-job | |
| - name: 🔎 Lint | |
| run: yarn lint | |
| - name: 🧪 Test | |
| run: yarn test | |
| - name: 🚢 Publish | |
| run: ./.github/scripts/publish_canary.sh | |
| env: | |
| NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }} | |
| - name: 🏷 Get version | |
| id: get-version | |
| uses: sergeysova/[email protected] | |
| with: | |
| cmd: 'jq .version packages/core/package.json -r' | |
| message-slack: | |
| name: 💬 Message Slack | |
| needs: publish-canary | |
| if: ${{ !cancelled() }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: 💬 Message Slack | |
| uses: ./.github/actions/message_slack_publishing | |
| with: | |
| title: "🦜 Canary Packages" | |
| status: ${{ needs.publish-canary.result }} | |
| version: ${{ needs.publish-canary.outputs.version }} | |
| slack-webhook-url: ${{ secrets.SLACK_WEBHOOK_URL_PACKAGE_PUBLISHING }} |