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

add npm update step to release process #22

Open
wants to merge 5 commits into
base: trunk
Choose a base branch
from

Conversation

jeffpaul
Copy link
Member

@jeffpaul jeffpaul commented Jul 6, 2022

This follows from the plugin-specific change in 10up/insert-special-characters#155 and applies it to our org-wide default CONTRIBUTING.md file for use in all projects.

@jeffpaul jeffpaul requested a review from dkotter July 6, 2022 17:18
@jeffpaul jeffpaul self-assigned this Jul 6, 2022
@jeffpaul
Copy link
Member Author

jeffpaul commented Jul 6, 2022

@dkotter assuming you're good with this here, I'll open PRs across the other repos to add this step in the release process (and then just merge each of those in without additional review) so please comment here to note whether you're ok with this applying across repos or if you'd like specific reviews in those repos as well.

@dkotter
Copy link
Collaborator

dkotter commented Jul 7, 2022

I mentioned this in the 10up/insert-special-characters#155 but my only concern here is sometimes running an npm update can bring in updates that have breaking changes (we've seen this a few times with composer update but I would assume a similar thing could happen with npm).

I'm okay with having this as part of our release process but may also be worth adding a step (or adding on to this new step) some instructions around testing, especially anything that uses those dependencies (building assets for instance).

@jeffpaul
Copy link
Member Author

Let's sort out how to handle within the ISC PR and I'll update here for a broad 10up approach afterwards.

@dkotter
Copy link
Collaborator

dkotter commented Jul 12, 2022

I'm okay with this change, though I'm not seeing an actual test step in our instructions right now. I know some of our plugins have that and some don't, I'd recommend we add that to our standard process here which will hopefully catch any issues that may crop up from running an npm update

@jeffpaul
Copy link
Member Author

Merged in trunk changes that had the newly-added test step, back to you @dkotter for review.

13. Check WordPress.org: Ensure that the changes are live on https://wordpress.org/plugins/plugin-name/. This may take a few minutes.
14. Close milestone: Edit the [X.Y.Z milestone](/milestone/#) with release date (in the `Due date (optional)` field) and link to GitHub release (in the `Description` field), then close the milestone.
15. Punt incomplete items: If any open issues or PRs which were milestoned for `X.Y.Z` do not make it into the release, update their milestone to `X.Y.Z+1`, `X.Y+1.0`, `X+1.0.0` or `Future Release`.
2. Version bump: Bump the version number in `package.json`, `package-lock.json`, `plugin.php`, `readme.txt`, and any other relevant files if it does not already reflect the version being released.
Copy link
Collaborator

Choose a reason for hiding this comment

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

So minor thing but we don't actually need to manually change the version number in package-lock.json if we are going to run an npm update in the next step, as that will bump that version for us

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm thinking that perhaps we remove the npm update step as there could be a LOT of changes coming in there that require a bit more testing than would likely happen in the Test step later on and worst case scenario could introduce something that holds up the release. I do, though, like the idea of trying to ensure we bump dependencies on some sort of regular basis but haven't figured out a better, reliable way to do that (though perhaps a GH Action that fires ~monthly/quarterly and opens a PR with the results of running npm update?).

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
jeffpaul and others added 3 commits January 27, 2023 11:47
Co-authored-by: Darin Kotter <[email protected]>
Co-authored-by: Darin Kotter <[email protected]>
Co-authored-by: Darin Kotter <[email protected]>
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