Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Make DOCUMENTER_KEY decoding error more helpful #697

Closed
mortenpi opened this issue Apr 4, 2018 · 3 comments
Closed

Make DOCUMENTER_KEY decoding error more helpful #697

mortenpi opened this issue Apr 4, 2018 · 3 comments
Labels
Type: Enhancement

Comments

@mortenpi
Copy link
Member

mortenpi commented Apr 4, 2018

If there's something wrong with DOCUMENTER_KEY and Documenter can't decode it, the error is a bit cryptic, e.g.:

...
Documenter: setting up target directory.
Documenter: pushing new documentation to remote: github.com/JuliaMath/DoubleFloats.jl.git:gh-pages.
ERROR: LoadError: ArgumentError: malformed base64 sequence
Stacktrace:
 [1] decode_slow(::UInt8, ::UInt8, ::UInt8, ::UInt8, ::Base64.Buffer, ::Int64, ::Base.GenericIOBuffer{Array{UInt8,1}}, ::Ptr{UInt8}, ::UInt64, ::Array{UInt8,1}) at /buildworker/worker/package_linux64/build/usr/share/julia/site/v0.7/Base64/src/decode.jl:166
...
@mortenpi mortenpi mentioned this issue Jun 2, 2018
Closed
@mkborregaard
Copy link

Finding this issue was a great help to me at least!

@diegozea
Copy link

diegozea commented Dec 3, 2018

Hi! I've found that error: https://travis-ci.org/diegozea/MIToS.jl/jobs/463040461 How can I solve it?

@diegozea
Copy link

diegozea commented Dec 4, 2018

I solved the problem in my package by generating a new key as described in https://juliadocs.github.io/Documenter.jl/stable/man/hosting/#SSH-Deploy-Keys-1

mortenpi added a commit that referenced this issue Dec 10, 2018
@mortenpi
Print user-friendly DOCUMENTER_KEY decode error
23a6a7e 
Closes #697.
mortenpi added a commit that referenced this issue Dec 10, 2018
@mortenpi
Handle DOCUMENTER_KEY errors better in deploydocs
87e9d30 
* Print a more helpful error if base64decode fails for the provided key.
* Use SSH batch mode -- this means that SSH won't ask for passphrase
  and time out the Travis build if the SSH key is problematic.
* Also, print a more helpful error if git fetch throws an error, most
  likely due to a key misconfiguration.

Closes #697
@mortenpi mortenpi mentioned this issue Dec 10, 2018
Merged
mortenpi added a commit that referenced this issue Dec 10, 2018
@mortenpi
Handle DOCUMENTER_KEY errors better in deploydocs
b85f32c 
* Print a more helpful error if base64decode fails for the provided key.
* Use SSH batch mode -- this means that SSH won't ask for passphrase
  and time out the Travis build if the SSH key is problematic.
* Also, print a more helpful error if git fetch throws an error, most
  likely due to a key misconfiguration.

Closes #697
mortenpi added a commit that referenced this issue Dec 10, 2018
@mortenpi
Handle DOCUMENTER_KEY errors better in deploydocs (#907)
63bb9ef 
* Handle DOCUMENTER_KEY errors better in deploydocs

* Print a more helpful error if base64decode fails for the provided key.
* Use SSH batch mode -- this means that SSH won't ask for passphrase
  and time out the Travis build if the SSH key is problematic.
* Also, print a more helpful error if git fetch throws an error, most
  likely due to a key misconfiguration.

Close #697
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Type: Enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@mortenpi @diegozea @mkborregaard