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.

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

docs: Update releasing docs #2018

Merged
merged 6 commits into from
May 19, 2022
Merged

docs: Update releasing docs #2018

merged 6 commits into from
May 19, 2022

Conversation

brandonlenz
Copy link
Contributor

@brandonlenz brandonlenz commented Apr 22, 2022

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:

  • More friendly branching approach, IMO.
    • This method prevents standard-version commits to local main branch which could've caused confusion previously
  • Unify formatting
  • Use ℹ️ to identify Info sections that are not actually instructions
  • Add/Update some links for better hyperlinking directly to useful things

How 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.
image

- More friendly branching approach (prevents standard-version commits to local `main` branch)
- Unify formatting
- Use ℹ️ to identify Info sections
- Update some links
@brandonlenz brandonlenz requested a review from a user April 22, 2022 16:56
@brandonlenz brandonlenz self-assigned this Apr 22, 2022
@brandonlenz brandonlenz changed the title docs(release): Update releasing docs docs: Update releasing docs Apr 22, 2022
haworku
haworku previously approved these changes Apr 25, 2022
Copy link
Contributor

@haworku haworku left a comment

Choose a reason for hiding this comment

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

Nice ⭐ . Would like one of the folks new to the library or releasing to take a look as well.

docs/releasing.md Show resolved Hide resolved
docs/releasing.md Show resolved Hide resolved
docs/releasing.md Show resolved Hide resolved
Co-authored-by: haworku <haworku@users.noreply.github.com>
@brandonlenz
Copy link
Contributor Author

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:
image

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
Copy link
Contributor

@haworku haworku left a comment

Choose a reason for hiding this comment

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

This still looks good. Let's get this merged if there's no other feedback. I like the idea of adding discussions to releases particularly major releases we should definitely be doing this

@brandonlenz
Copy link
Contributor Author

brandonlenz commented May 17, 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!

@gidjin gidjin mentioned this pull request Jul 13, 2022
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants