github / github/codeql

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

Aperta
#20,187 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub
question
Lingua principale
CodeQL
Stelle
10.1k
Fork
2.1k
Merge medio
2g 15h
PR unite (30g)
141

Descrizione

**Description of the issue**

Apparently `codeql-pack.yml` and `qlpack.yml` are equivalent:
https://github.com/github/codeql/blob/3674966946b395a9cc03f314b4d361f3c565ec97/docs/codeql/ql-language-reference/ql-language-specification.rst?plain=1#L67

This might be a source of confusion, so it would be good to at least consistently refer to this file only by one name[^1] (except for the specification mentioned above). Here are cases where `codeql-pack.yml` is currently used:
- `github/codeql`
- https://github.com/github/codeql/blob/3674966946b395a9cc03f314b4d361f3c565ec97/docs/codeql/codeql-language-guides/customizing-library-models-for-actions.rst?plain=1#L71
- ...?
- `github/docs`
- https://github.com/github/docs/blob/5f66400982b48a0f97b4dd2c85bb2677edd09206/content/code-security/code-scanning/managing-your-code-scanning-configuration/editing-your-configuration-of-default-setup.md?plain=1#L75
- ...?
- `github/vscode-codeql`
- https://github.com/github/vscode-codeql/issues/4104

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?

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

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Start with the referenced ql-language-specification.rst and customizing-library-models-for-actions.rst files, then inspect the linked GitHub Docs page and the vscode-codeql issue. Determine which filename should be canonical and check for other references across the named documentation. Done means the documentation uses one name consistently while retaining the specification exception and documenting the alias where appropriate.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
yaml
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.