search

asciidoctor / jekyll-asciidoc-quickstart

A template project for creating AsciiDoc-based websites using Jekyll.
https://asciidoctor.github.io/jekyll-asciidoc-quickstart/
MIT License
122 stars 158 forks source link

Generating the Encryption Key Using Methods Other Than the Travis CLI #4

Closed jaredmorgs closed 9 years ago

jaredmorgs commented 9 years ago

From what I can see, the step in the Readme.adoc that shows you how to get your Travis key is the only barrier for folks who want to never touch a PC to configure this repo.

Undoubtably, the Travis CLI is the logical and safest way to get the key. http://docs.travis-ci.com/user/encryption-keys/ details the CLI way, but there is text on there that suggests there are other ways to do it.

I've opened a support request with Travis-CI to see if there is another way users can do this. If it is possible, we can achieve the command-line free solution for folks that either:

  1. Are restricted to only a tablet computer like an Android Tablet, iOS or Windows Tab
  2. Only want to use the tablet and do not want to touch the command line at all.

This would bring our forkable repo in line with jekyll-now functionality.

  1. Fork
  2. Configure (without a PC)
  3. Deploy

It might be impossible to avoid this one step on the PC, but it's worth asking the question anyway.

jaredmorgs commented 9 years ago

Turns out this could be possible without the CLI...

We use public key based encryption + base64 encoding, so you can use any tool that allows you to do that. Here is the code that we use in Travis CLI: https://github.com/travis-ci/travis.rb/blob/master/lib/travis/client/repository.rb#L16-L17 - public_encrypt is a ruby method on RSA key object. You can fetch a public key for any repository on Travis CI by using one of these endpoints: http://docs.travis-ci.com/api/#repository-keys

jirutka commented 9 years ago

…for folks who want to never touch a PC to configure this repo.

I don’t believe that it’s a real use case. If someone doesn’t have a computer at home, then (s)he have it at work, or can use an internet cafe in the worst case (just to setup repo).

How many people are affected? It is worthwhile to deal with it? The CLI way is actually the simplest, anything else will be overly complicated to implement.

However, a real problem with the travis gem could be Ruby – for Windows guys (but they are probably used to it, ’cause almost everything is complicated and creepy on Windows :smirk_cat:).

jirutka commented 9 years ago

Damn, I’ve forgotten that Windows doesn’t have usable terminal preinstalled, so well, CLI is problematic for them. :crying_cat_face: Sigh.

jaredmorgs commented 9 years ago

@jirutka I concede that I'm just too attached to the way the jekyll-now repo works. :(

I don’t believe that it’s a real use case. If someone doesn’t have a computer at home, then (s)he have it at work, or can use an internet cafe in the worst case (just to setup repo).

I'm not suggesting folks wouldn't have a PC at home that they could install travis CI on. I'm more referring to folks that want it to "just work" as the jekyll-now repo does. The keystone to this issue here--and one that I've been conveniently trying to ignore--is that we don't have AsciiDoc whitelist support. This is why jekyll-now works as it does, and trying to emulate that here is just a technical impossibility.

How many people are affected? It is worthwhile to deal with it? The CLI way is actually the simplest, anything else will be overly complicated to implement.

I took a look at online base64 generators, and I have to agree it would be overly complicated to get the Travis key for the audience typically consuming a "fork and blog" type repo like jekyll-now.

Putting myself in a totally green user's shoes, if I saw something like "just go to an online key generator and copy this key from here and..." I'd likely just look for something else that was easier to configure. :wink:

I think if we help users with the basic steps to getting Travis CLI installed, that should be enough. I'm not suggesting we "document the internet" here, but a basic overview of the process with links off to the appropriate docs could be the way forward to get the user over this one installation hurdle.

Maybe even recommend a few Windows CLI tools that folks could use as a sweetener.

We so need whitelist support. Keep on hustling! :smiley:

johncarl81 commented 9 years ago

We good to close?

jaredmorgs commented 9 years ago

I reckon so. On 27 Jan 2015 2:45 pm, "John Ericksen" notifications@github.com wrote:

We good to close?

— Reply to this email directly or view it on GitHub https://github.com/asciidoctor/jekyll-asciidoc-quickstart/issues/4#issuecomment-71589197 .