docs: fix badges in the README #20
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: GitHub release and NPM publishing | |
| # From: https://github.com/garronej/ts-ci | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| branches: | |
| - main | |
| jobs: | |
| check_if_version_upgraded: | |
| name: Check if version upgrade | |
| # When someone forks the repo and opens a PR we want to enables the tests to be run (the previous jobs) | |
| # but obviously only us should be allowed to release. | |
| # In the following check we make sure that we own the branch this CI workflow is running on before continuing. | |
| # Without this check, trying to release would fail anyway because only us have the correct secret.NPM_TOKEN but | |
| # it's cleaner to stop the execution instead of letting the CI crash. | |
| if: | | |
| github.event_name == 'push' || | |
| github.event.pull_request.head.repo.owner.login == github.event.pull_request.base.repo.owner.login | |
| runs-on: ubuntu-latest | |
| outputs: | |
| from_version: ${{ steps.step1.outputs.from_version }} | |
| to_version: ${{ steps.step1.outputs.to_version }} | |
| is_upgraded_version: ${{ steps.step1.outputs.is_upgraded_version }} | |
| is_pre_release: ${{steps.step1.outputs.is_pre_release }} | |
| steps: | |
| - uses: garronej/ts-ci@v2.1.0 | |
| id: step1 | |
| with: | |
| action_name: is_package_json_version_upgraded | |
| branch: ${{ github.head_ref || github.ref }} | |
| create_github_release: | |
| runs-on: ubuntu-latest | |
| # We create release only if the version in the package.json have been | |
| # upgraded and this CI is running against the main branch. We allow | |
| # branches with a PR open on main to publish pre-release (x.y.z-rc.u) but | |
| # not actual releases. | |
| if: | | |
| needs.check_if_version_upgraded.outputs.is_upgraded_version == 'true' && | |
| ( | |
| github.event_name == 'push' || | |
| needs.check_if_version_upgraded.outputs.is_pre_release == 'true' | |
| ) | |
| needs: | |
| - check_if_version_upgraded | |
| steps: | |
| - uses: softprops/action-gh-release@v1 | |
| with: | |
| name: Release v${{ needs.check_if_version_upgraded.outputs.to_version }} | |
| tag_name: v${{ needs.check_if_version_upgraded.outputs.to_version }} | |
| target_commitish: ${{ github.head_ref || github.ref }} | |
| generate_release_notes: true | |
| draft: false | |
| prerelease: ${{ needs.check_if_version_upgraded.outputs.is_pre_release == 'true' }} | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| deploy_gh_page: | |
| runs-on: ubuntu-latest | |
| needs: | |
| - create_github_release | |
| - check_if_version_upgraded | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Set-up bun | |
| uses: oven-sh/setup-bun@v1 | |
| with: | |
| bun-version: latest | |
| - run: bun i --frozen-lockfile && bun i --frozen-lockfile --cwd doc | |
| - run: bun run doc:build | |
| - name: Deploy | |
| uses: crazy-max/ghaction-github-pages@v3 | |
| with: | |
| target_branch: gh-pages | |
| build_dir: doc/build | |
| jekyll: false | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| publish_on_npm: | |
| runs-on: ubuntu-latest | |
| needs: | |
| - create_github_release | |
| - check_if_version_upgraded | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| ref: ${{ github.ref }} | |
| - name: Set-up bun | |
| uses: oven-sh/setup-bun@v1 | |
| with: | |
| bun-version: latest | |
| - name: Setup .npmrc file to publish to npm | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: '18.x' | |
| registry-url: 'https://registry.npmjs.org' | |
| - name: Install dependencies and build | |
| run: bun i --frozen-lockfile && bun run build | |
| - name: Publish to NPM | |
| run: npm publish | |
| env: | |
| NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} |