Skip to content

CLI: Point the update-notice to the changelog in the suggested version#19911

Merged
ndelangen merged 7 commits into
storybookjs:nextfrom
cprecioso:patch-1
Nov 29, 2023
Merged

CLI: Point the update-notice to the changelog in the suggested version#19911
ndelangen merged 7 commits into
storybookjs:nextfrom
cprecioso:patch-1

Conversation

@cprecioso
Copy link
Copy Markdown
Contributor

Issue:

The upgrade notice when starting Storybook always points to the CHANGELOG in the next branch. However, if e.g. you're in the 6.x releases, the next branch doesn't actually have the changelog for the next 6.x release. An easy way to fix this is to always point to the CHANGELOG residing in the tag corresponding to the suggested version.

What I did

Changed next as a ref in the changelog URL to the ref of the suggested version

How to test

  • Is this testable with Jest or Chromatic screenshots?
  • Does this need a new example in the kitchen sink apps?
  • Does this need an update to the documentation?

If your answer is yes to any of these, please make sure to include it in your PR.

This affects the current 6.x releases, so I don't know if I should submit this PR to the main or next branch.

@ndelangen ndelangen assigned ndelangen and unassigned yannbf Jan 13, 2023
@ndelangen ndelangen requested a review from kylegach January 13, 2023 18:02
@ndelangen
Copy link
Copy Markdown
Member

@kylegach could you check if this is implemented correctly? will this work? is this a good idea?

Comment thread code/lib/core-server/src/utils/update-check.ts Outdated
Copy link
Copy Markdown
Contributor

@kylegach kylegach left a comment

Choose a reason for hiding this comment

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

So sorry for letting this sit so long! 🤦‍♂️

Thanks for catching this detail! The change is great conceptually, but needs an update in how it's executed, which I explained in my other comment.

cprecioso and others added 2 commits April 20, 2023 12:54
Co-authored-by: Kyle Gach <kyle.gach@gmail.com>
@cprecioso cprecioso requested a review from kylegach April 20, 2023 10:55
@ndelangen
Copy link
Copy Markdown
Member

@kylegach could to give this a review, and merge this PR of all is 👍 ?

@ndelangen ndelangen added the ci:docs Run the CI jobs for documentation checks only. label Nov 28, 2023
@ndelangen ndelangen changed the base branch from next to release-8-0 November 28, 2023 09:01
Copy link
Copy Markdown
Contributor

@kylegach kylegach left a comment

Choose a reason for hiding this comment

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

Thanks for this thoughtful fix, Carlos!

@kylegach kylegach changed the base branch from release-8-0 to next November 28, 2023 21:20
@ndelangen ndelangen merged commit c5ccd6c into storybookjs:next Nov 29, 2023
@ndelangen ndelangen changed the title Point the update notice to the changelog in the suggested version Maintenance: Point the update-notice to the changelog in the suggested version Nov 29, 2023
@ndelangen ndelangen changed the title Maintenance: Point the update-notice to the changelog in the suggested version CLI: Point the update-notice to the changelog in the suggested version Nov 29, 2023
@github-actions github-actions Bot mentioned this pull request Nov 29, 2023
36 tasks
@cprecioso cprecioso deleted the patch-1 branch November 30, 2023 08:10
@github-actions github-actions Bot mentioned this pull request Dec 7, 2023
44 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:docs Run the CI jobs for documentation checks only. cli feature request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants