Release 3.0.0

[p8]

@zzak Can we release 3.0.0?
There are still some milestone issues but I think main has enough changes to warrant a new release.
This would also allow us to find possible issues on https://edgeapi.rubyonrails.org/

[zzak]

We should make sure the latest code doesn't break Rails documentation pipeline, last time I checked there was some incompatibilities.

[p8]

@zzak Do you have any links to those incompatiblities? Are these visible when creating a PR in Rails with a new version?

[jonathanhefner]

There are some more changes I would like to include in 3.0.0, so my vote would be to wait a few more weeks.

But what is stopping us from pointing https://edgeapi.rubyonrails.org/ at sdoc main?

[p8]

@jonathanhefner Good idea. I've created: rails/rails#48904

[p8]

Edge is now running main. It doesn't seem to get updated though.
Probably because of the Rails documentation pipeline.
I'm not seeing any errors I can pick up.

[zzak]

Found this in the rails docs server logs:

[2023-08-10 23:05:05 UTC]  rvm 2.7.6 do bundle install --without db test job cable storage ujs >/dev/null
[DEPRECATED] The `--without` flag is deprecated because it relies on being remembered across bundler invocations, which bundler will no longer do in future versions. Instead please use `
bundle config set --local without 'db test job cable storage ujs'`, and stop using this flag
[2023-08-10 23:05:19 UTC] EDGE="1" ALL="1" rvm 2.7.6 do bundle exec rake rdoc >/dev/null
/home/rails/.rvm/gems/ruby-2.7.6/gems/bundler-2.3.22/lib/bundler/source/git/git_proxy.rb:224:in `allowed_with_path': The git source https://github.com/rails/sdoc.git is not yet checked o
ut. Please run `bundle install` before trying to start your application (Bundler::GitError)

[jonathanhefner]

I noticed that the Rails 7.1 API documentation was released using main @ 947abf9, which is missing several recent improvements. So coming back to this, how does everyone feel about a 3.0.0 release? Are there still outstanding issues?

Personally, there are a few improvements I would like to make in the future, but I feel like we are at a good spot for a release. Though I would like to get some opinions on #325, and possibly include that.

[zzak]

I would like to catch up with @AmandaPerino to make sure we're on the same page before cutting a major release, now that RailsWorld is over hopefully there will be more cycles to focus on this stuff.

[jonathanhefner]

Sounds good. That being the case, I've updated the ref in Rails main so that https://edgeapi.rubyonrails.org/ now reflects what we have in SDoc main.

[Earlopain]

I was looking at docs and noticed some codeblocks are highlighted in a wrong way, specifically around erb. https://api.rubyonrails.org/v7.2.1.2/classes/ActionView/Helpers/FormHelper.html#method-i-form_with for example is interpreted as xml.

Checking out the repo, I see this is already solved by switching to rogue and edgeguides look pretty good in that regard. It's much more colorful (ruby code has more highlighting), and seems to do a better job at choosing the right language. It would be nice to see this in released api docs some time 😉

[zzak]

Sorry, I don't want this issue to become a thread to discuss changes we want to see in the next iteration of the API docs, so going to close it.

When the time and place is right, let's get feedback and ideas then.