docs: 📝 Added information on creating release to README #169
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
README.md
Outdated
|
|
||
| The steps involved with creating a new release are as follows : | ||
|
|
||
| 1. Make sure the version in package.json is updated as appropriate |
There was a problem hiding this comment.
I'd like a more detailed and step-by-step. Think someone completely new to the team is going to try this for the first time.
Suggested change
| 1. Make sure the version in package.json is updated as appropriate | |
| 1. Update the version in `package.json` | |
| 2. Run `npm install` and check the new version in the generated `package-lock.json` |
README.md
Outdated
| The steps involved with creating a new release are as follows : | ||
|
|
||
| 1. Make sure the version in package.json is updated as appropriate | ||
| 2. Make sure develop has all the changes that are intended to be in the release |
There was a problem hiding this comment.
Suggested change
| 2. Make sure develop has all the changes that are intended to be in the release | |
| 2. Create a PR against `develop` with the version update. Review and merge the PR |
README.md
Outdated
|
|
||
| 1. Make sure the version in package.json is updated as appropriate | ||
| 2. Make sure develop has all the changes that are intended to be in the release | ||
| 3. Merge `develop` into the `main` branch |
There was a problem hiding this comment.
Suggested change
| 3. Merge `develop` into the `main` branch | |
| 3. Create a PR from `develop` into the `main` branch and make sure it includes all the changes that are intended to be in the release. Reviewed and merge the PR |
README.md
Outdated
| 1. Make sure the version in package.json is updated as appropriate | ||
| 2. Make sure develop has all the changes that are intended to be in the release | ||
| 3. Merge `develop` into the `main` branch | ||
| 4. Launch a fresh Atlas Blueprint and ensure changes are there and the version is correct. |
There was a problem hiding this comment.
Suggested change
| 4. Launch a fresh Atlas Blueprint and ensure changes are there and the version is correct. | |
| 4. In the User Portal (production), create a new Atlas App using the Shopify Blueprint and verify if changes are there and the version is correct. |
README.md
Outdated
| 2. Make sure develop has all the changes that are intended to be in the release | ||
| 3. Merge `develop` into the `main` branch | ||
| 4. Launch a fresh Atlas Blueprint and ensure changes are there and the version is correct. | ||
| 5. Create a new release in Github with the tag as the latest version with `main` as the target. (For description you can use the `generate release notes` button) |
There was a problem hiding this comment.
Suggested change
| 5. Create a new release in Github with the tag as the latest version with `main` as the target. (For description you can use the `generate release notes` button) | |
| 5. Create a new release in Github with the tag as the latest version with `main` as the target. (For description you can use the `generate release notes` button) | |
| 6. Post a message to [#team-pe-titan-public](https://wpengine.slack.com/archives/C04SJP4UBB7) using the following template: | |
| > 🚀 Atlas Shopify Blueprint - Version X.Y.Z 🚀 | |
| > We have released a new version of the blueprint. <Short sentences summarising the changes added>. For more details, follow this link: https://github.com/wpengine/atlas-shopify-blueprint/releases/tag/X.Y.Z |
alvarocavalcanti
approved these changes
Sep 8, 2023
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description