-
Notifications
You must be signed in to change notification settings - Fork 5
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
[RFC] regarding committing docs and auto-updating documentation website #25
Comments
I've never generated artifacts like this using CI but it's a good idea (or hooks, if that's better). Would like to find a good way to do this. |
That issue is fixed in devel. |
great! will try to follow up on nim-lang/Nim#9155. |
btw, this would (obviously) be useful for all nimble projects out there so making this work would be awesome |
@timotheecour done! 🎉 Well, not done, but it works heh. There are definitely improvements to be made. Basically how it works is: untagged git commits do nothing extra on Travis and the tests are run as usual. A tagged commit however (which should be a new version) will trigger a custom Travis deploy script found in .travis_deploy_docs. It builds the docs and overwrites the Now I want to put in an index file that catalogs these versions and I think we'll be in good shape. |
after that I think it'd be worth adding a link to that technique to nim github repo in best practices (permanent, easy to search) or at least a forum entry so others are encouraged to do the same EDIT "Deploy devel build of docs to https://nim-lang.github.io/Nim" since nim-lang/Nim@308710c links
|
Aight, now it's pretty great. Check it out: https://citycide.github.io/glob/
|
perfect! |
I'm currently seeing docs/glob/regexer.html + other files
committing docs doesn't seem good since these are autogenerated
(see https://blog.kentcdodds.com/why-i-don-t-commit-generated-files-to-master-a4d76382564 for eg)
https://citycide.github.io/glob/ should reflect latest docs (or at least have an option to show latest docs, eg via url, eg:
implementation
I'm curious whether .travis.yml or .appveyor.yml be used for that purpose? (since these are run after each PR is updated I'm curious whether that use case is supported or how to do that simply)
or maybe git hooks: https://www.digitalocean.com/community/tutorials/how-to-use-git-hooks-to-automate-development-and-deployment-tasks
in github: webhooks https://developer.github.com/webhooks/creating/
The text was updated successfully, but these errors were encountered: