Unclear release notes / change log
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- github-actions
- Domain
- documentation, release
Research direction
No file, test, or entry point is identified. Start by reviewing the current codeql-action release notes and the CodeQL bundle version updates, then compare the related discussion in #1728. Done would mean a decided, actionable approach for documenting bundle changes such as added, removed, or fixed rules.
Written by the indexing model from the issue text.
Description
We're using the codeql-action action and try to keep it up-to-date using Dependabot. Such PRs are not merged unthinkingly, we normally check the changes (new features, bugfixes etc.) first. Unfortunately the changelog for new versions/tags of the codeql-action action is often not very helpful to find out what's actually changed, especially when it comes to the CodeQL bundle. We often see something like "Update default CodeQL bundle version to [x.y.z]", but there's no information about the changes that come with the new bundle version (e.g. if rule implementations have been added, removed or fixed etc). And trying to find this out by checking the tags and history of the github/codeql repo doesn't help much either. Am I just missing places where I should look for such information? Or is there actually improvement potential on release notes and changelogs?
(This somehow seems to be similar to #1728, but I didn't want to continue on an already closed issue.)
- Dominant language
- TypeScript
- Stars
- 1.6k
- Forks
- 493
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 44
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from github/codeql-action
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
github/codeql-action#4052 · 4 comments ·
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
github/codeql-action#4078 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
github/codeql-action#4008 · 9 comments ·
-
Difficulty 4/5 3-5 days Newbie friendliness 52/100
github/codeql-action#3978 · 4 comments · 1 reaction ·
-
Difficulty 3/5 1-2 days Newbie friendliness 48/100
github/codeql-action#3915 · 6 comments · 3 reactions ·
All issues in github/codeql-action
Similar issues
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
dennys-bd/agent-hive#184 ·
-
Add: hunch Open
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
AbdelStark/awesome-typesafe#104 ·
-
ai-observability bug team/ai-observability
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
vicharanashala/fln#563 ·