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 descriptions of steps that can run in parallel #268

Open
ekohl opened this issue Sep 6, 2023 · 3 comments
Open

Improve descriptions of steps that can run in parallel #268

ekohl opened this issue Sep 6, 2023 · 3 comments

Comments

@ekohl
Copy link
Member

ekohl commented Sep 6, 2023

We should do a better job of describing what can be done in parallel. Taking the Foreman release process (rendered at https://community.theforeman.org/t/foreman-3-8-0-rc1-release-process/34934) we list "Packaging a release" and "Manual updates". You can do all of the manual updates work in pull requests while the release is being packaged. Once they have been released, you can merge the PRs.

You can see we do list "Submit this as a PR" but then don't completely follow through with listing "Merge manual update PRs" or similar.

I don't know exactly how we should document this. Perhaps there should be explicit instructions for hand over and wait for X to be completed?

For example:

# Tagging a release

## Release owner

...
- [ ] Signal release engineer @X to proceed with signing tarballs

Now proceed with Manual updates

## Release engineer

....
@ianballou
Copy link
Contributor

For parallel items done by a single person, I think all we need are phrases like you have there: "Now proceed with X while waiting for Z".

If the items can be done in parallel for the release owner and the release engineer, then perhaps the lack of a message saying to "signal the release engineer" would be enough to imply that the step can be done in parallel.

@ekohl
Copy link
Member Author

ekohl commented Sep 6, 2023

For parallel items done by a single person, I think all we need are phrases like you have there: "Now proceed with X while waiting for Z".

I'd prefer this, or some variation. I've also done the Foreman release by myself and then I also ran into this. Knowing I could work on the release notes while packaging was building was an implicit thing for me, but for others it can be explicit.

@Griffin-Sullivan
Copy link
Contributor

You could just add lines where you need to hand off like Signal release engineer to do X. Then you know if that comment isn't there, you can keep going down the list of items.

Also could have Wait for release engineer/owner to do X before continuing.

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

No branches or pull requests

3 participants