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

New release? #465

Closed
nirvdrum opened this issue Sep 27, 2019 · 19 comments
Closed

New release? #465

nirvdrum opened this issue Sep 27, 2019 · 19 comments
Milestone

Comments

@nirvdrum
Copy link

Is there anything I can do to help get a new release out the door? I'd like to get the change that drops the ruby_dep dependency, which was merged in over a year ago. Since it's still a dependency, it's printing out false negatives about the level of support for my Ruby interpreter of choice (TruffleRuby).

As an open source maintainer myself, I realize that asking for a new release can be a touchy subject and is a thankless task. So, I sincerely apologize if I've approached a sensitive topic. I also don't like volunteering anyone else's time, so if there's some sort of release qualification testing you need done, please just let me know.

@rymai
Copy link
Member

rymai commented Sep 28, 2019 via email

@ioquatix
Copy link
Member

If you add me as a maintainer of the org I can help with this. but you'd also need to add me as a gem owner.

@rymai
Copy link
Member

rymai commented Oct 1, 2019

If you add me as a maintainer of the org I can help with this.

@ioquatix Done!

but you'd also need to add me as a gem owner.

and done! ❤️

@ioquatix ioquatix added this to the v3.2.0 milestone Oct 1, 2019
@ioquatix
Copy link
Member

ioquatix commented Oct 1, 2019

Done.

@ioquatix ioquatix closed this as completed Oct 1, 2019
@mattbrictson
Copy link
Contributor

Could we get release notes for 3.2.0? 🙏
https://github.com/guard/listen/releases

@ioquatix
Copy link
Member

ioquatix commented Oct 2, 2019

Do you want to write it?

@ioquatix
Copy link
Member

ioquatix commented Oct 2, 2019

The best place to start would be to look through the git commit history... I only checked briefly and confirmed all specs passing do this release.

@mattbrictson
Copy link
Contributor

The reason I asked is because I believe it is important when publishing a release to rubygems that the release is always accompanied by a set of release notes. If the notes are absent it can give the impression that code is being pushed that the publishers don't understand or hasn't been thoroughly reviewed, which seems dangerous in light of recent gem malware discoveries.

To be honest I do not feel comfortable writing the release notes myself since I am not a contributor and have no context as to the project's history or how the code is works. Are there no maintainers left that can do it? If not then I will give it a shot.

@ioquatix
Copy link
Member

ioquatix commented Oct 2, 2019

I did review the code thoroughly but the best source of why changes occurred right now is git diff and git log. If users who made commits or PRs didn’t update change log and it’s important we should ensure all such merge has it going forward. Open to ideas about best policy for this.

@mattbrictson
Copy link
Contributor

I've tried a couple different approaches.

One option is to have a CHANGELOG file that is updated with each PR. Before merging, each PR has to include an update to the CHANGELOG. I have used Danger (a GitHub bot) to automatically enforce this so that maintainers don't have to pester contributors about it. The problems with this approach are:

  1. Contributors always forget to do it (hence the Danger bot to remind them)
  2. The CHANGELOG always has merge conflicts because every PR is touching the same part of the same file

In short, it adds friction to the PR process. Also for listen in particular, the CHANGELOG isn't even maintained anymore; it is a blank file that points to the GitHub Releases page. So this approach doesn't really fit the style of the project.

The second option that I am using in my projects these days is using GitHub Actions and release-drafter. This updates the GitHub Release Notes whenever a PR is merged; it automatically adds a bullet point to the release with the PR title, PR number, and author. It can even group the release notes by section based on PR labels. Then when you publish a release you can use the automated draft as-is, or do any manual tweaks as needed.

I'd be happy to set that up if you are interested in the latter approach. Here's how we set it up on capistrano: capistrano/capistrano#2034

@ioquatix
Copy link
Member

ioquatix commented Oct 3, 2019

The 2nd approach you propose makes total sense. Happy to have you do it. Let me see if I can give you access...

@ioquatix
Copy link
Member

ioquatix commented Oct 3, 2019

@rymai would have to give you access, I'm not an admin.

@ioquatix
Copy link
Member

ioquatix commented Oct 3, 2019

Can you make a PR?

@mattbrictson
Copy link
Contributor

Yes, I'll make a PR this week.

The owner of the guard GitHub organization will need to sign up for the GitHub Actions beta. Are you able to do that?

https://github.com/features/actions/signup

@ioquatix
Copy link
Member

ioquatix commented Oct 3, 2019

Nope back to @rymai

@rymai
Copy link
Member

rymai commented Oct 3, 2019

The owner of the guard GitHub organization will need to sign up for the GitHub Actions beta.

@mattbrictson Done, thanks!

@mattbrictson
Copy link
Contributor

Sorry, haven't gotten to putting up a PR on this yet. Will try tomorrow.

@mattbrictson
Copy link
Contributor

PR: #466

@eregon
Copy link

eregon commented Nov 24, 2019

@ioquatix @rymai @mattbrictson Thank you all for the release!

For the record, these are the (incorrect) warnings shown by ruby_dep:

$ bundle exec rails s
RubyDep: WARNING: Your Ruby may not be supported.
RubyDep: WARNING: Your Ruby is: 2.6.2 'truffleruby' (unrecognized). If you need this version supported, please open an issue at http://github.com/e2/ruby_dep
RubyDep: WARNING: (To disable warnings, see:http://github.com/e2/ruby_dep/wiki/Disabling-warnings )

And the maintainer of ruby_dep seems unresponsive (e2/ruby_dep#37), so I'm happy listendropped that dependency.

I made a PR to update listen in Rails: rails/rails#37788

eregon added a commit to eregon/rails that referenced this issue Nov 24, 2019
* https://github.com/guard/listen/releases/tag/v3.2.0
* guard/listen#465
* `listen` removed the unmaintained `ruby_dep` dependency, which
  incorrectly shows warnings when running on TruffleRuby.
eregon added a commit to eregon/rails that referenced this issue Mar 7, 2020
* Backport of rails#37788 to 6.0-stable
* https://github.com/guard/listen/releases/tag/v3.2.0
* guard/listen#465
* `listen` removed the unmaintained `ruby_dep` dependency, which
  incorrectly shows warnings when running on TruffleRuby.
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

5 participants