Skip to content

[Docs] Consistently refer to either codeql-pack.yml or qlpack.yml #20187

@Marcono1234

Description

@Marcono1234

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:

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

  1. If the canonical name is qlpack.yml, then maybe prefer that, except that the lock file is named codeql-pack.lock.yml ...

Metadata

Metadata

Assignees

No one assigned

    Labels

    questionFurther information is requested

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions