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

No versioned docs since v0.12.1 #938

Closed
hyrodium opened this issue Jul 22, 2021 · 7 comments
Closed

No versioned docs since v0.12.1 #938

hyrodium opened this issue Jul 22, 2021 · 7 comments

Comments

@hyrodium
Copy link
Collaborator

There's no versioned docs since v0.12.1.
https://github.com/JuliaArrays/StaticArrays.jl/tree/gh-pages

I can't find any triggered actions here, so there may be some problems with ci.yml or ssh key, I guess.

related: #870

@martinholters
Copy link
Collaborator

Not sure if helpful, but reminds me of JuliaDSP/DSP.jl#434.

@hyrodium
Copy link
Collaborator Author

@fredrikekre Do you have permission to add the DOCUMENTER_KEY to this repository?
https://juliadocs.github.io/Documenter.jl/dev/man/hosting/#GitHub-Actions

@c42f
Copy link
Member

c42f commented Jan 6, 2022

It seems that Documenter isn't successfully committing to the gh-pages branch? For example the following build succeeds and reports that it's going to deploy:

https://github.com/JuliaArrays/StaticArrays.jl/runs/4673830835?check_suite_focus=true

 ┌ Info: Deployment criteria for deploying devbranch build from GitHub Actions:
│ - ✔ ENV["GITHUB_REPOSITORY"]="JuliaArrays/StaticArrays.jl" occurs in repo="github.com/JuliaArrays/StaticArrays.jl"
│ - ✔ ENV["GITHUB_EVENT_NAME"]="push" is "push"
│ - ✔ ENV["GITHUB_REF"] matches devbranch="master"
│ - ✔ ENV["GITHUB_ACTOR"] exists and is non-empty
│ - ✔ ENV["DOCUMENTER_KEY"] exists and is non-empty
└ Deploying: ✔

But the gh-pages branch is still empty except for a couple of ancient commits from years ago. DOCUMENTER_KEY is already set in the secrets (though I'm not sure it's required anymore anyway?)

@hyrodium
Copy link
Collaborator Author

hyrodium commented Jan 6, 2022

It seems that Documenter isn't successfully committing to the gh-pages branch? For example the following build succeeds and reports that it's going to deploy:

The github action was triggered when the PR was merged to master, and it succeed to deploy to https://juliaarrays.github.io/StaticArrays.jl/dev, not https://juliaarrays.github.io/StaticArrays.jl/v1.3.0.

The DOCUMENTER_KEY was required to trigger the github action with a new tag. If the key is set correctly, the action will run when adding a new tag, Documenter.jl detects the action was triggered by the new tag (e.g. v1.3.0), and will deploy docs to https://github.com/JuliaArrays/StaticArrays.jl/tree/gh-pages/v1.3.0 (this returns 404).

This behavior is documented in Documenter.jl documentation.
https://juliadocs.github.io/Documenter.jl/stable/man/hosting/#GitHub-Actions

image

But the gh-pages branch is still empty except for a couple of ancient commits from years ago. DOCUMENTER_KEY is already set in the secrets (though I'm not sure it's required anymore anyway?)

Hmm, I'm not sure, but I think the DOCUMENTER_KEY is not correct, or missing a deploy key.
I have some experience of fixing this problem in other packages such as Rotations.jl, so I can solve this issue if you add me more permission.

@fredrikekre
Copy link
Member

I believe the only problem is that the ssh key is missing from the tagbot config

fredrikekre added a commit that referenced this issue Jan 6, 2022
@hyrodium
Copy link
Collaborator Author

hyrodium commented Jan 6, 2022

Ah, thanks for the PR #984!

@hyrodium
Copy link
Collaborator Author

hyrodium commented Jan 7, 2022

I've pushed some tags such as v1.3.0+doc1, and now these links are up to date:tada:
https://juliaarrays.github.io/StaticArrays.jl/stable/
https://juliaarrays.github.io/StaticArrays.jl/v1.3.0/

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

4 participants