Skip to content

Commit a1a5cab

Browse files
authored
Merge pull request #655 from knewbury01/knewbury01/fix-handbook
Update handbook
2 parents a7e1624 + 30e2830 commit a1a5cab

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/development_handbook.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040
| 0.30.0 | 2023-11-14 | Remco Vermeulen | Clarify release steps in case of a hotfix release. |
4141
| 0.31.0 | 2024-02-23 | Remco Vermeulen | Clarify the required use of Python version 3.9 |
4242
| 0.32.0 | 2024-05-01 | Luke Cartey | Refer to the user manual for the list of supported standards. |
43+
| 0.33.0 | 2024-07-30 | Kristen Newbury | Remove out dated references to codeql modules directory usage. |
4344

4445
## Scope of work
4546

@@ -509,8 +510,7 @@ To upgrade the CodeQL external dependencies:
509510
2. Determine if there is a compatible CodeQL CLI bundle version by looking at the releases specified at [CodeQL Action releases](https://github.com/github/codeql-action/releases). The bundle always includes the standard library at the version specified by the `codeql-cli/v<version-number>` tag in the `github/codeql` repository.
510511
3. If you find a compatible CodeQL CLI bundle, determine whether that bundle was released in a GitHub Enterprise server release, by inspecting the `defaults.json` file at https://github.com/github/codeql-action/blob/main/lib/defaults.json#L2 for the CodeQL Action submitted with
511512
4. Populated the `supported_codeql_configs.json` file with the given values, ensuring to delete the optional fields if they are not populated.
512-
5. Update the `codeql_modules/codeql` submodule pointer to the `codeql_standard_library` tag identified.
513-
6. Submit a Pull Request to the `github/codeql-coding-standards` repository with the title `Upgrade `github/codeql` dependency to <insert codeql_standard_library value>`. Use this template for the description, filling :
513+
5. Submit a Pull Request to the `github/codeql-coding-standards` repository with the title `Upgrade `github/codeql` dependency to <insert codeql_standard_library value>`. Use this template for the description, filling :
514514

515515
```md
516516
This PR updates the `supported_codeql_configs.json` file to target:
@@ -532,9 +532,9 @@ To upgrade the CodeQL external dependencies:
532532
- [ ] Validate performance vs pre-upgrade
533533
```
534534

535-
7. Follow the dependency upgrade checklist, confirming each step. The `.github/workflows/standard_library_upgrade_tests.yml` will trigger automation for running the `github/codeql` unit tests with the appropriate CLI version.
536-
8. Once all the automate tests have passed, and the checklist is complete, the PR can be merged.
537-
9. An internal notification should be shared with the development team.
535+
6. Follow the dependency upgrade checklist, confirming each step. The `.github/workflows/standard_library_upgrade_tests.yml` will trigger automation for running the `github/codeql` unit tests with the appropriate CLI version.
536+
7. Once all the automate tests have passed, and the checklist is complete, the PR can be merged.
537+
8. An internal notification should be shared with the development team.
538538

539539
### Release process
540540

0 commit comments

Comments
 (0)