Skip to content

Fix changelog copy errors in change-notes and CHANGELOG.md files#21971

Open
mario-campos wants to merge 1 commit into
mainfrom
mario-campos/fix-changenote-grammar
Open

Fix changelog copy errors in change-notes and CHANGELOG.md files#21971
mario-campos wants to merge 1 commit into
mainfrom
mario-campos/fix-changenote-grammar

Conversation

@mario-campos

Copy link
Copy Markdown
Contributor

This PR is a duplicate of #21947 with the main difference being that this PR targets main.

This PR is necessary because, otherwise, the changelog-generation tool, spark, will generate a changelog with the typos on every run, requiring manual edits to the generated PR.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR fixes copy/wording errors in released change-note source files and their generated CHANGELOG.md counterparts so that the spark changelog-generation tool no longer reproduces those typos on each run.

Changes:

  • Corrected wording in Python 7.1.2 change notes / changelog (“less fewer positive results” → “fewer false positive results”).
  • Corrected wording in Actions 0.6.29 change notes / changelog (“on in minor point” → “on a minor point”).
  • Corrected wording/capitalization in Actions 0.4.37 change notes / changelog (“include” → “including”, “sha1 or sha256” → “SHA-1 or SHA-256”).
Show a summary per file
File Description
python/ql/lib/CHANGELOG.md Fixes a copy error in the generated Python changelog entry for 7.1.2.
python/ql/lib/change-notes/released/7.1.2.md Fixes the underlying released change note text so spark won’t regenerate the typo.
actions/ql/src/CHANGELOG.md Fixes a copy error in the generated Actions (src) changelog entry for 0.6.29.
actions/ql/src/change-notes/released/0.6.29.md Fixes the underlying released change note text so spark won’t regenerate the typo.
actions/ql/lib/CHANGELOG.md Fixes copy/capitalization errors in the generated Actions (lib) changelog entry for 0.4.37.
actions/ql/lib/change-notes/released/0.4.37.md Fixes the underlying released change note text so spark won’t regenerate the typo.

Copilot's findings

  • Files reviewed: 6/6 changed files
  • Comments generated: 0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Actions Analysis of GitHub Actions documentation Python

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants