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

ci(release_workspace): add additional checks and document workflow #1175

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

BethGriggs
Copy link
Collaborator

  • Refactored the workflow to infer the branch from the workspace name using the pattern workspace/${workspace}
  • Removed the unused branch input from the workflow
  • Added handling for missing GitHub events in release checks
  • Introduced logic to set npm publish tag (latest or maintenance)
  • Added initial plugin maintainer guide for patching older release lines

Hey, I just made a Pull Request!

✔️ Checklist

  • A changeset describing the change and affected packages. (more info)
  • Added or updated documentation
  • Tests for new functionality and regression tests for bug fixes
  • Screenshots attached (for UI changes)
  • All your commits have a Signed-off-by line in the message. (more info)

@BethGriggs BethGriggs requested a review from a team as a code owner September 4, 2024 23:21
@BethGriggs BethGriggs marked this pull request as draft September 5, 2024 10:49
@BethGriggs BethGriggs force-pushed the poc-multiple-releases-pt-2 branch 3 times, most recently from 19e754b to 9108c14 Compare September 5, 2024 11:15
- Introduced logic to verify the branch name is valid for the workspace
- Added handling for missing GitHub events in release checks
- Introduced logic to set npm publish tag (latest or maintenance)
- Added initial plugin maintainer guide for patching older release lines

Signed-off-by: Beth Griggs <[email protected]>
@BethGriggs BethGriggs marked this pull request as ready for review September 5, 2024 11:16
@BethGriggs BethGriggs changed the title ci(release_workspace): remove branch input and infer branch from workspace name ci(release_workspace): add additional checks and document workflow Sep 5, 2024
Copy link
Contributor

@awanlin awanlin left a comment

Choose a reason for hiding this comment

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

Thanks for running with this @BethGriggs, also for including docs, left two comments.

I don't know the release flow well, @benjdlambert any chance you can look at this one, please?


When patching an older release, follow the steps below to ensure the correct workflow is applied:

1. Request a `workspace/${workspace}` branch:
Copy link
Contributor

Choose a reason for hiding this comment

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

How does one request a branch?

- Apply the necessary patch fixes or security updates.
- Manually bump the version in `package.json` to reflect the new patch version (e.g., from `1.2.3` to `1.2.4`).

4. Run the release workflow:
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we highlight what access you need to be able to run the workflow? This could go in a section towards the top. Pretty sure you need to be an Org Member 🤔

@BethGriggs
Copy link
Collaborator Author

During the SIG today we discussed some various improvements and further prototyping needed here, I'll work on those

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.

2 participants