Skip to content

Latest commit

 

History

History
79 lines (65 loc) · 3.51 KB

CONTRIBUTING.md

File metadata and controls

79 lines (65 loc) · 3.51 KB
Raw

Contribution

You're welcome to contribute, though I can't promise the experience will be as smooth as I'd like it to. I'll let you figure out most of it, though feel free to ask for help on anything you're stuck.

Things to know:

  • Python3.12
  • Use Poetry
  • Launch tests with pytest, config is in setup.cfg
  • ruff runs through pre-commit, so you can install hooks with pre-commit install.
  • docker. Classic stuff.

Launching locally

Use:

$ source ./dev-env

This should take care of everything and will display instructions. Feel free to read the script yourself to see what it does.

You'll need a GitHub token to test the action locally. You have 3 choices:

  • Before launching dev-env, copy dev-env-vars.dist to dev-env-vars and set your token
  • After launching dev-env, run token-from-gh to reuse your gh token for the action (you may need to define additional scopes with gh auth refresh --scope=...)
  • After launching dev-env, run create-token to interactively create a personal access token (feel free to then save it to dev-env-vars)

Manually

$ # Either push (compute & post badge), pull_request (compute comment) or workflow_run (post comment)
$ export GITHUB_EVENT_NAME=workflow_run
$ # Used only for push to test that the current branch is the repo default branch
$ export GITHUB_REF=
$ # Used only for workflow_run, set to a pull_request run id
$ export GITHUB_PR_RUN_ID=xxx
$ # Used only in pull_request to compute diff coverage
$ export GITHUB_BASE_REF=master
$ # Used everywhere
$ export GITHUB_REPOSITORY=py-cov-action/python-coverage-comment-action-v3-example
$ # Used everywhere. Generate at https://github.com/settings/tokens/new?scopes=repo&description=test%20python-coverage-comment-action
$  export GITHUB_TOKEN=

Then either launch with poetry run coverage_comment or through docker.

End to end tests

To run the end-to-end tests, you'll need:

  • gh installed
  • 2 envvars COVERAGE_COMMENT_E2E_GITHUB_TOKEN_USER_1 and COVERAGE_COMMENT_E2E_GITHUB_TOKEN_USER_2 containing personal access tokens for 2 distinct users. You may omit the 2nd user but some tests won't run. Use this link to generate tokens with the proper configuration. It's a good idea to not use your main GitHub user for this because the tests do some destructive actions (like deleting repos).
  • Make sure you don't have a repository named "python-coverage-comment-action-end-to-end" (that would be a leftover of a previous test). If you do, delete it with gh repo delete python-coverage-comment-action-end-to-end.
  • Please be aware that the tests will launch gh auth setup-git which might be surprising if you use https remotes (sadly, setting GIT_CONFIG_GLOBAL seems not to be enough to isolate tests.)

Coverage labs

Computing the coverage rate

The coverage rate is covered_lines / total_lines (as one would expect). In case "branch coverage" is enabled, the coverage rate is (covered_lines + covered_branches) / (total_lines + total_branches). In order to display coverage rates, we need to round the values. Depending on the situation, we either round to 0 or 2 decimal places. Rounding rules are:

  • We always round down (truncate) the value.
  • We don't display the trailing zeros in the decimal part (nor the decimal point if the decimal part is 0).