-
Notifications
You must be signed in to change notification settings - Fork 1.9k
[Docs] Consistently refer to either codeql-pack.yml or qlpack.yml #20187
Description
Description of the issue
Apparently codeql-pack.yml and qlpack.yml are equivalent:
| ``codeql-pack.yml`` is an alias for ``qlpack.yml``. |
This might be a source of confusion, so it would be good to at least consistently refer to this file only by one name1 (except for the specification mentioned above). Here are cases where codeql-pack.yml is currently used:
github/codeqlcodeql/docs/codeql/codeql-language-guides/customizing-library-models-for-actions.rst
Line 71 in 3674966
2. Create a model pack file ``/codeql-pack.yml`` with the following content: - ...?
github/docsgithub/vscode-codeql
Additionally it might be good to mention in https://docs.github.com/en/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/publishing-and-using-codeql-packs#about-qlpackyml-files that codeql-pack.yml is an alias.
What do you think?
Footnotes
-
If the canonical name is
qlpack.yml, then maybe prefer that, except that the lock file is namedcodeql-pack.lock.yml... ↩