github / github/codeql

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

Abierto
#20,187 2 comentarios 0 reacciones 0 asignados Ver en GitHub
question
Lenguaje dominante
CodeQL
Estrellas
10.1k
Forks
2.1k
Merge medio
2 d 15 h
PR fusionados (30 d)
141

Descripción

**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` ...

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza con los archivos referenciados ql-language-specification.rst y customizing-library-models-for-actions.rst, luego inspecciona la página enlazada de GitHub Docs y el issue de vscode-codeql. Determina qué nombre de archivo debería ser el canónico y comprueba si hay otras referencias en la documentación mencionada. Se considera terminado cuando la documentación usa un solo nombre de forma coherente, conserva la excepción de la especificación y documenta el alias donde corresponda.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
yaml
Área
documentation
Tipo de issue
Documentación
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.