Skip to content

chore: Update v1.16 change files - #38904

Merged
SarahFrench merged 3 commits into
mainfrom
update-v1.16-change-files
Jul 23, 2026
Merged

chore: Update v1.16 change files#38904
SarahFrench merged 3 commits into
mainfrom
update-v1.16-change-files

Conversation

@SarahFrench

@SarahFrench SarahFrench commented Jul 22, 2026

Copy link
Copy Markdown
Member

I mentioned that I thought the v1.16 change log could be cleaned up, so instead of leaving it at that here are some proposed changes. My understanding is that in the past, before changie was introduced for changelog generation, it was usual for an engineer to edit the changelog of a new release and introduce consistency then. This PR serves the same purpose.

To get these results I:

  • Explored the change files for v1.16 and identified some easy changes to make:
    • Consistent 'enhancement' type for adding -json support.
  • Used an agent to analyse changelogs for v1.0 to the present day v1.16 changelog and propose a style guide for the entries.
    • During this process I:
      • Emphasised user-facing language is important
      • Chose to standardise on active voice over passive voice, and use present tense
      • Chose consistent use of backticks to format flags/block names/identifiers.
      • Specified to use sentence case
      • Specified to use a prefix if a change is scoped to a specific command or backend implementation.
  • Started a new agent session and tasked that agent with using the style guide to propose changes to the change files for v1.16.
  • For each proposed change I manually reviewed and accepted/rejected proposed changes. For example, some of the actions-related changes were going to mistakenly have a stacks: prefix added.

As team we need to agree on any skills etc used to enforce a style guide on our changelog, and when this was previously discussed interest was low. Therefore this PR is not introducing a style guide, it is only proposing changes to the v1.16 change files based on an initial version of that style guide.

We can merge this PR or just use it as the start of discussions - happy for whatever.

Target Release

1.16.x

Rollback Plan

  • If a change needs to be reverted, we will roll out an update to the code within 7 days.

Changes to Security Controls

Are there any changes to security controls (access controls, encryption, logging) in this pull request? If so, explain.

CHANGELOG entry

  • This change is user-facing and I added a changelog entry.
  • This change is not user-facing.

@SarahFrench
SarahFrench requested a review from a team as a code owner July 22, 2026 12:22
@SarahFrench SarahFrench added the no-changelog-needed Add this to your PR if the change does not require a changelog entry label Jul 22, 2026
@github-actions

This comment was marked as off-topic.

@SarahFrench SarahFrench added skip-changelog-check and removed no-changelog-needed Add this to your PR if the change does not require a changelog entry labels Jul 22, 2026
@SarahFrench
SarahFrench requested a review from dsa0x July 22, 2026 15:50
@SarahFrench
SarahFrench merged commit ee9d04b into main Jul 23, 2026
20 of 22 checks passed
@SarahFrench
SarahFrench deleted the update-v1.16-change-files branch July 23, 2026 11:38
austinvalle pushed a commit that referenced this pull request Jul 30, 2026
* Update change file, including swap from new feature to an enhancement

* Update change files to use consistent tense, formatting, and user-facing framing.

* Generate CHANGELOG using new change file contents

i.e. I ran `./scripts/changelog.sh generate dev`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants