rspec_api_documentation icon indicating copy to clipboard operation
rspec_api_documentation copied to clipboard

Maintenance status

Open artofhuman opened this issue 5 years ago • 23 comments

Hi, ✋

Firstly, thanks for the great lib. This helps us to build our documentation. Second. Can you explain what the status of this project, we have some issues and any change to our patches will be reviewed and merged? (As I see now project not maintained and have 22 opened PRs )

For example, we have an issue

/usr/local/bundle/bundler/gems/rspec_api_documentation-81e5c563ce67/lib/rspec_api_documentation/example.rb:71:in `remap_headers': undefined method `each' for nil:NilClass (NoMethodError)

If this project needs help in maintenance pls text me. Thanks.

artofhuman avatar Sep 04 '20 13:09 artofhuman

I have been using this project for almost a year, but now we have chosen to switch to rswag instead because of the missing progress and we want the support for OpenApi 3.0

lauer avatar Sep 08 '20 06:09 lauer

Hey All.

I am going to spend some time cleaning up existing issues, and merging ready to go PRs where it makes sense. Long term for this project to be sustainable regarding format support we'd need to add some contributors who use each particular format.

@artofhuman do you have a specific issue open for the problem you are running into?

jakehow avatar Sep 10 '20 21:09 jakehow

Hi, @jakehow. Thanks for you attend. Can you look at this issue? https://github.com/zipmark/rspec_api_documentation/issues/456.

artofhuman avatar Sep 16 '20 21:09 artofhuman

@oestrich got me access to make gem releases also, please let me know if anyone has other items they'd like to get into a public release. #456 should be resolved but I will wait confirmation and then start to plan for that

Thanks @davidstosik for bumping this again.

jakehow avatar Oct 02 '20 02:10 jakehow

Hey, @jakehow is good to hear that, I was wondering when the next version of the gem will come out? thanks for maintaining this!

JuannFerrari avatar Oct 05 '20 15:10 JuannFerrari

@JuannFerrari I think resolution of #456 probably deserves a release. Just want to get as many eyes on it as possible before doing so, and see if there is anything else we want to knock off.

jakehow avatar Oct 05 '20 17:10 jakehow

Hey @jakehow, I haven't given a try to the new master yet, on a real project. I'll try to do so later today and report if I find any problem.

davidstosik avatar Oct 06 '20 05:10 davidstosik

@jakehow Hi, Thanks. We currently use the latest master's in our project. So far, no problems have been seen.

artofhuman avatar Oct 06 '20 07:10 artofhuman

@jakehow I just confirmed that the latest master rspec_api_documentation still generates our documentation properly. 👌

(Please take a look at this when you have a moment. 🙏 )

davidstosik avatar Oct 06 '20 10:10 davidstosik

@davidstosik Is it support with the newest Ruby and Rails?

helmiItsavirus avatar Apr 27 '21 03:04 helmiItsavirus

@davidstosik Is it support with the newest Ruby and Rails?

You're best off creating a new issue for unrelated questions to the original poster.

PhilT avatar Apr 30 '21 12:04 PhilT

All I can say is that the master branch runs correctly on Rails 6.0 and Ruby 2.6, but I would be really worried to start using this gem in a new project today, as there is no guarantee that it'll keep working if there is no update concerning its maintenance status... 🤔

davidstosik avatar May 10 '21 02:05 davidstosik

@davidstosik what you mean? I think you should move to Rswag if needed. It supports the latest ruby and rails version as well, so you don't need to make a mess here LOL.

This gem is pretty simple and easy to use to Rswag. I'm waiting for the update as well and I hope the maintainer will continue the update.

helmiItsavirus avatar May 10 '21 04:05 helmiItsavirus

@davidstosik I can make a release of master, as I think it's just that bug fix, will check. As far as 6.1 I think first step would be to open a PR and add it to the TravisCI matrix and see what happens.

jakehow avatar May 10 '21 14:05 jakehow

@jakehow Nice dude! Keep going

helmiItsavirus avatar May 18 '21 12:05 helmiItsavirus

@jakehow any news regarding a new release? Landed here after following the trace of https://github.com/zipmark/rspec_api_documentation/issues/456

vizcay avatar Nov 26 '21 21:11 vizcay

Any updates?

kzaitsev avatar Feb 17 '22 11:02 kzaitsev

Maybe it will be better to move (or fork) this gem to another organization and add active maintainers?

artofhuman avatar Aug 16 '22 11:08 artofhuman

@artofhuman are you offering to become a contributor?

jakehow avatar Aug 16 '22 17:08 jakehow

I think yes

artofhuman avatar Aug 20 '22 11:08 artofhuman

I'd like to help. It works fine for us and we're invested (see my issues and prs). Github and/or RubyGems

bf4 avatar Jun 26 '23 06:06 bf4

@jakehow I would like to be a contributor to this gem.

apotema avatar Dec 01 '23 18:12 apotema

I setup GitHub actions to run tests and have been trying to get them passing again. See https://github.com/zipmark/rspec_api_documentation/pull/530 I'm open to help here since I have limited time for this myself, as well.

bf4 avatar Apr 25 '24 19:04 bf4