Utilize GitHub Releases API for TRAVIS deployments

ASPRSorg / LAS

LAS Specification

https://www.asprs.org/committee-general/laser-las-file-format-exchange-activities.html

140 stars 16 forks source link

Utilize GitHub Releases API for TRAVIS deployments #34

Closed esilvia closed 6 years ago

esilvia commented 6 years ago

It looks like we could use the GitHub Releases API to deploy the LAS.PDF and LAS.TEX files from the TRAVIS build directly into the GitHub interface. I really like the idea of exposing the raw LaTeX that's produced to help with troubleshooting, and having direct access to the PDF. Could help with #22, too, and maybe eliminate the need to rely on @hobu 's AWS account.

Main issues I see are that it requires tagging commits in order to trigger GitHub's creation of a Release, which could get messy, and that I couldn't figure out how to embed an API key in the travis.yml file without having it purged/revoked by GitHub.

Link here: https://docs.travis-ci.com/user/deployment/releases/

hobu commented 6 years ago

GitHub Releases wasn't super mature when I was doing this stuff in February. It has gotten better, but you're right that individual tagging of releases to trigger things can be problematic. A deficiency with our current setup is only in-org Pull Requests PDFs can be uploaded because the secure credentials are only available to the org. This shouldn't be a problem for most of our contributors since we're all within the organization. Outsiders can still contribute pull requests to us, we just don't get rendered output until we merge them up.

hobu commented 6 years ago

I'm 👎 on this for a few reasons:

It complicates our deployment to have to manage another set of encrypted credentials (first AWS to dump to my S3 bucket and now GitHub's)
We don't want a "release" for every commit on the repo (we have that now with the S3 bucket, but they're not indexed by google or anything else and you have to dig to get the URLs to the files).
When documents are finalized, the chair should take a copy of the generated document, name it, and post it in the appropriate (and canonical) ASPRS.org location -- not here in our workspace.

I think we should continue with the current approach for a few releases until it is clear we need to automate things further. Even getting this far was quite a leap.

esilvia commented 6 years ago

Now that I've looked into this more than when I initially created this issue, I agree with your assessment.