Skip to content

Be able to generate doc for rspec-rails 4 #248

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

Merged
merged 3 commits into from
Apr 8, 2020
Merged

Conversation

benoittgt
Copy link
Member

@benoittgt benoittgt commented Apr 8, 2020

With this PR:

  • Generate documentation for every last release when they are available. It means we can generate documentation for rspec-rails 4 with this code without generating other gems at the moment.
  • Fix a bug by not choosing beta or release candidate version like v4.0.0.rc1
  • Handle major branch change with various Gemfile variations. Avoid error like:

Capture d’écran 2020-04-08 à 17 51 45


For example with:

$ bundle exec rake "update_docs[4.0, 4-0-maintenance]"

We only have rspec-rails with a v4.0.0 version at the moment, so the command will generate documentation only for rspec-rails 4.0 documentation, other rspec gem will be skipped.

If we run:

$ bundle exec rake "update_docs[3.9, 3-9-maintenance]"

Every last 3.x release version of documented rspec gems will have their
documentation re-generated.

My main problem is, it not super clear from outside what the command does. Also the command link again rspec-rails to other gems in a certain way.

For exemple with:
```sh
$ bundle exec rake "update_docs[4.0, 4-0-maintenance]"
```

We only have rspec-rails with a v4.0.0 version at the moment, so the
command will generate documentation only for `rspec-rails` 4.0
documentation, other rspec gem will be skipped.

If we run:
```sh
$ bundle exec rake "update_docs[3.9, 3-9-maintenance]"
```

Every last 3.x release version of documented rspec gems will have their
documentation re-generated.
@JonRowe
Copy link
Member

JonRowe commented Apr 8, 2020

What about making it so it requires a gem name? Then adding an update_all_core_docs that just loops over our existing core gems?

@benoittgt
Copy link
Member Author

Good idea @JonRowe. I mark this as a To Do for a new PR. It will need some refactoring to be able to use it on other command too.

@benoittgt benoittgt merged commit d2a3a49 into master Apr 8, 2020
@benoittgt benoittgt deleted the avoid-picking-beta branch April 8, 2020 20:33
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