Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Further improve Release docs #9925

Merged
merged 2 commits into from
Oct 17, 2018
Merged

Conversation

tofumatt
Copy link
Member

@tofumatt tofumatt commented Sep 14, 2018

Includes proposal of a new versioning scheme and more accurate representation of the release candidate process.

This includes a proposal to move away from versioning what are, in effect, major releases with minor release bumps that reset at 3.9 > 4.0. In the future we should just do something like what Firefox or React do and increment major versions at every "release".

This would be closer to semantic versioning as we shouldn't be deprecating things with minor versions, but code marked as deprecated in 3.6 gets removed by 3.9.

Since 4.0 is upcoming anyway I figured now is a great time to make the change. DISCUSS! 😉

Includes proposal of a new versioning scheme and more accurate representation
of the release candidate process.
@tofumatt tofumatt requested a review from a team September 14, 2018 20:37

### Writing the Release Post and Changelog

1. Open the [list of closed pull requests](https://github.com/WordPress/gutenberg/pulls?utf8=✓&q=is%3Apr+is%3Aclosed+sort%3Acreated-desc+) and filter by the current milestone.
Copy link
Member Author

Choose a reason for hiding this comment

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

This will only work once we get an auto-tagging milestone bot: #9239

@gziolo gziolo added the [Type] Developer Documentation Documentation for developers label Sep 25, 2018
@tofumatt tofumatt modified the milestone: 4.0 Sep 26, 2018
Copy link
Member

@gziolo gziolo left a comment

Choose a reason for hiding this comment

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

It all looks good. It's much detailed than what we had before so I would be happy to land it and iterate.

# Do a dry run of the repository reset. Prompting the user for a list of all
# files that will be removed should prevent them from losing important files!
status "Resetting the repository to pristine condition. ✨"
git clean -xdf --dry-run
warning "🚨 About to delete everything above! Is this okay? 🚨"
echo -n "[Y]es/[N]o: "
echo -n "[y]es/[N]o: "
Copy link
Member

@gziolo gziolo Oct 17, 2018

Choose a reason for hiding this comment

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

It should be lowercase for N, too? :)

Copy link
Member Author

Choose a reason for hiding this comment

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

No is the default, so it's uppercase 😄

@gziolo gziolo added this to the 4.1 - UI freeze milestone Oct 17, 2018
@tofumatt
Copy link
Member Author

These docs include the notion we should be labelling 4.1 as 5.0. @mtias: if that's wrong, we should tweak them, but for now I'ma :shipit:

@tofumatt tofumatt merged commit 2165f84 into master Oct 17, 2018
@tofumatt tofumatt deleted the docs/more-release-docs-tweaks branch October 17, 2018 09:52
@@ -1,4 +1,4 @@
Gutenberg's deprecation policy is intended to support backwards-compatibility for two minor releases, when possible. The current deprecations are listed below and are grouped by _the version at which they will be removed completely_. If your plugin depends on these behaviors, you must update to the recommended alternative before the noted version.
Copy link
Member

@aduth aduth Apr 1, 2019

Choose a reason for hiding this comment

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

Was this supposed to be removed without a replacement? It currently reads awkwardly as "intended to support compatibility for releases". I don't think it should have been removed.

Edit: I propose adding back in #14756

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants