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.

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

Make sure that the generated private key is in PEM format #48

Merged
merged 4 commits into from
May 7, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
* DocumenterTools now requires at least Julia 1.6.
* ![Enhancement][badge-enhancement] `DocumenterTools.genkeys` function now uses the `OpenSSH_jll` for the `ssh-keygen` binary and therefore no longer requires the user to have OpenSSH installed. ([#36][github-36], [#56][github-56])
* ![Enhancement][badge-enhancement] Improvements to the documentation of `OutdatedWarning.generate` and it now also prints a warning in the terminal. ([#55][github-55])
* ![Bugfix][badge-bugfix] DocumenterTools now always generated the SSH keys in the PEM file format to make sure that they also work on older systems. ([#48][github-48])

## Version `v0.1.13`

Expand Down Expand Up @@ -78,6 +79,7 @@ Maintenance release declaring compatibility with Documenter 0.25. ([#39][github-
[github-43]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/43
[github-44]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/44
[github-46]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/46
[github-48]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/48
[github-49]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/49
[github-51]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/51
[github-52]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/52
Expand Down
2 changes: 1 addition & 1 deletion src/genkeys.jl
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ function genkeys(; user="\$USER", repo="\$REPO")
isfile("$(filename).pub") && error("temporary file '$(filename).pub' already exists in working directory")

# Generate the ssh key pair.
success(`$(sshkeygen) -N "" -C Documenter -f $filename`) || error("failed to generate a SSH key pair.")
success(`$(sshkeygen) -N "" -C Documenter -m PEM -f $filename`) || error("failed to generate a SSH key pair.")

# Prompt user to add public key to github then remove the public key.
let url = "https://github.com/$user/$repo/settings/keys"
Expand Down