Home → Problems →

Problem with branches or repo config

• Edit

ben

09 Oct, 2019 10:21 PM

We're having an unusual problem with our rubydocs for our library recurly-client-ruby:

https://www.rubydoc.info/find/github?q=recurly-client-ruby

I'm noticing there is a message "no master fork"

What is there also appears to not be respecting our .yardopts file: https://github.com/recurly/recurly-client-ruby/blob/master/.yardopts

We do have a webhook setup which appears to be working.

Everything was working fine until recently. Is there any work you can do on your end to clean it up?

1. Support Staff 1 Posted by lsegal on 09 Oct, 2019 10:37 PM

   

   Fixed on our end thanks for reporting this!

   • Edit

2. Support Staff 2 Posted by lsegal on 09 Oct, 2019 10:38 PM

   

   NB: There may be some search caching still in play, but if you visit via the index or search another query you should see the correct result.

   • Edit

3. 3 Posted by Ben on 09 Oct, 2019 10:54 PM

   

   Thanks for the quick response!

   The search results no longer showing "no master branch" when i search a new term:
   https://www.rubydoc.info/find/github?q=recurl

   I am curious about how I can get it to respect your `.yardopts` though. We have a file GETTING_STARTED.md in the root of the project and our opts specify `--readme GETTING_STARTED.md`

   Is this correct? It works locally but does not seem pick it up in rubydocs: https://www.rubydoc.info/github/recurly/recurly-client-ruby

   • Edit

4. Support Staff 4 Posted by lsegal on 09 Oct, 2019 11:05 PM

   

   You should be able to resolve this with:

   --readme GETTING_STARTED.md
   - GETTING_STARTED.md
   

   The readme switch is a bit of an old one and there might be a bug on rubydoc.info not respecting it. If you mark the file as an "extra file" (any files listed after the -) it should keep the file around to serve it. You can see an example of this in https://github.com/lsegal/yard/blob/master/.yardopts

   • Edit

5. 5 Posted by Ben on 09 Oct, 2019 11:21 PM

   

   Interesting, but makes sense. I did try that but I'm still not seeing results: https://github.com/recurly/recurly-client-ruby/commit/a785d9da42b6a8da0dc7cee03487322905ef996a

   It does continue to work locally though. I'm running yard 0.9.20 locally

   • Edit

6. 6 Posted by Ben on 09 Oct, 2019 11:26 PM

   

   I noticed in this thread: https://rubydoc.tenderapp.com/discussions/problems/654-wrong-transl...

   you said

   Yes, the .yardopts must be packaged with the gem for rubydoc to pick it up for gem docs hosting.
   

   Could that be the issue? Do i need to add that to my gemspec?

   • Edit

7. 7 Posted by Ben on 09 Oct, 2019 11:29 PM

   

   the .yardopts file does appear to be in the resulting gem after running gem build recurly.gemspec

   • Edit

8. 8 Posted by Ben on 10 Oct, 2019 03:13 AM

   

   This is pretty strange, but I moved everything back to the README for now and removed the yardopts. and the README is still not showing up: https://www.rubydoc.info/github/recurly/recurly-client-ruby/

   • Edit

9. 9 Posted by Ben on 10 Oct, 2019 05:54 PM

   

   Kind of seems like the "No master fork" error is back too

   • Edit

10. Support Staff 10 Posted by lsegal on 10 Oct, 2019 08:37 PM

    

    So it looks like a couple of other projects have been dealing with this same issue. Still working on diagnosing the root issue but I've temporarily unblocked your project and you should now be seeing the README along with correct master fork info. This means that you should be able to apply your .yardopts settings to get the other extra files displaying.

    The problem may come back over the next day or two but rest assured we're investigating. I will keep this open and close when we've identified the root issue and are sure that this won't come back.

    Thanks again for reporting the issue!

    • Edit

11. 11 Posted by Ben on 10 Oct, 2019 09:35 PM

    

    Thanks! I'd love to move this getting started stuff back out of the main README though. It uses yard syntax so is kind of confusing when viewed from GitHub. Should I try to do that again, or should I wait? do you think the problem was with my library in particular or with some larger issue with yardopts?

    • Edit

12. Support Staff 12 Posted by lsegal on 10 Oct, 2019 10:04 PM

    

    You should be able to give it another shot and see what happens right now. The issue was with a larger problem in the rubydoc.info deployment pipeline.

    • Edit

13. 13 Posted by Ben on 10 Oct, 2019 10:25 PM

    

    It appears to be working now! The yardopts file is being respected: https://www.rubydoc.info/github/recurly/recurly-client-ruby/

    • Edit

14. 14 Posted by Ben on 30 Oct, 2019 10:28 PM

    

    Sorry to be a bother, but it's reverted back to the broken state: https://www.rubydoc.info/github/recurly/recurly-client-ruby/

    • Edit

15. 15 Posted by Ben on 06 Apr, 2020 08:49 PM

    

    This is continuing to be a problem for us: https://www.rubydoc.info/github/recurly/recurly-client-ruby/

    It's been going down again lately. Is there any state that we can reset? Maybe something in the database we can nuke and recreate?

    When searching for the repo i'm seeing ` (No master fork)` error as well.

    • Edit