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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

documenting release process #5252

Merged
merged 2 commits into from Jul 2, 2018

Conversation

Projects
None yet
8 participants
@feministy
Member

feministy commented Dec 13, 2016

refs #4135

I took the comments from @segiddins, @lynnco, and @indirect and organized them with a little extra prose where I saw fit. It's mostly y'alls words, just reorganized 馃槉

There are a few questions I have, mostly about branching:

  • When 1.12.pre.1 is released, is it merged to 1-12-stable?
  • If there are bugs in 1.12.pre.1 and the branch (1-12-pre-1) is merged to master, is the branch for 1.12.pre.2 a branch off of 1-12-stable?
  • Are there any places we can reference to follow on discussions about in progress features, roadmaps, planned work, etc? It might be a good place to reference some of that stuff
  • How can people get in touch with the core team?
  • Is there a template for blog posts?

A few things to note:

  • In the notes on the issue, it looks like you flop between using . versus - as the delimiter in your branch names. I went with - since that appears to be what you're using in the repo itself
  • I do the full Github links so when people pull it down locally, they have the reference to the full link locally instead of relying on Github's magic linking
current state of master: `1-12-stable`
From that release branch, we create the first pre-release branch for that minor
version: `1-12-0-pre-1`. Until `1-12-0-pre-1` is ready for release, all active

This comment has been minimized.

@segiddins

segiddins Dec 17, 2016

Member

we only do branches for the minor series -- there is no 1-12-0 branch, for example

bundlerbot added a commit that referenced this pull request Jan 24, 2017

Auto merge of #5350 - feministy:docs-reorg, r=indirect
[docs] consolidate all docs into sub folder

馃憢 goodness, that was a lot of typing! this is the first step of many for #5026.

the only section that isn't complete with these changes is `RELEASING.md`, which is in progress in #5252 (those changes will be moved into the proper location if this PR goes in first).

i made a few minor tweaks to the project's README to support this organization. i also left the code of conduct in the root.

~~one thing i *am concerned about* is that our little "guidelines for contributing" warning message on PRs is going to disappear after this gets merged because `CONTRIBUTING.md` is no longer in the root~~

~~should i put a file in the root called `CONTRIBUTING.md` that links to the docs for contributing? 馃  i'm not 100% sure on how the github integration for that works so y'all let me know.~~

bundlerbot added a commit that referenced this pull request Jan 24, 2017

Auto merge of #5350 - feministy:docs-reorg, r=indirect
[docs] consolidate all docs into sub folder

馃憢 goodness, that was a lot of typing! this is the first step of many for #5026.

the only section that isn't complete with these changes is `RELEASING.md`, which is in progress in #5252 (those changes will be moved into the proper location if this PR goes in first).

i made a few minor tweaks to the project's README to support this organization. i also left the code of conduct in the root.

~~one thing i *am concerned about* is that our little "guidelines for contributing" warning message on PRs is going to disappear after this gets merged because `CONTRIBUTING.md` is no longer in the root~~

~~should i put a file in the root called `CONTRIBUTING.md` that links to the docs for contributing? 馃  i'm not 100% sure on how the github integration for that works so y'all let me know.~~
@colby-swandale

This comment has been minimized.

Member

colby-swandale commented Mar 23, 2017

ping @feministy

@indirect

This comment has been minimized.

Member

indirect commented Aug 22, 2017

When 1.12.pre.1 is released, is it merged to 1-12-stable?

We generally branch off 1-12-stable from master first, and then release version 1.12.pre.1 from the tip of the 1-12-stable branch.

If there are bugs in 1.12.pre.1 and the branch (1-12-pre-1) is merged to master, is the branch for 1.12.pre.2 a branch off of 1-12-stable?

Since there is only one branch per minor version (1-11-stable and then 1-12-stable), we put all changes to the 1.12.x series of releases into the 1-12-stable branch. After doing a release, we merge the exact commit that was released into master to make sure that it's up to date.

Are there any places we can reference to follow on discussions about in progress features, roadmaps, planned work, etc? It might be a good place to reference some of that stuff

We generally use a GitHub issues milestone to track releases, but we don't have a lot of formal tracking: https://github.com/bundler/bundler/milestones

How can people get in touch with the core team?

Slack is easiest, and users can invite themselves at slack.bundler.io, but we also have a shared email address: team@bundler.io.

Is there a template for blog posts?

Not yet, but I started working on something to automate new releases on the website, and it has a template for the "what's new" page in it: bundler/bundler-site#307

@schneems

This comment has been minimized.

Contributor

schneems commented Apr 16, 2018

What鈥檚 the status here. Is this PR still being worked on?

@feministy

This comment has been minimized.

Member

feministy commented Apr 23, 2018

@schneems I have not had time to devote to this PR, everything I have pushed up so far is all of the work I've done. If someone wants to take it over, that's ok with me!

feministy and others added some commits Dec 13, 2016

@segiddins

This comment has been minimized.

Member

segiddins commented Jul 1, 2018

I've just updated this, I'd greatly appreciate some review 鉂わ笍

I've made changes

@segiddins segiddins changed the title from [WIP] documenting release process to documenting release process Jul 1, 2018

@@ -1,9 +1,147 @@
# Releasing
_Release process documentation is in progress, see [PR 5252](https://github.com/bundler/bundler/pull/5252)._
Bundler users [Semantic Versioning](https://semver.org/).

This comment has been minimized.

@segiddins
@indirect

This looks fantastic. With a little bit of explanation on how to do the changelog stuff, I am r+.

PR, section, author(s), issue(s) closed, and message.
Ensure that repo has been updated with all new PRs before releasing a new version,
and copy over the new sections to the `CHANGELOG.md` in the Bundler repo.

This comment has been minimized.

@indirect

indirect Jul 1, 2018

Member

How does one update that repo? I honestly don't remember, and that repo doesn't have a readme. 馃槶

This comment has been minimized.

@segiddins

segiddins Jul 1, 2018

Member

uh, I haven't done so since my last release. want to open an issue there for someone to add a README ?

@segiddins segiddins requested a review from rubymorillo Jul 1, 2018

@segiddins

This comment has been minimized.

Member

segiddins commented Jul 2, 2018

@bundlerbot

This comment has been minimized.

Contributor

bundlerbot commented Jul 2, 2018

馃搶 Commit 05819a2 has been approved by segiddins

@bundlerbot

This comment has been minimized.

Contributor

bundlerbot commented Jul 2, 2018

鈱涳笍 Testing commit 05819a2 with merge 233dc13...

bundlerbot added a commit that referenced this pull request Jul 2, 2018

Auto merge of #5252 - feministy:release-docs, r=segiddins
documenting release process

refs #4135

I took the comments from @segiddins, @lynnco, and @indirect and organized them with a little extra prose where I saw fit. It's mostly y'alls words, just reorganized 馃槉

There are a few questions I have, mostly about branching:

- When `1.12.pre.1` is released, is it merged to `1-12-stable`?
- If there are bugs in `1.12.pre.1` *and* the branch (`1-12-pre-1`) is merged to master, is the branch for `1.12.pre.2` a branch off of `1-12-stable`?
- Are there any places we can reference to follow on discussions about in progress features, roadmaps, planned work, etc? It might be a good place to reference some of that stuff
- How can people get in touch with the core team?
- Is there a template for blog posts?

A few things to note:

- In the notes on the issue, it looks like you flop between using `.` versus `-` as the delimiter in your branch names. I went with `-` since that appears to be what you're using in the repo itself
- I do the full Github links so when people pull it down locally, they have the reference to the full link locally instead of relying on Github's magic linking
@bundlerbot

This comment has been minimized.

Contributor

bundlerbot commented Jul 2, 2018

鈽锔 Test successful - status-travis
Approved by: segiddins
Pushing 233dc13 to master...

@bundlerbot bundlerbot merged commit 05819a2 into bundler:master Jul 2, 2018

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
homu Test successful
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment