github / github/codeql

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

Đang mở
#20,187 2 bình luận 0 reaction 0 người được giao Xem trên GitHub
question
Ngôn ngữ chính
CodeQL
Star
10.1k
Fork
2.1k
Merge trung bình
2 ngày 15 giờ
Pull request đã merge (30 ngày)
141

Mô tả

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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.