search

ethpm / ethpm-spec

Ethereum Package Manager http://ethpm.github.io/ethpm-spec/
165 stars 30 forks source link

Fix docs continuous deployment previews #94

Closed gnidan closed 6 years ago

gnidan commented 6 years ago

The docs build uses Travis's encrypted environment variables to decrypt a write-access deploy key and push changes to the gh-pages branch.

This doesn't work on PRs originating at forks, to protect against a security vulnerability: external contributors could open a PR that modifies .travis.yml to print the deploy key to screen, for instance. (ref: https://github.com/travis-ci/travis-ci/issues/8736)

To encourage community contribution and make it as frictionless as possible, the docs build should work for both internal and external contributors, creating a gh-pages subdirectory for all PR previews.

pipermerriam commented 6 years ago

Hrm, I'm really skeptical of how important this is. Building documentation locally is very easy and while that doesn't help a ton for trying to review 3rd party contributions, it isn't too difficult to pull a branch and build it locally if you have questions about the formatting.

I've found visually parsing sphinx docs is largely doable once you are familiar with the markup.

Just my 2 cents.

gnidan commented 6 years ago

@pipermerriam it's probably not that important. As it stands now, we can preview by changing the target branch to some throw-away local branch. I'll spend a half hour or so today thinking if there's a quick-fix, otherwise I'll just close this.

Also shouldn't we start saying "just my 2 finney" instead? 😁

gnidan commented 6 years ago

Closing, won't fix for now.