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.

Sign up for GitHub

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

Jump to bottom

docs: fix typo and add alt download instructions #2281

Merged
merged 2 commits into from
Mar 16, 2023
Merged

docs: fix typo and add alt download instructions #2281

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5b64834
docs: fix typo and add alt downlowd instructions
gidjin Mar 4, 2023
d7d62d6
Merge branch 'main' into gidjin/update-release-docs
rogeruiz Mar 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 23 additions & 14 deletions docs/releasing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,25 +48,34 @@ Steps for a new release (these are in the process of being automated):
- PR should have the github label [type: release](https://github.com/trussworks/react-uswds/issues?q=label%3A%22type%3A+release%22+).
- Paste the the changelog generated by `standard-version` in the PR description/body.
- Ask for approvals from stakeholders, perform testing on applications, etc.
- It can be helpful to reviewers to provide a diff of all the files that have changed since the last release. To do this, add a compare link as a comment to the PR, or in the description/body:
`https://github.com/trussworks/react-uswds/compare/{previous.release.tag}...release-{new.version.number}`
- It can be helpful to reviewers to provide a diff of all the files that have changed since the last release. To do this, add a compare link as a comment to the PR, or in the description/body:
`https://github.com/trussworks/react-uswds/compare/{previous.release.tag}...release-{new.version.number}`

![image](./release_PR.png)

7. Once the release PR is approved and merged, complete the release by publishing the new version

- Create a [**new release**](https://github.com/trussworks/react-uswds/releases/new) on Github, pointed at the merge commit of the release PR.
- Set the tag to the version number.
- Title your release with the version number. Use the same release notes as the release PR.
- Point the release tag at the release merge commit by selecting `Recent Commits` from the `Target` dropdown in the Github UI. You should find the `chore(release): ...` commit at or near the top.
- Download the tarbell for the release from the Github Action workflow
- After merging the release PR, a [Github Actions workflow](../.github/workflows/package-release.yml) will build and package the release. You can find the action in the list by [filtering for `Package release` actions](https://github.com/trussworks/react-uswds/actions/workflows/package-release.yml?query=is%3Asuccess). From the bottom of the workflow run's summary page, there is an artifacts section [where the artifact can be downloaded](https://github.com/actions/upload-artifact#where-does-the-upload-go).
- The `.tgz` will be inside of the `artifact.zip`.
```
unzip artifact.zip
```
> :information_source: Archive Utility by default recursively unzips the `.tgz` file when unzipping the `artifact.zip`. If you wish to use Archive Utility instead of the terminal to unzip the artifact, disable "Keep expanding if possible" in the Archive Utility preferences.

- Create a [**new release**](https://github.com/trussworks/react-uswds/releases/new) on Github, pointed at the merge commit of the release PR.
- Set the tag to the version number.
- Title your release with the version number. Use the same release notes as the release PR.
- Point the release tag at the release merge commit by selecting `Recent Commits` from the `Target` dropdown in the Github UI. You should find the `chore(release): ...` commit at or near the top.
- Download the tarball for the release from the Github Action workflow

- After merging the release PR, a [Github Actions workflow](../.github/workflows/package-release.yml) will build and package the release. You can find the action in the list by [filtering for `Package release` actions](https://github.com/trussworks/react-uswds/actions/workflows/package-release.yml?query=is%3Asuccess). From the bottom of the workflow run's summary page, there is an artifacts section [where the artifact can be downloaded](https://github.com/actions/upload-artifact#where-does-the-upload-go).
- The `.tgz` will be inside of the `artifact.zip`.

```
unzip artifact.zip
```

> :information_source: Archive Utility by default recursively unzips the `.tgz` file when unzipping the `artifact.zip`. If you wish to use Archive Utility instead of the terminal to unzip the artifact, disable "Keep expanding if possible" in the Archive Utility preferences.

- Alternatively if you have the GitHub CLI tool you can grab the `runid` from the end of the workflow url you looked up and run the following to download the tarball.

```sh
gh run download <runid>
```

Comment on lines +73 to +78
Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for adding references to the official GH-CLI usage.

- [Publish](https://docs.npmjs.com/cli/v6/commands/npm-publish) the new package to npm
> :information_source: Publishing access is limited to package owners. If you need access and don't have it, please contact `@npm-admins` on Truss Slack.
```
Expand Down