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

Github projects not updating / making rebuilding docs easier #25

Closed
mloughran opened this issue Feb 18, 2011 · 6 comments
Closed

Github projects not updating / making rebuilding docs easier #25

mloughran opened this issue Feb 18, 2011 · 6 comments

Comments

@mloughran
Copy link

About 12 hours ago I pushed an update to https://github.com/newbamboo/pusher-gem which has a service hook to update http://rubydoc.info/github/newbamboo/pusher-gem/master/frames. However the docs haven't been updated. I assume something has gone wrong?

It would be great if the process was more transparent. What about sending an email when the docs have built / adding github single sign on so I can view my gems / add a link to rebuild docs on demand? Or, crazy talk, adding real time updates of newly built gems using Pusher?!

Service looks great by the way - first time I've taken a look since rdoc.info days - and mighty impressed with yard :) Cheers! Martyn

@lsegal
Copy link
Collaborator

lsegal commented Feb 18, 2011

On the Pusher::Channel class:

Generated on Fri Feb 18 09:20:03 2011 by yard 0.6.4 (ruby-1.9.1).

And it includes the Private Channels docs change you've made in your very last commit, so it seems up to date to me, and has been roughly since you reported. Are you sure it's not updating properly?

@mloughran
Copy link
Author

Thanks for looking at it - it certainly is correct now but it seemed to generate shortly after I posted the issue, quite a long time after pushing to github! Any thoughts on making the process more transparent? Thanks!

@lsegal
Copy link
Collaborator

lsegal commented Feb 20, 2011

Whenever the hook is run, we run a git pull and clear the cache. We don't actually re-generate the html until it is requested. Of course, you should only see the page after
it is re-generated / requested.

What do you mean by more transparent? I'm not too sure about sending emails, since we don't collect emails at any point in the process, and I'm not sure it would make sense to add that. In general, the page should be re-generated (and/or prepared) as soon as you're redirected, so there's no real notification step that's necessary. There's a single edge case for updating existing repos where they can be accessed before the git pull / reprocess finishes. However, we should probably fix these cases to ensure that the user request blocks until this process is finished (and shows a "please wait while we rebuild the project" page similar to the initial build). In that sense, I'd rather improve our existing system than add new notification functionality.

@mloughran
Copy link
Author

Sounds like I might just have hit a glitch. Notifications are rather unnecessary if the process is designed to basically be instant to all intents and purposes I agree. (I was thinking you could get the email out of the commit). It's probably worth putting a lock around that race condition though. I'll let you know if I see anything else fishy!

@mpapis
Copy link

mpapis commented Dec 9, 2013

I hit the same problem https://github.com/rvm/gem-wrappers - http://rubydoc.info/gems/gem-wrappers/frames it feels like the docs are one commit behind, and not only for this project I got this very often on multiple gems I develop

@lsegal
Copy link
Collaborator

lsegal commented Dec 9, 2013

@mpapis It looks mostly like a caching issue with the frames page. Hitting the normal pages loads up 0.7.1. I can look at this. I've invalidated the cache for your gem in the meantime. Let me know what other projects are broken for you.

Going to close this issue since it's extremely old and probably no longer applicable. Feel free to open new issues or post to https://rubydoc.tenderapp.com/ for support there.

@lsegal lsegal closed this as completed Dec 9, 2013
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

3 participants