Document current release process #165

alloy · 2020-03-02T14:04:21Z

To be clear, this iteration is meant to document the current process. Next iterations will:

Fill in gaps in docs.
Introduce suggested changes.

kelset

First off, thanks for doing this! I think it's really important to be more clear in what happens when a release is created 👍

I've left a few comments, a few nits and a couple more "relevant" - more than happy to discuss them through here or in DMs 🤗

.vscode/settings.json

kelset · 2020-03-02T18:52:05Z

README.md

+# React Native’s Release Process
+
+At Facebook React Native is not consumed via released versions, instead they
+always consume the latest version of the `master` branch. This means that they


instead they always consume the latest version of the master branch.

nitpick: technically master is a "not 100% precise" mirror image of what used internally. I wonder if we should be more specific - like:

"instead, they consume an internal version which gets synced to the code in master without necessarily being a 1:1 copy"

cc @TheSavior IIRC a long time ago you had a gist with some relevant information about "how react native works" - do you still have the link to it? Could we maybe link it here so that people could read more about it?

https://gist.github.com/TheSavior/608dfb8d5f80a0eef0f0b1681db5ec95

We definitely consume a 1:1 copy of master, we are just a couple minutes ahead.

We definitely consume a 1:1 copy of master

ah yeah, probably I choose a poor wording 🤦‍♂️
my understanding is more like

react native codebase in FB = master in OSS + other stuff

which yeah, it's a 1:1. But, also, you consume it differently AFAIK (ex. not using CLI/react-native init). Is my understanding wrong? Is it worth specifying?

Yeah, we consume it a bit differently. We use buck for example.

I also would still reword:

react native codebase in FB = master in OSS + other stuff

to

Facebook's monorepo = master of react native repo + other stuff

Yeah I knew it was a simplification, but I figured there’s no real reason to further add details about that which isn’t really related to who to release RN. I’m fine with adding/rewording it if you think that eases understanding for readers?

I'm happy with what you have in the original text

Maybe let's keep the original text but add a link to the gist?

Suggested change

always consume the latest version of the `master` branch. This means that they

always consume the [latest version of the `master` branch](https://gist.github.com/TheSavior/608dfb8d5f80a0eef0f0b1681db5ec95). This means that they

My one issue with the gist, as-is, is that it also touches on the release side of things, which may become confusing. As a curious person, I like the insight into how FB does things, so perhaps that part could just be imported as another separate doc that is linked to here?

@kelset bump

README.md

docs/generate-changelog.md

elicwhite · 2020-03-09T20:59:36Z

What's the plan for this PR? It seems like this would be unlikely to be complete. Does it make sense to merge these as is and then iterate as you learn more things about the process? That way it will also be easier for people to review the new things you learn.

kelset · 2020-03-10T09:04:18Z

Does it make sense to merge these as is and then iterate as you learn more things about the process?

I don't think we should merge as it is, as the Readme still requires a bit of work/changes.

That said I agree that maybe it could be good to find a way to reduce its scope and increate the docs in follow up PRs (ex. maybe the upgrade-helper part could be its own PR?)

alloy · 2020-03-10T11:44:46Z

Agreed with @kelset; I’ll do a bit more work and leave docs on parts of the process outside of direct releasing for follow-up.

alloy · 2020-03-10T13:52:44Z

README.md

-
-To use it first off `git clone` the repo, then `yarn` and finally you can use it like in the following example: `./changelog-generator.js -b v0.57.5 -c v0.57.6`.
-
-## "When will my fix make it into a release?"


I think we should bring this back too somewhere, in the next iteration.

Co-Authored-By: Lorenzo Sciandra <lorenzo.sciandra@gmail.com>

alloy · 2020-03-10T13:55:42Z

Alright, this should be ready to go 👍

alloy · 2020-03-10T13:56:32Z

docs/upgrade-helper.md

@@ -0,0 +1,3 @@
+# Upgrade helper
+
+Point people: [@pvinis](https://github.com/pvinis)


@pvinis Do you feel like fleshing this doc with explanation and instructions out?

docs/upgrade-helper.md

README.md

docs/publish-release.md

elicwhite · 2020-03-10T15:59:10Z

docs/publish-release.md

+
+1. Pushing the changed version numbers will eventually kickoff the `publish_npm_package` workflow on CI, keep an eye on it.
+
+   ⚠️ Currently publishing fails due to SSH not being setup to accept github.com automatically. To workaround this:


Major yikes. Looking forward to improvements here. 👍

Aye, it’s on my list for right after these doc changes.

docs/release-process.md

alloy · 2020-03-10T16:38:24Z

Done 🙆‍♂

kelset

Oh well I was still reviewing this while it got merged... I'll leave the feedback anyway but not finish all the sections since it's pointless at this point

kelset · 2020-03-10T16:41:08Z

README.md

+
+At Facebook React Native is not consumed via released versions, instead they always consume the latest version of the `master` branch. This means that they are able to iterate fast for _their_ needs; if something is broken the fix is a single commit away.
+
+External users are of course similarly able to consume the latest `master` version, however this is most likely a too fast moving target for most.


Suggested change

External users are of course similarly able to consume the latest `master` version, however this is most likely a too fast moving target for most.

External users are similarly able to consume the latest `master` version, however this is most likely a too fast moving target for most.

I would remove "of course" as it's honestly hard to setup and probably not well documented either. (also, I've never attempted it and only heard stories from literally 2 developers about doing it)

Unsure about this one. To me this is the lead-up to “…, however”, if you know what I mean? I don’t feel like it implies that this is easy.

ok, it's probably different way of interpreting english - but I know but bad at it so it's ok.

I mean, I’m by no means a native English speaker myself 😬

README.md

docs/generate-changelog.md

docs/publish-release.md

elicwhite · 2020-03-10T18:14:45Z

It's not pointless! Changes can be made in a follow up! :D

alloy · 2020-03-10T18:16:16Z

Hey, yeah, please do leave all the feedback!

And sorry for the ambiguity in when/who would merge, I’ll make sure to improve that next time.

elicwhite · 2020-03-10T18:19:58Z

For us at Facebook, typically once I get an approval, I address that feedback and merge. Iterating and making additional changes is easy and I prefer not to block people from making progress. That works as long as everyone feels comfortable giving feedback at any time, even on merged changes, trusting that they will still get addressed. 🙂

It is reasonable if you all would prefer a different style here. 👍

alloy · 2020-03-11T13:45:34Z

@kelset #171

kelset self-requested a review March 2, 2020 14:27

kelset added release status Information about an upcoming or ongoing release rfc Request for comments and removed rfc Request for comments labels Mar 2, 2020

kelset reviewed Mar 2, 2020

View reviewed changes

kelset reviewed Mar 3, 2020

View reviewed changes

README.md Show resolved Hide resolved

alloy commented Mar 9, 2020

View reviewed changes

docs/generate-changelog.md Show resolved Hide resolved

alloy commented Mar 10, 2020

View reviewed changes

alloy changed the title ~~[WIP] Document current release process~~ Document current release process Mar 10, 2020

alloy and others added 15 commits March 10, 2020 14:54

[vscode] Import style rule

64bf674

[README] Import first pass at high-level description of current process

25643df

[docs] Import branch-strategy doc

96c6118

Address PR feedback

6a996bf

Co-Authored-By: Lorenzo Sciandra <lorenzo.sciandra@gmail.com>

[docs] First pass at detailed release process

3659742

[docs] Add release process in more detail

01c29e0

[docs] Remove newlines within paragraphs

9e9206b

[docs] Prettier

0210f4c

[vscode] Remove settings

e20d392

[docs] No RCs are made for patch versions

2dc420c

[docs] Finish first pass at release-process doc

5573b8c

[docs] Simply wording

a3a37ec

[docs] First pass at publish doc

8cad2db

[docs] Finish publish-release doc

d3a1c3e

[docs] Bring back README intro

e0f74b8

alloy force-pushed the document-current-release-process branch from aa1ee92 to e0f74b8 Compare March 10, 2020 13:55

alloy commented Mar 10, 2020

View reviewed changes

lucasbento reviewed Mar 10, 2020

View reviewed changes

docs/upgrade-helper.md Outdated Show resolved Hide resolved

docs/upgrade-helper.md Outdated Show resolved Hide resolved

kelset requested review from kelset and elicwhite March 10, 2020 14:53

[docs] Add @lucasbento as upgrade-helper point person

1f00a1d

elicwhite approved these changes Mar 10, 2020

View reviewed changes

[docs] Address PR feedback

4212e3c

alloy merged commit 190509e into master Mar 10, 2020

alloy deleted the document-current-release-process branch March 10, 2020 17:57

kelset reviewed Mar 10, 2020

View reviewed changes

alloy mentioned this pull request Mar 11, 2020

[docs] Incorporate more feedback #171

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document current release process #165

Document current release process #165

alloy commented Mar 2, 2020 •

edited

Loading

kelset left a comment

kelset Mar 2, 2020

elicwhite Mar 2, 2020

kelset Mar 2, 2020 •

edited

Loading

elicwhite Mar 2, 2020

alloy Mar 2, 2020

elicwhite Mar 2, 2020

kelset Mar 3, 2020

alloy Mar 3, 2020

alloy Mar 9, 2020

elicwhite commented Mar 9, 2020

kelset commented Mar 10, 2020

alloy commented Mar 10, 2020

alloy Mar 10, 2020

alloy commented Mar 10, 2020

alloy Mar 10, 2020

elicwhite Mar 10, 2020

alloy Mar 10, 2020

alloy commented Mar 10, 2020

kelset left a comment

kelset Mar 10, 2020

alloy Mar 11, 2020

kelset Mar 12, 2020

alloy Mar 12, 2020

elicwhite commented Mar 10, 2020

alloy commented Mar 10, 2020

elicwhite commented Mar 10, 2020

alloy commented Mar 11, 2020

	always consume the latest version of the `master` branch. This means that they
	always consume the [latest version of the `master` branch](https://gist.github.com/TheSavior/608dfb8d5f80a0eef0f0b1681db5ec95). This means that they


		To use it first off `git clone` the repo, then `yarn` and finally you can use it like in the following example: `./changelog-generator.js -b v0.57.5 -c v0.57.6`.

		## "When will my fix make it into a release?"

		@@ -0,0 +1,3 @@
		# Upgrade helper

		Point people: [@pvinis](https://github.com/pvinis)


		1. Pushing the changed version numbers will eventually kickoff the `publish_npm_package` workflow on CI, keep an eye on it.

		⚠️ Currently publishing fails due to SSH not being setup to accept github.com automatically. To workaround this:


		At Facebook React Native is not consumed via released versions, instead they always consume the latest version of the `master` branch. This means that they are able to iterate fast for _their_ needs; if something is broken the fix is a single commit away.

		External users are of course similarly able to consume the latest `master` version, however this is most likely a too fast moving target for most.

	External users are of course similarly able to consume the latest `master` version, however this is most likely a too fast moving target for most.
	External users are similarly able to consume the latest `master` version, however this is most likely a too fast moving target for most.

Document current release process #165

Document current release process #165

Conversation

alloy commented Mar 2, 2020 • edited Loading

kelset left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kelset Mar 2, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elicwhite commented Mar 9, 2020

kelset commented Mar 10, 2020

alloy commented Mar 10, 2020

Choose a reason for hiding this comment

alloy commented Mar 10, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alloy commented Mar 10, 2020

kelset left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elicwhite commented Mar 10, 2020

alloy commented Mar 10, 2020

elicwhite commented Mar 10, 2020

alloy commented Mar 11, 2020

alloy commented Mar 2, 2020 •

edited

Loading

kelset Mar 2, 2020 •

edited

Loading