Skip to content

Commit

Permalink
Merge pull request #320 from nedbat/nedbat/spelling
Browse files Browse the repository at this point in the history
  • Loading branch information
ewjoachim authored Dec 21, 2023
2 parents ac4b804 + cc4a460 commit 5986309
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ You'll need a GitHub token to test the action locally. You have 3 choices:
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
personnal access token (feel free to then save it to `dev-env-vars`)
personal access token (feel free to then save it to `dev-env-vars`)

#### Manually
```console
Expand All @@ -52,7 +52,7 @@ To run the end-to-end tests, you'll need:

- `gh` [installed](https://cli.github.com/)
- 2 envvars `COVERAGE_COMMENT_E2E_GITHUB_TOKEN_USER_1` and `COVERAGE_COMMENT_E2E_GITHUB_TOKEN_USER_2` containing
personnal access tokens for 2 distinct users. You may omit the 2nd user but
personal access tokens for 2 distinct users. You may omit the 2nd user but
some tests won't run. Use [this
link](https://github.com/settings/tokens/new?scopes=repo,workflow,delete_repo&description=Python%20Coverage%20Comment%20Action%20CI%20-%20User%201)
to generate tokens with the proper configuration.
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ badge to your Readme will be displayed in:

### Basic usage

The following snippet is targetted for cases where you expect PRs from
The following snippet is targeted for cases where you expect PRs from
users that don't have write access to the repository. Posting the comment
is done in 2 steps:

Expand Down Expand Up @@ -504,11 +504,11 @@ jobs:
## Pinning

On the examples above, the version was set to the tag `v3`. Pinning to a major version
will give you the latest release on this version. (Note that we release everytime after
will give you the latest release on this version. (Note that we release every time after
a PR is merged). Pinning to a specific version (`v3.1` for example) would make the
action more reproducible, though you'd have to update it regularly (e.g. using
Dependabot). You can also pin a commit hash if you want to be 100% sure of what you run,
given that tags are mutable. Finally, You can also decide to pin to main, if you're ok
given that tags are mutable. Finally, You can also decide to pin to main, if you're OK
with the action maybe breaking when (if) we release a v4.

## Note on the state of this action
Expand Down Expand Up @@ -571,5 +571,5 @@ to use the svg badge directly, and not the `shields.io` URL.
## Upgrading from v2 to v3

- When upgrading, we change the location and format where the coverage
data is kept. Pull request that have not been rebased may be displaying
data is kept. Pull request that have not been re-based may be displaying
slightly wrong information.
2 changes: 1 addition & 1 deletion dev-env
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ function clone-repo(){
}

function create-repo(){
gh repo create "${GITHUB_REPOSITORY}" --clone --public --description 'Personnal development environment for python-comment-coverage-action' --template "${GITHUB_REPOSITORY_TEMPLATE}"
gh repo create "${GITHUB_REPOSITORY}" --clone --public --description 'Personal development environment for python-comment-coverage-action' --template "${GITHUB_REPOSITORY_TEMPLATE}"
repo_dirname=$(basename ${GITHUB_REPOSITORY})
mv "${repo_dirname}/"{*,.*} .
rmdir "${repo_dirname}"
Expand Down

0 comments on commit 5986309

Please sign in to comment.