Skip to content

Docs: Document release tooling#23181

Merged
JReinhold merged 22 commits into
nextfrom
release-docs
Jun 27, 2023
Merged

Docs: Document release tooling#23181
JReinhold merged 22 commits into
nextfrom
release-docs

Conversation

@JReinhold

@JReinhold JReinhold commented Jun 22, 2023

Copy link
Copy Markdown
Contributor

Closes #22609

What I did

Added documentation for the release tooling and process. See this for a rendered version:
https://github.com/storybookjs/storybook/blob/release-docs/CONTRIBUTING/RELEASING.md

I just added it at CONTRIBUTING/RELEASING.md but I don't care much about where this documentation lives, inputs are welcome. I don't think it's appropriate in the contribute section on the docs site though

How to test

Checklist

  • Make sure your changes are tested (stories and/or unit, integration, or end-to-end tests)
  • Make sure to add/update documentation regarding your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Maintainers

  • If this PR should be tested against many or all sandboxes,
    make sure to add the ci:merged or ci:daily GH label to it.
  • Make sure this PR contains one of the labels below.

["cleanup", "BREAKING CHANGE", "feature request", "bug", "documentation", "maintenance", "dependencies", "other"]

@JReinhold JReinhold self-assigned this Jun 22, 2023
@JReinhold JReinhold marked this pull request as ready for review June 22, 2023 00:44
@JReinhold JReinhold requested review from a team, jonniebigodes and kylegach June 22, 2023 00:44

@vanessayuenn vanessayuenn 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.

This is so comprehensive! Good work 🔥🔥🔥

I have a couple of nits around the wording -- left suggestions for those. Regarding release cadence, I think we need to discuss it more thoroughly before writing anything down in a public document. I suggest leaving this topic out of the current document and instead discussing it as a team at the offsite next week. Once we have come to an agreement, we can commit to it in writing.

Comment thread CONTRIBUTING/RELEASING.md Outdated
Comment thread CONTRIBUTING/RELEASING.md Outdated
Comment thread CONTRIBUTING/RELEASING.md Outdated
Comment thread CONTRIBUTING/RELEASING.md
Comment thread CONTRIBUTING/RELEASING.md

@jonniebigodes jonniebigodes 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.

@JReinhold, this is amazing. Fantastic job on this. I left a couple of nits regarding phrasing for you to consider. Let me know and we'll go from here.

Comment thread CONTRIBUTING/RELEASING.md Outdated
Comment thread CONTRIBUTING/RELEASING.md Outdated
@JReinhold

Copy link
Copy Markdown
Contributor Author

@jonniebigodes @vanessayuenn I've adressed all your comments now.

@JReinhold JReinhold merged commit c00af84 into next Jun 27, 2023
@JReinhold JReinhold deleted the release-docs branch June 27, 2023 08:00
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.

Release Tooling Project: Document flow in contribution guidelines

3 participants