Skip to content

Commit e3e2911

Browse files
committed
Update handbook
1 parent e03211b commit e3e2911

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

docs/development_handbook.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Coding Standards: Developer handbook
1+
# Coding Standards: Developer handbookA
22

33
## Document management
44

@@ -39,7 +39,7 @@
3939
| 0.29.1 | 2023-10-11 | Remco Vermeulen | Address Markdown linter problems. |
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 |
42-
| 0.32.0 | 2024-05-01 | Luke Cartey | Refer to the user manual for the list of supported standards. |
42+
| 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. |
4343

4444
## Scope of work
4545

@@ -509,8 +509,7 @@ To upgrade the CodeQL external dependencies:
509509
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.
510510
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
511511
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 :
512+
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 :
514513

515514
```md
516515
This PR updates the `supported_codeql_configs.json` file to target:
@@ -532,9 +531,9 @@ To upgrade the CodeQL external dependencies:
532531
- [ ] Validate performance vs pre-upgrade
533532
```
534533

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.
534+
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.
535+
7. Once all the automate tests have passed, and the checklist is complete, the PR can be merged.
536+
8. An internal notification should be shared with the development team.
538537

539538
### Release process
540539

0 commit comments

Comments
 (0)