From cc4a460d2cad07c94508e86250928bd7d9a3991a Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Thu, 21 Dec 2023 12:18:38 -0500 Subject: [PATCH] Spelling fixes --- CONTRIBUTING.md | 4 ++-- README.md | 8 ++++---- dev-env | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ebd1ea43..dfdbc70f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 @@ -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. diff --git a/README.md b/README.md index dca3baa2..5d19bfb2 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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 @@ -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. diff --git a/dev-env b/dev-env index ca8b7891..19b1535a 100755 --- a/dev-env +++ b/dev-env @@ -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}"