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

Improve release documentation #5674

Open
1 task
domoscargin opened this issue Jan 31, 2025 · 0 comments
Open
1 task

Improve release documentation #5674

domoscargin opened this issue Jan 31, 2025 · 0 comments
Labels
github_actions Pull requests that update GitHub Actions code small story

Comments

@domoscargin
Copy link
Contributor

domoscargin commented Jan 31, 2025

What

There are some things we've identified in our test runs that need updating in the docs:

  • Make it clearer that a second developer should review the build release PR - not just the person who triggers the workflow
  • Add a note to say that if a workflow fails, it's OK to fix the issue then re-run the workflow - and not to move to the next step until the current step is successful
  • Remind folks to refresh the GitHub Actions workflow page, because GitHub does not refresh when you run a new workflow_dispatch workflow
  • Remind folks to refresh npm if they don't see the published release there once the Action is complete

Why

To help future devs who make releases

Who needs to work on this

Developers

Who needs to review this

Developer, Technical writer/Content designer

Done when

  • Documentation has been updated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
github_actions Pull requests that update GitHub Actions code small story
Projects
Status: Backlog 🏃🏼‍♀️
Development

No branches or pull requests

1 participant