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

maintenance: plans for a new release + suggestions #2125

Closed
pano9000 opened this issue Dec 8, 2022 · 24 comments
Closed

maintenance: plans for a new release + suggestions #2125

pano9000 opened this issue Dec 8, 2022 · 24 comments
Assignees

Comments

@pano9000
Copy link
Contributor

pano9000 commented Dec 8, 2022

Hi all,

I wonder if there currently is any "path" towards the next release?
It has been a year since the last release, and I don't seem to see any path towards a new release, but an ever growing backlog of PRs of small to big size, some of which will bring a lot of improvements, but are currently a bit a pain to be merged, e.g. the effort to split the tests into separate files, or the effort to introduce an "options" object to different validators.

So my suggestion going forward would be:

  1. Focus first on getting a new release ready of what we already have in master + maybe check the open PRs for some of the easy/simple "fixes" and get these in as well - this will include fixing "blocking" issues like Dependency Issue: Installation via npm fails #2123

  2. Afterwards identify the "easy" "feat" and "refactor" PRs, e.g. the mostly the ones that add features to existing validators (e.g. I can see a ton of isMobilePhone PRs) - afterwards do another release

  3. Work on getting these "bigger" PRs in

Pinging the current maintainers, what do you think?
@profnandaa, @tux-tn, @rubiin, @ezkemboi

If you need any help, with that, kindly let me know, happy to help here as much as I can.

@ezkemboi
Copy link
Member

ezkemboi commented Dec 8, 2022 via email

@WikiRik
Copy link
Member

WikiRik commented Dec 8, 2022

Sounds like a good plan. I'm also happy to help with initial reviews and identifying in which categories PRs fall. I think that @braaar is also willing to help and maybe @pixelbucket-dev as well (although I believe he is more interested in working on #1874 and other issues coming out of that)

@braaar
Copy link
Contributor

braaar commented Dec 12, 2022

I'm happy to help out.

I agree that it's important to get an overview of what we want to include in releases. I think we've had a pretty tight focus on backwards compatibility recently, so we can definitely do a minor version release with a lot of new features and fixes before considering a major release.

To me it seems like commit messages are a bit of a wild west right now, which must make it a bit harder to put together release notes. Maybe we could use a github action to enforce PR titles/commit messages, like this

@WikiRik
Copy link
Member

WikiRik commented Dec 12, 2022

I agree that it's important to get an overview of what we want to include in releases. I think we've had a pretty tight focus on backwards compatibility recently, so we can definitely do a minor version release with a lot of new features and fixes before considering a major release.

Recently yes, but there have been quite some PRs merged over the last year so it might be safer to just do a major release. But that's also something to consider when making the CHANGELOG

@pixelbucket-dev
Copy link
Contributor

pixelbucket-dev commented Dec 12, 2022

I'm happy to help out.

I agree that it's important to get an overview of what we want to include in releases. I think we've had a pretty tight focus on backwards compatibility recently, so we can definitely do a minor version release with a lot of new features and fixes before considering a major release.

To me it seems like commit messages are a bit of a wild west right now, which must make it a bit harder to put together release notes. Maybe we could use a github action to enforce PR titles/commit messages, like this

I agree here, for release note management we could consider squash and merge to have predictable merge commits.

@pixelbucket-dev
Copy link
Contributor

Sounds like a good plan. I'm also happy to help with initial reviews and identifying in which categories PRs fall. I think that @braaar is also willing to help and maybe @pixelbucket-dev as well (although I believe he is more interested in working on #1874 and other issues coming out of that)

Yes, in general I am happy to help. However, I am quite new to the project, so I don't have the historic overview (yet) to judge all of the above. Let me know if I can assist in something specific, e.g. review or category identification :).

@profnandaa
Copy link
Member

Apologies, I've been quite slow on my end in following up with the reviews but I should be getting back to form now.

Yes, reviews are highly welcome! It makes the maintainers work easier, knowing that a couple of more eyes have had a look at the PRs. So, I covet your help here @WikiRik @braaar @pixelbucket-dev and anyone else.

That said, we should be able to get out a release by mid Jan 2023. Will be nice to have the holiday season remain quiet.

Thanks for your suggestions @pano9000, we'll take that to account.

/cc. @tux-tn @ezkemboi

@profnandaa
Copy link
Member

NB: while reviewing, those with merge conflicts on README.md, the authors don't need to change anything, I will fix those during merging and still retain the contribution credits for the authors.

@pano9000
Copy link
Contributor Author

Hi all,

just wanted to cautiously ask about any update on this topic?
How can we help you guys?

@profnandaa
Copy link
Member

We should do a release by end of next week. I'll just pick whatever will be ready by then; then the subsequent PRs can follow for the next release, scheduling for March 2023.

Any help on the reviews will still be appreciated.

@rubiin
Copy link
Member

rubiin commented Jan 21, 2023

I have updates around 10-20 prs with labels. All prs with LGTM label are good to go. As we are getting lots of prs , i think we should schedule a biweekly release policy so all the dependent projects won't be stuck . Also this will motivate the contributors for more contribution

@rubiin rubiin pinned this issue Jan 23, 2023
@profnandaa
Copy link
Member

I'm ready to make the first release now. Thanks so much @pano9000 for the great work on the PRs and also helping review + triages!

Quick one, could you fix the merge conflicts on your PRs only - https://github.com/validatorjs/validator.js/issues?q=is%3Aopen+label%3Amc-to-land+author%3Apano9000 will love to add those in the release. And then I will handle the remaining ones as I do the release.

@pano9000
Copy link
Contributor Author

@profnandaa thanks, I am on it, and should done at the latest by tomorrow afternoon (CET)

@pano9000
Copy link
Contributor Author

other smaller PR that could be a potential candidate for merging:
#2085
(although I think the regexp here could be simplified quite a bit)

@profnandaa
Copy link
Member

@pano9000 -- thanks! I think we are good to go now. I'll work ont he remaining mc-to-land's and stage the release tomorrow.
Will look forward to your sign-offs once I do that. Will /cc you. @rubiin @tux-tn @ezkemboi @daisyndungu

@profnandaa
Copy link
Member

This coming release is going to be a HUGE one! I want to be very careful not to mess up anything. I will really appreciate if you folks can help skim over the previous commits just to make sure there's nothing wrong that slipped our previous reviews. Here is the prep PR - #2166

I'm yet to complete on about 5 clean-ups and then prep the release notes.

/cc. @pano9000 @tux-tn @rubiin @ezkemboi @daisyndungu

@profnandaa profnandaa changed the title Path Forwards: Any plans for a new release + suggestion maintenance: plans for a new release + suggestions Jan 31, 2023
@pano9000
Copy link
Contributor Author

@profnandaa thanks, I will take a look at it tonight and report back.

@profnandaa
Copy link
Member

UPDATE: almost done with the clean-ups, 2 more PRs to go - #2164 // https://github.com/validatorjs/validator.js/pulls?q=is%3Apr+is%3Aopen+label%3Amc-to-land

@profnandaa
Copy link
Member

Pushing by 1 more day.

@pano9000
Copy link
Contributor Author

I just checked, and from what I can tell, it looks good to me

@profnandaa
Copy link
Member

Finally releasing today evening, release notes now ready!

@profnandaa
Copy link
Member

#2166

@profnandaa
Copy link
Member

We did it, thanks folks! 🎉
npm: https://www.npmjs.com/package/validator/v/13.9.0
github: https://github.com/validatorjs/validator.js/releases/tag/13.9.0

@profnandaa profnandaa unpinned this issue Feb 2, 2023
@pano9000
Copy link
Contributor Author

pano9000 commented Feb 3, 2023

@ALL congrats on the new release! :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

7 participants