Skip to content

Latest commit

 

History

History
70 lines (40 loc) · 3.38 KB

notes.md

File metadata and controls

70 lines (40 loc) · 3.38 KB

Development Notes

Release

Configuration Files

NPM JS

  • Create a 'granular token' with the right permissions

GitHub

  • Create a new 'Secrets and Variables > Action > Repository Secrets' named NPM_PUBLISH_TOKEN

Publish

  • Create a new release using a tag whose format is v.x.x.x

TypeScript

The current TypeScript version for the project is 4.9.x. When it's time to move up to 5, both package.json and dependabot.yaml must be updated accordingly.

Test Coverage

Test Coverage

  • Use nyc with at least the html and cobertura reports (see nyc configuration).

  • The script npm run test:coverage runs the tests generating the coverage report into ./coverage/report.

Code Coverage Action

This action does not run the test but...

  1. Uses irongut/[email protected] to both output the coverage and to generate a nice markdown file, which includes a img.shields.io badge.

  2. Uses marocchino/sticky-pull-request-comment@v2 to add a comment to the PR stating the coverage.

  3. Runs a bash script that isolates the badge from the generated markdown on step 1 and downloads the respective .svg file, saving it to ./coverage/coverage.svg file.

Publish the Coverage Reports

  1. The Github repository pages is set to use Git Actions to publish the pages, instead of loading them from a branch.

  2. In the ci workflow

    1. The test step uses the actions actions/configure-pages@v3 and actions/upload-pages-artifact@v1 to prepare the pages and to upload the ./coverage directory

      • Preparing the pages probably just need to be done once, so this may need to change if other steps are uploading content to the pages

    2. The deploy-coverage job deploys the uploaded content.

      • This job only works when ran from a branch that is allowed to deploy to the github-pages environment.
        • This environment is automatically created when preparing the pages
        • At the moment, only main is authorized
      • A permission error is thrown if the branch is not allowed, with a message that refers to the id-token permission
      • See the documentation for the actions/deploy-pages@v2 action for more details.

Using the Published Coverage

The pages for this repository are located at https://m-paternostro.github.io/chai-ts (this can be checked on the GitHub pages, after a workflow has successfully deployed pages). Moreover:

With these, it's possible to write the Coverage badge in the README.md.