Skip to content
This repository has been archived by the owner on Mar 12, 2020. It is now read-only.

Updates README #1823

Merged
merged 4 commits into from
Sep 6, 2019
Merged

Updates README #1823

merged 4 commits into from
Sep 6, 2019

Conversation

kierangillen
Copy link
Contributor

@kierangillen kierangillen commented Aug 29, 2019

  • Adds README clarification for emission deployment

#trivial

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated
@@ -96,12 +96,13 @@ We vendor some data from other repositories that you will sometimes need to upda

**Note:** Deploys are mostly automated using `yarn release patch|minor|major`; the following instructions should be valid but take a look at [this issue](https://github.com/artsy/emission/issues/1077#issuecomment-401128949) if things break.

**Note 2:** If you're updating React Native, you're gonna have to do a lot of this stuff manually. See the makefile/alloy/orta for more info.
**Note 2:** If you're updating React Native, you're going to have to do a lot of this stuff manually. See the makefile or alloy for more info.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
**Note 2:** If you're updating React Native, you're going to have to do a lot of this stuff manually. See the makefile or alloy for more info.
**Note 2:** If you're updating React Native, you're going to have to do a lot of this stuff manually. See the makefile, ashfurrow, or alloy for more info.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ash aint getting off that easy.

Copy link
Contributor

Choose a reason for hiding this comment

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

lol

README.md Outdated
2. For non-pre-releases, use either `yarn release patch`, `yarn release minor`, or `yarn release major`. For
pre-releases, use `yarn release prerelease`. Pre-releases are usually reserved for testing major releases before deployment.
3. After the release has finished compiling, a PR will be automatically created in Metaphysics, which can be self assigned and merged.
4. If integrating in Eigen consult the docs [on updating Emission](https://github.com/artsy/eigen/blob/master/docs/updating_emission.md)
Copy link
Contributor

Choose a reason for hiding this comment

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

FYI If you only use 1. then when markdown gets rendered it automatically increases the number, which means you can move items around in the list without having to change numbers the whole time.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh wow, didn't know, awesome.

README.md Outdated
1. If integrating in Eigen consult the docs [on updating Emission](https://github.com/artsy/eigen/blob/master/docs/updating_emission.md)
2. For non-pre-releases, use either `yarn release patch`, `yarn release minor`, or `yarn release major`. For
pre-releases, use `yarn release prerelease`. Pre-releases are usually reserved for testing major releases before deployment.
3. After the release has finished compiling, a PR will be automatically created in Metaphysics, which can be self assigned and merged.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe add some detail about what the PR contains.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

👍

@@ -96,11 +96,12 @@ We vendor some data from other repositories that you will sometimes need to upda

**Note:** Deploys are mostly automated using `yarn release patch|minor|major`; the following instructions should be valid but take a look at [this issue](https://github.com/artsy/emission/issues/1077#issuecomment-401128949) if things break.

**Note 2:** If you're updating React Native, you're gonna have to do a lot of this stuff manually. See the makefile/alloy/orta for more info.
**Note 2:** If you're updating React Native, you're going to have to do a lot of this stuff manually. See the makefile, ashfurrow or alloy for more info.
Copy link
Contributor

Choose a reason for hiding this comment

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

No Oxford comma??? 😱

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm a minimalist at heart

@alloy
Copy link
Contributor

alloy commented Sep 6, 2019

Great, thanks! 🚀

#MergeOnGreen

@artsy-peril artsy-peril bot merged commit f68f6bd into master Sep 6, 2019
@alloy alloy deleted the docs branch September 6, 2019 16:36
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants