Publish docs to gh-pages, add coveralls, update README #385
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This moves things around a fair bit in the .travis.yml to be more logically ordered and adds support for publishing docs (on master) to gh-pages. Code coverage is also calculated and published to coveralls.io. Travis is able to write to gh-pages on the github repository via the GH_TOKEN environment variable stored in the travis settings (marked as private). This token is generated from the github user 'rust-nix-bot' in order to avoid given access to other repos associated with an actual user's account (this practice is recommended by Github). Other changes worth noting: - We now test fewer intermediate versions of rust - The existing logic to publish to Carl's S3 bucket have been removed. Signed-off-by: Paul Osborne <osbpau@gmail.com>
|
Changes Unknown when pulling 4b2383a on posborne:gh-pages-docs into * on nix-rust:master*. |
posborne
force-pushed
the
gh-pages-docs
branch
2 times, most recently
from
ef46dde to
9145625
Compare
|
r? @kamalmarhubi @fiveop When I started out, I was thinking that the docs weren't being updated at all. It looks like they might be after all. So, reasons to move to Github Pages:
Downsides:
|
| - Linux: [master](http://rustdoc.s3-website-us-east-1.amazonaws.com/nix/master/linux/nix/) | ||
| - OS X: [master](http://rustdoc.s3-website-us-east-1.amazonaws.com/nix/master/osx/nix/) | ||
| ```rust,ignore | ||
| // libc api (unsafe, requires handing return code/errno) |
|
Looks good, except for that typo! :) I think the benefits outweigh the drawbacks of switching to github pages. |
Cool, I'll fix that up. Was traveling yesterday. |
This started out as a small change to update the readme to include an updated pointer to the documentation on gh-pages and ended with a bit of an overhaul in order to provide better information for people just checking out nix for the first time. Signed-off-by: Paul Osborne <osbpau@gmail.com>
Signed-off-by: Paul Osborne <osbpau@gmail.com>
|
@homu r+ |
|
📌 Commit 8f461ff has been approved by |
homu
added a commit
that referenced
this pull request
Jul 13, 2016
Publish docs to gh-pages, add coveralls, update README See the commit messages for some additional details. This started out with just an update to publish the docs to gh-pages but snowballed into a few other changes along the way.
|
☀️ Test successful - status |
|
Big 👍 for this! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See the commit messages for some additional details. This started out with just an update to publish the docs to gh-pages but snowballed into a few other changes along the way.