Skip to content

Commit c125634

Browse files
ARCH-1919 - Updates for consistency
1 parent 1f650e3 commit c125634

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

.github/workflows/build-and-review-pr.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ jobs:
7878
NO_MATCH_SETTING_4: ''
7979

8080
steps:
81-
- uses: actions/checkout@v2
81+
- uses: actions/checkout@v3
8282

8383
#---------------------------------------------------------
8484
# MATCHING SCOPE WITH CREATE-OUTPUT-VARIABLES SET TO FALSE

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ This action sets environment variables, (and optionally step outputs), to differ
2020
- [Source Code Changes](#source-code-changes)
2121
- [Recompiling Manually](#recompiling-manually)
2222
- [Updating the README.md](#updating-the-readmemd)
23+
- [Tests](#tests)
2324
- [Code of Conduct](#code-of-conduct)
2425
- [License](#license)
2526

@@ -201,6 +202,7 @@ When creating PRs, please review the following guidelines:
201202
- [ ] At least one of the commit messages contains the appropriate `+semver:` keywords listed under [Incrementing the Version] for major and minor increments.
202203
- [ ] The action has been recompiled. See [Recompiling Manually] for details.
203204
- [ ] The README.md has been updated with the latest version of the action. See [Updating the README.md] for details.
205+
- [ ] Any tests in the [build-and-review-pr] workflow are passing
204206

205207
### Incrementing the Version
206208

@@ -235,6 +237,10 @@ npm run build
235237

236238
If changes are made to the action's [source code], the [usage examples] section of this file should be updated with the next version of the action. Each instance of this action should be updated. This helps users know what the latest tag is without having to navigate to the Tags page of the repository. See [Incrementing the Version] for details on how to determine what the next version will be or consult the first workflow run for the PR which will also calculate the next version.
237239

240+
### Tests
241+
242+
The build and review PR workflow includes tests which are linked to a status check. That status check needs to succeed before a PR is merged to the default branch. When a PR comes from a branch, there should not be any issues running the tests. When a PR comes from a fork, tests may not have the required permissions or access to run since the `GITHUB_TOKEN` only has `read` access set for all scopes. Also, forks cannot access other secrets in the repository. In these scenarios, a fork may need to be merged into an intermediate branch by the repository owners to ensure the tests run successfully prior to merging to the default branch.
243+
238244
## Code of Conduct
239245

240246
This project has adopted the [im-open's Code of Conduct](https://github.com/im-open/.github/blob/main/CODE_OF_CONDUCT.md).

0 commit comments

Comments
 (0)