Skip to content

Scripts: Fix the changelog writer to escape doublequotes#23996

Merged
ShaunEvening merged 1 commit into
nextfrom
shaun/fix-chanelog-json-builder
Aug 29, 2023
Merged

Scripts: Fix the changelog writer to escape doublequotes#23996
ShaunEvening merged 1 commit into
nextfrom
shaun/fix-chanelog-json-builder

Conversation

@ShaunEvening
Copy link
Copy Markdown
Contributor

@ShaunEvening ShaunEvening commented Aug 29, 2023

What I did

  • Escape doublequotes when writing to json changelog files
  • Update write-changlelog tests to make sure doublequotes are escaped

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

@ShaunEvening ShaunEvening added the build Internal-facing build tooling & test updates label Aug 29, 2023
@ShaunEvening ShaunEvening self-assigned this Aug 29, 2023
@JReinhold JReinhold added ci:normal Run our default set of CI jobs (choose this for most PRs). patch:yes Bugfix & documentation PR that need to be picked to main branch labels Aug 29, 2023
Copy link
Copy Markdown
Contributor

@JReinhold JReinhold left a comment

Choose a reason for hiding this comment

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

This looks good to me.

Currently changelogs for minors/majors are handwritten, including the version JSONs. That's because the automated release will only contain the changes since the most recent prerelease, but we need it to contain all the changes since the most recent minor, so we hand-merge all the changes from the all the prereleases.

Therefore, I think you should add a sentence about this issue to this parts of the docs as well: https://github.com/storybookjs/storybook/blob/main/CONTRIBUTING/RELEASING.md?plain=1#L318-L320

@ShaunEvening
Copy link
Copy Markdown
Contributor Author

@JReinhold If they have to make manual changes to latest.json they shouldn't have this issue as their editor would tell them that they JSON format if broken

@ShaunEvening ShaunEvening merged commit 7669124 into next Aug 29, 2023
@ShaunEvening ShaunEvening deleted the shaun/fix-chanelog-json-builder branch August 29, 2023 20:38
storybook-bot pushed a commit that referenced this pull request Aug 29, 2023
…ilder

Scripts: Fix the changelog writer to escape doublequotes
(cherry picked from commit 7669124)
storybook-bot pushed a commit that referenced this pull request Aug 29, 2023
…ilder

Scripts: Fix the changelog writer to escape doublequotes
(cherry picked from commit 7669124)
@github-actions github-actions Bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Aug 29, 2023
@ndelangen ndelangen removed the patch:yes Bugfix & documentation PR that need to be picked to main branch label Oct 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

build Internal-facing build tooling & test updates ci:normal Run our default set of CI jobs (choose this for most PRs). patch:done Patch/release PRs already cherry-picked to main/release branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants