diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yaml similarity index 82% rename from .github/workflows/ci.yml rename to .github/workflows/ci.yaml index 79ac05e1..d9edc018 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yaml @@ -1,12 +1,13 @@ --- -# docs at: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions +# file format documented at: +# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions name: CI on: [push, pull_request] jobs: - # TODO: check project builds/compiles correctly, maybe with tsc TypeScript compiler? - # TODO: add tests including coverage + # TODO: check project builds/compiles correctly? maybe with tsc? + # TODO: add tests including coverage (jest and mocha/chai?) lint_src_files: name: Lint source files @@ -119,9 +120,11 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - name: Check the commits conform to the Conventional Commits specification with commitlint + - name: > + Check the commits conform to the Conventional + Commits specification with commitlint uses: wagoid/commitlint-github-action@v5 -# TODO: check commits squashed into one (i.e. all changes in a PR are in one commit after last one in primary branch) -# TODO: use semver to increase version numbers and update changelog automatically -# TODO: publish new release automatically if version increased and CI passes (use release-please?) +# TODO: check PRs have all changes (squashed) in(to) 1 commit +# TODO: make semver automatically bump version num and update changelog +# TODO: publish new release if version num bumped and CI passes diff --git a/.github/workflows/publish-beta.yml-disabled b/.github/workflows/publish-beta.yaml-disabled similarity index 100% rename from .github/workflows/publish-beta.yml-disabled rename to .github/workflows/publish-beta.yaml-disabled diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yaml similarity index 83% rename from .github/workflows/publish.yml rename to .github/workflows/publish.yaml index b5c7c0c6..680d8fab 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yaml @@ -1,3 +1,4 @@ +--- name: "🚀 publish" on: @@ -15,4 +16,4 @@ jobs: registry-url: https://registry.npmjs.org/ - run: npm publish env: - NODE_AUTH_TOKEN: ${{secrets.NPM_ACCESS_TOKEN}} \ No newline at end of file + NODE_AUTH_TOKEN: ${{secrets.NPM_ACCESS_TOKEN}}