docs: Update releasing docs #2018
Merged
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
- More friendly branching approach (prevents standard-version commits to local `main` branch) - Unify formatting - Use ℹ️ to identify Info sections - Update some links
brandonlenz
requested review from
suzubara,
gidjin,
haworku,
ahobson and
SirenaBorracha
as code owners
brandonlenz
changed the title
haworku
previously approved these changes
Apr 25, 2022
Co-authored-by: haworku <haworku@users.noreply.github.com>
|
One outstanding question is whether we would like to attach a discussion to releases as a matter of process? It's as simple as checking the following when creating a release: USWDS does this [example] which might help address issues/questions related to a release without referring people directly to creating github issues. |
- Github does not allow negations or multiple "is" criteria for action searches yet
…t-uswds into bl-update-releasing-docs
brandonlenz
commented
Apr 27, 2022
haworku
approved these changes
May 11, 2022
|
I created a discussion for 3.0.2 just to test that out. Also saw that someone created a Q&A discussion a while back and I didn't even notice! |
Merged
gidjin
added a commit
that referenced
this pull request
Jul 13, 2022
## [3.1.0](3.0.2...3.1.0) (2022-07-13) ### Features * Remove example app ([#2162](#2162)) ([1eb579e](1eb579e)) * USWDS 2.13.3 ([#2175](#2175)) ([fdeefc6](fdeefc6)) ### Bug Fixes * Danger contributors check ([#2167](#2167)) ([c05fe06](c05fe06)) * Emit headingLevel type and do not emit type declarations for tests ([#2134](#2134)) ([a4501dd](a4501dd)) * export SummaryBoxHeading and SummaryBoxContent ([#2100](#2100)) ([141ba8e](141ba8e)) ### Documentation & Examples * Callout outside contributors process ([#1969](#1969)) ([7881191](7881191)) * Update releasing docs ([#2018](#2018)) ([6849dda](6849dda))
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
Summary
I've been diverging from the actual instructions for a little while. I've also been showing others how to release, which can be confusing when recommend following the docs, but also recommend diverging in some places.
What I've updated:
mainbranch which could've caused confusion previouslyHow to test
Review the content however you prefer. I'm a fan of looking at the rich diff or just the rendered/previewed file as well when reviewing MD changes.
