From e3e2911fa1280b8eae552a563b8a3e5d3d2d1d36 Mon Sep 17 00:00:00 2001 From: Kristen Newbury Date: Tue, 30 Jul 2024 16:20:47 -0400 Subject: [PATCH 1/3] Update handbook --- docs/development_handbook.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/development_handbook.md b/docs/development_handbook.md index 10ad1637a5..6db6b51e73 100644 --- a/docs/development_handbook.md +++ b/docs/development_handbook.md @@ -1,4 +1,4 @@ -# Coding Standards: Developer handbook +# Coding Standards: Developer handbookA ## Document management @@ -39,7 +39,7 @@ | 0.29.1 | 2023-10-11 | Remco Vermeulen | Address Markdown linter problems. | | 0.30.0 | 2023-11-14 | Remco Vermeulen | Clarify release steps in case of a hotfix release. | | 0.31.0 | 2024-02-23 | Remco Vermeulen | Clarify the required use of Python version 3.9 | -| 0.32.0 | 2024-05-01 | Luke Cartey | Refer to the user manual for the list of supported standards. | +| 0.32.0 | 2024-05-01 | Luke Cartey | Refer to the user manual for the list of supported standards. | 0.33.0 | 2024-07-30 | Kristen Newbury | Remove out dated references to codeql modules directory usage. | ## Scope of work @@ -509,8 +509,7 @@ To upgrade the CodeQL external dependencies: 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` tag in the `github/codeql` repository. 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 4. Populated the `supported_codeql_configs.json` file with the given values, ensuring to delete the optional fields if they are not populated. -5. Update the `codeql_modules/codeql` submodule pointer to the `codeql_standard_library` tag identified. -6. Submit a Pull Request to the `github/codeql-coding-standards` repository with the title `Upgrade `github/codeql` dependency to `. Use this template for the description, filling : +5. Submit a Pull Request to the `github/codeql-coding-standards` repository with the title `Upgrade `github/codeql` dependency to `. Use this template for the description, filling : ```md This PR updates the `supported_codeql_configs.json` file to target: @@ -532,9 +531,9 @@ To upgrade the CodeQL external dependencies: - [ ] Validate performance vs pre-upgrade ``` -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. -8. Once all the automate tests have passed, and the checklist is complete, the PR can be merged. -9. An internal notification should be shared with the development team. +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. +7. Once all the automate tests have passed, and the checklist is complete, the PR can be merged. +8. An internal notification should be shared with the development team. ### Release process From 7b0f058ae628a6a6fc199014b02aaf03a6443f76 Mon Sep 17 00:00:00 2001 From: Kristen Newbury Date: Tue, 30 Jul 2024 16:22:53 -0400 Subject: [PATCH 2/3] Update handbook - prev fix introduced typo --- docs/development_handbook.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/development_handbook.md b/docs/development_handbook.md index 6db6b51e73..b248919271 100644 --- a/docs/development_handbook.md +++ b/docs/development_handbook.md @@ -1,4 +1,4 @@ -# Coding Standards: Developer handbookA +# Coding Standards: Developer handbook ## Document management From 30e2830fb5c4599b14551126b0d85e6aaa5d30bc Mon Sep 17 00:00:00 2001 From: Kristen Newbury Date: Wed, 31 Jul 2024 12:04:51 -0400 Subject: [PATCH 3/3] Update docs/development_handbook.md Co-authored-by: Luke Cartey <5377966+lcartey@users.noreply.github.com> --- docs/development_handbook.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/development_handbook.md b/docs/development_handbook.md index b248919271..b8b883b628 100644 --- a/docs/development_handbook.md +++ b/docs/development_handbook.md @@ -39,7 +39,8 @@ | 0.29.1 | 2023-10-11 | Remco Vermeulen | Address Markdown linter problems. | | 0.30.0 | 2023-11-14 | Remco Vermeulen | Clarify release steps in case of a hotfix release. | | 0.31.0 | 2024-02-23 | Remco Vermeulen | Clarify the required use of Python version 3.9 | -| 0.32.0 | 2024-05-01 | Luke Cartey | Refer to the user manual for the list of supported standards. | 0.33.0 | 2024-07-30 | Kristen Newbury | Remove out dated references to codeql modules directory usage. | +| 0.32.0 | 2024-05-01 | Luke Cartey | Refer to the user manual for the list of supported standards. | +| 0.33.0 | 2024-07-30 | Kristen Newbury | Remove out dated references to codeql modules directory usage. | ## Scope of work