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

Deploy docs from main to ghpages #76

Closed
eford opened this issue Aug 18, 2023 · 2 comments
Closed

Deploy docs from main to ghpages #76

eford opened this issue Aug 18, 2023 · 2 comments

Comments

@eford
Copy link

eford commented Aug 18, 2023

I suggest that the example be updated to deploy from main rather than master.
I tried replacing master with main in the ci.yml
branches: [main]
But then it doesn't deploy to gh-pages.

Info: Deployment criteria for deploying devbranch build from GitHub Actions:
│ - ✔ ENV["GITHUB_REPOSITORY"]="PsuAstro528/project-template" occurs in repo="github.com/PsuAstro528/project-template.git"
│ - ✔ ENV["GITHUB_EVENT_NAME"]="push" is "push"
│ - ✘ ENV["GITHUB_REF"] matches devbranch="master"
│ - ✔ ENV["GITHUB_ACTOR"] exists
│ - ✔ ENV["DOCUMENTER_KEY"] exists
└ Deploying: ✘

Then I tried adding devbranch to docs/make.jl
deploydocs(repo = "github.com/PsuAstro528/project-template.git", devbranch="main")
but then I got

hint: Using 'master' as the name for the initial branch. This default branch name
hint: is subject to change. To configure the initial branch name to use in all
hint: of your new repositories, which will suppress this warning, call:
hint: 
hint: 	git config --global init.defaultBranch <name>
hint: 
hint: Names commonly chosen instead of 'master' are 'main', 'trunk' and
hint: 'development'. The just-created branch can be renamed via this command:
hint: 
hint: 	git branch -m <name>
Initialized empty Git repository in /tmp/jl_f1Y7Hk/.git/
Load key "/home/runner/work/project-template/project-template/docs/.documenter": error in libcrypto
git@github.com: Permission denied (publickey).
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.
┌ Error: Git failed to fetch git@github.com:PsuAstro528/project-template.git
│ This can be caused by a DOCUMENTER_KEY variable that is not correctly set up.
│ Make sure that the environment variable is properly set up as a Base64-encoded string
│ of the SSH private key. You may need to re-generate the keys with DocumenterTools.
└ @ Documenter ~/.julia/packages/Documenter/6vUwN/src/Documenter.jl:552
┌ Error: Failed to push:
│   exception =
│    failed process: Process(`git fetch upstream`, ProcessExited(128)) [128]
│    
│    Stacktrace:
│      [1] pipeline_error
│        @ ./process.jl:565 [inlined]
│      [2] run(::Cmd; wait::Bool)
│        @ Base ./process.jl:480
│      [3] run
│        @ ./process.jl:477 [inlined]
│      [4] (::Documenter.var"#git_commands#27"{String, String, SubString{String}, String, Vector{Any}, Bool, String, String})(sshconfig::String)
│        @ Documenter ~/.julia/packages/Documenter/6vUwN/src/Documenter.jl:550
│      [5] (::Documenter.var"#26#32"{String})()
│        @ Documenter ~/.julia/packages/Documenter/6vUwN/src/Documenter.jl:655
│      [6] cd(f::Documenter.var"#26#32"{String}, dir::String)
│        @ Base.Filesystem ./file.jl:112
│      [7] #25
│        @ ~/.julia/packages/Documenter/6vUwN/src/Documenter.jl:655 [inlined]
│      [8] withenv(f::Documenter.var"#25#31"{String, String}, keyvals::Pair{String, String})
│        @ Base ./env.jl:197
│      [9] (::Documenter.var"#24#30"{String, String, SubString{String}, String})(sshconfig::String, io::IOStream)
│        @ Documenter ~/.julia/packages/Documenter/6vUwN/src/Documenter.jl:654
│     [10] mktemp(fn::Documenter.var"#24#30"{String, String, SubString{String}, String}, parent::String)
│        @ Base.Filesystem ./file.jl:732
│     [11] mktemp(fn::Function)
│        @ Base.Filesystem ./file.jl:730
│     [12] git_push(root::String, temp::String, repo::String; branch::String, dirname::String, target::String, sha::SubString{String}, devurl::String, versions::Vector{Any}, forcepush::Bool, deploy_config::Documenter.GitHubActions, subfolder::String, is_preview::Bool)
│        @ Documenter ~/.julia/packages/Documenter/6vUwN/src/Documenter.jl:639
│     [13] git_push
│        @ ~/.julia/packages/Documenter/6vUwN/src/Documenter.jl:526 [inlined]
│     [14] #18
│        @ ~/.julia/packages/Documenter/6vUwN/src/Documenter.jl:504 [inlined]
│     [15] mktempdir(fn::Documenter.var"#18#20"{SubString{String}, String, String, String, String, Vector{Any}, Bool, Documenter.GitHubActions, Bool, String, String, String}, parent::String; prefix::String)
│        @ Base.Filesystem ./file.jl:760
│     [16] mktempdir(fn::Function, parent::String)
│        @ Base.Filesystem ./file.jl:756
│     [17] mktempdir
│        @ ./file.jl:756 [inlined]
│     [18] (::Documenter.var"#17#19"{String, String, String, Nothing, String, Vector{Any}, Bool, Documenter.GitHubActions, Bool, String, String, String})()
│        @ Documenter ~/.julia/packages/Documenter/6vUwN/src/Documenter.jl:503
│     [19] cd(f::Documenter.var"#17#19"{String, String, String, Nothing, String, Vector{Any}, Bool, Documenter.GitHubActions, Bool, String, String, String}, dir::String)
│        @ Base.Filesystem ./file.jl:112
│     [20] deploydocs(; root::String, target::String, dirname::String, repo::String, branch::String, repo_previews::String, branch_previews::String, deps::Nothing, make::Nothing, devbranch::String, devurl::String, versions::Vector{Any}, forcepush::Bool, deploy_config::Documenter.GitHubActions, push_preview::Bool)
│        @ Documenter ~/.julia/packages/Documenter/6vUwN/src/Documenter.jl:480
│     [21] top-level scope
│        @ ~/work/project-template/project-template/docs/make.jl:5
│     [22] include(mod::Module, _path::String)
│        @ Base ./Base.jl:[45](https://github.com/PsuAstro528/project-template/actions/runs/5902823903/job/16011550982#step:5:46)7
│     [23] exec_options(opts::Base.JLOptions)
│        @ Base ./client.jl:307
│     [24] _start()
│        @ Base ./client.jl:[52](https://github.com/PsuAstro528/project-template/actions/runs/5902823903/job/16011550982#step:5:53)2
└ @ Documenter ~/.julia/packages/Documenter/6vUwN/src/Documenter.jl:6[60](https://github.com/PsuAstro528/project-template/actions/runs/5902823903/job/16011550982#step:5:61)

At that point, I gave up.
I'm probably missing something basic, but it's not obvious how to solve this from either example or the documentation. Thanks.

@ViralBShah
Copy link
Member

Works now.

@eford
Copy link
Author

eford commented Sep 26, 2024

Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants