Skip to content

Address incorrect package file generation command #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 11, 2022
Merged

Address incorrect package file generation command #46

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/development_handbook.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
| 0.23.0 | 2022-07-05 | Remco Vermeulen | Update text to consider both the C++ and the C standards. |
| 0.24.0 | 2022-07-05 | Remco Vermeulen | Update release process to include steps for external help files. |
| 0.25.0 | 2022-07-22 | Jeroen Ketema | Document the existence and purpose of the `next` branch. |
| 0.26.0 | 2022-08-10 | Remco Vermeulen | Address incorrect package file generation command. This was missing the required language argument. |

## Scope of work

Expand Down Expand Up @@ -262,13 +263,13 @@ Ensure that the repository [codeql-coding-standards-help](https://github.com/git
To generate the rule package files, run the following script from the root of the repository:

```
python3.9 scripts/generate_rules/generate_package_files.py <rule_package_name>
python3.9 scripts/generate_rules/generate_package_files.py <language> <rule_package_name>
```

If the repository [codeql-coding-standards-help](https://github.com/github/codeql-coding-standards-help) is not cloned as a sibling, then run the script as follows:

```
python3.9 scripts/generate_rules/generate_package_files.py --external-help-dir <codeql_coding_standards_help_path> <rule_package_name>
python3.9 scripts/generate_rules/generate_package_files.py --external-help-dir <codeql_coding_standards_help_path> <language> <rule_package_name>
```

After running this script, the following files will be generated in the `<lang>/<standard>/src/rules/<rule-id>/` directory:
Expand Down