Skip to content

Commit c85a47e

Browse files
committed
Adds missing updates to documentation
1 parent 767f8da commit c85a47e

File tree

3 files changed

+43
-41
lines changed

3 files changed

+43
-41
lines changed

{{ cookiecutter.__github_folder }}/_/cpp/workflows/cpp-ci-checklist.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ Be sure to properly fine-tune the generated actions before committing it to the
44

55
## ci-tests-cpp
66

7-
- [ ] [ENV] The target name for the test executable has been configured.
8-
- [ ] [JOB-CONF] The target Docker image where to run the test has been specified (defaults to
9-
*ubuntu:jammy*).
10-
- [ ] [JOB-CONF] The credentials for acquiring the Docker image (if needed) have been configured
7+
- [ ] [**ENV**] The target name for the test executable has been configured.
8+
- [ ] [**JOB-CONF**] The target Docker image where to run the test has been specified (defaults to
9+
*ubuntu:jammy*). **Delete it if not needed**.
10+
- [ ] [**JOB-CONF**] The credentials for acquiring the Docker image (if needed) have been configured
1111
via secrets and required section in workflow file uncommented.
12-
- [ ] [ENV] The build type for the tests is correctly specified, as a CMAKE_BUILD_TYPE (defaults to
12+
- [ ] [**ENV**] The build type for the tests is correctly specified, as a CMAKE_BUILD_TYPE (defaults to
1313
*Debug*).
14-
- [ ] [WORKFLOW-CONF] The intended branch and triggers are correct (default: *on PR to master
14+
- [ ] [**WORKFLOW-CONF**] The intended branch and triggers are correct (default: *on PR to master
1515
branch* and on workflow call).
1616

1717
Note that, for a PR to be blocked if Unit Testing action fails, status checks must be enabled on the
@@ -22,30 +22,30 @@ checks to pass before merging'.
2222

2323
## ci-auto-release-cpp
2424

25-
- [ ] [JOB-CONF] The target Docker image where to run the test has been specified (defaults to
25+
- [ ] [**JOB-CONF**] The target Docker image where to run the test has been specified (defaults to
2626
*ubuntu:jammy*).
27-
- [ ] [JOB-CONF] The credentials for acquiring the Docker image (if needed) have been configured
27+
- [ ] [**JOB-CONF**] The credentials for acquiring the Docker image (if needed) have been configured
2828
via secrets and required section in workflow file uncommented.
29-
- [ ] [ENV] The build type for the release is correctly specified, as a CMAKE_BUILD_TYPE (defaults
29+
- [ ] [**ENV**] The build type for the release is correctly specified, as a CMAKE_BUILD_TYPE (defaults
3030
to *Release*).
31-
- [ ] [WORKFLOW-CONF] The intended branch and triggers are correct (default: *on push to master*).
32-
- [ ] [STEP-CONF] The release is assumed to be packaged with cpack and that utility configured to
31+
- [ ] [**WORKFLOW-CONF**] The intended branch and triggers are correct (default: *on push to master*).
32+
- [ ] [**STEP-CONF**] The release is assumed to be packaged with cpack and that utility configured to
3333
store generated files inside build/packages folder. Please update this if needed.
34-
- [ ] [STEP-CONF] If exists, uncomment the body selection of the release step (if uncommented,
34+
- [ ] [**STEP-CONF**] If exists, uncomment the body selection of the release step (if uncommented,
3535
defaults to a *CHANGES.md* file in the root of the repository).
3636

3737
## ci-tagged-release-cpp
3838

39-
- [ ] [JOB-CONF] The target Docker image where to run the test has been specified (defaults to
39+
- [ ] [**JOB-CONF**] The target Docker image where to run the test has been specified (defaults to
4040
*ubuntu:jammy*).
41-
- [ ] [JOB-CONF] The credentials for acquiring the Docker image (if needed) have been configured
41+
- [ ] [**JOB-CONF**] The credentials for acquiring the Docker image (if needed) have been configured
4242
via secrets and required section in workflow file uncommented.
43-
- [ ] [ENV] The build type for the release is correctly specified, as a CMAKE_BUILD_TYPE (defaults
43+
- [ ] [**ENV**] The build type for the release is correctly specified, as a CMAKE_BUILD_TYPE (defaults
4444
to *Release*).
45-
- [ ] [WORKFLOW-CONF] The intended branch and triggers are correct (default: *on tag push*).
46-
- [ ] [WORKFLOW-CONF] The default tag pattern matches the one intended for the project (defaults
45+
- [ ] [**WORKFLOW-CONF**] The intended branch and triggers are correct (default: *on tag push*).
46+
- [ ] [**WORKFLOW-CONF**] The default tag pattern matches the one intended for the project (defaults
4747
to: *"\*.\*.\*"*).
48-
- [ ] [STEP-CONF] The release is assumed to be packaged with cpack and that utility configured to
48+
- [ ] [**STEP-CONF**] The release is assumed to be packaged with cpack and that utility configured to
4949
store generated files inside build/packages folder. Please update this if needed.
50-
- [ ] [STEP-CONF] If exists, uncomment the body selection of the release step (if uncommented,
50+
- [ ] [**STEP-CONF**] If exists, uncomment the body selection of the release step (if uncommented,
5151
defaults to a *CHANGES.md* file in the root of the repository).

{{ cookiecutter.__github_folder }}/_/generic/workflows/generic-ci-checklist.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@ Be sure to properly fine-tune the generated actions before committing it to the
44

55
## ci-auto-release-generic
66

7-
- [ ] The intended branch and triggers are correct (default: *on push to master*).
8-
- [ ] If exists, uncomment the body selection of the release action (if uncommented, defaults to a
9-
*CHANGES.md* file in the root of the repository).
7+
- [ ] [**WORKFLOW-CONF**] The intended branch and triggers are correct (default: *on push to master*).
8+
- [ ] [**STEP-CONF**] If exists, uncomment the body selection of the release action (if uncommented,
9+
defaults to a *CHANGES.md* file in the root of the repository).
1010

1111
## ci-tagged-release-generic
1212

13-
- [ ] The intended branch and triggers are correct (default: *on tag push*).
14-
- [ ] The default tag pattern matches the one intended for the project (default: *"\*.\*.\*"*).
15-
- [ ] If exists, uncomment the body selection of the release action (if uncommented, defaults to a
16-
*CHANGES.md* file in the root of the repository).
13+
- [ ] [**WORKFLOW-CONF**] The intended branch and triggers are correct (default: *on tag push*).
14+
- [ ] [**WORKFLOW-CONF**] The default tag pattern matches the one intended for the project
15+
(default: *"\*.\*.\*"*).
16+
- [ ] [**STEP-CONF**] If exists, uncomment the body selection of the release action (if uncommented,
17+
defaults to a *CHANGES.md* file in the root of the repository).

{{ cookiecutter.__github_folder }}/_/python/workflows/python-ci-checklist.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ Be sure to properly fine-tune the generated actions before committing it to the
44

55
## ci-tests-python
66

7-
- [ ] The target python version has been configured (defaults to *3.10.2*).
8-
- [ ] The target test directory where tests live has been defined (defaults to *tests*).
9-
- [ ] The intended branch and triggers are correct (default: *on PR to master branch* and on
10-
workflow call).
7+
- [ ] [**ENV**] The target python version has been configured (defaults to *3.10.2*).
8+
- [ ] [**ENV**] The target test directory where tests live has been defined (defaults to *tests*).
9+
- [ ] [**WORKFLOW-CONF**] The intended branch and triggers are correct (default: *on PR to master
10+
branch* and on workflow call).
1111

1212
Note that, for a PR to be blocked if Unit Testing action fails, status checks must be enabled on the
1313
target branch.
@@ -17,17 +17,18 @@ checks to pass before merging'.
1717

1818
## ci-auto-release-python
1919

20-
- [ ] The target python version has been configured (defaults to *3.10.2*).
21-
- [ ] The target test directory where tests live has been defined (defaults to *tests*).
22-
- [ ] The intended branch and triggers are correct (default: *on push to master*).
23-
- [ ] If exists, uncomment the body selection of the release action (if uncommented, defaults to a
24-
*CHANGES.md* file in the root of the repository).
20+
- [ ] [**ENV**] The target python version has been configured (defaults to *3.10.2*).
21+
- [ ] [**ENV**] The target test directory where tests live has been defined (defaults to *tests*).
22+
- [ ] [**WORKFLOW-CONF**] The intended branch and triggers are correct (default: *on push to master*).
23+
- [ ] [**STEP-CONF**] If exists, uncomment the body selection of the release action (if uncommented,
24+
defaults to a *CHANGES.md* file in the root of the repository).
2525

2626
## ci-tagged-release-python
2727

28-
- [ ] The target python version has been configured (defaults to *3.10.2*).
29-
- [ ] The target test directory where tests live has been defined (defaults to *tests*).
30-
- [ ] The intended branch and triggers are correct (default: *on tag push*).
31-
- [ ] The default tag pattern matches the one intended for the project (default: *"\*.\*.\*"*).
32-
- [ ] If exists, uncomment the body selection of the release action (if uncommented, defaults to a
33-
*CHANGES.md* file in the root of the repository).
28+
- [ ] [**ENV**] The target python version has been configured (defaults to *3.10.2*).
29+
- [ ] [**ENV**] The target test directory where tests live has been defined (defaults to *tests*).
30+
- [ ] [**WORKFLOW-CONF**] The intended branch and triggers are correct (default: *on tag push*).
31+
- [ ] [**WORKFLOW-CONF**] The default tag pattern matches the one intended for the project
32+
(default: *"\*.\*.\*"*).
33+
- [ ] [**STEP-CONF**] If exists, uncomment the body selection of the release action (if uncommented,
34+
defaults to a *CHANGES.md* file in the root of the repository).

0 commit comments

Comments
 (0)