BandedMatrices.jl icon indicating copy to clipboard operation
BandedMatrices.jl copied to clipboard

Stable docs not building

Open jishnub opened this issue 2 years ago • 3 comments

I noticed that the permissions of GITHUB_TOKEN are different in this repo compared to others. In this repo:

GITHUB_TOKEN Permissions
  Contents: write
  Metadata: read

In, say, StaticArrays, where the docs do build,

GITHUB_TOKEN Permissions
  Actions: write
  Checks: write
  Contents: write
  Deployments: write
  Discussions: write
  Issues: write
  Metadata: read
  Packages: write
  Pages: write
  PullRequests: write
  RepositoryProjects: write
  SecurityEvents: write
  Statuses: write

Perhaps we need to enable permissions for this, to get the docs to build?

At the same time I'm not entirely sure about the interplay between GITHUB_TOKEN and DOCUMENTER_KEY, and if the ssh token is enough for docs to build, and if it's set correctly for this repo. In any case, perhaps enabling permissions for GITHUB_TOKEN can't hurt.

jishnub avatar Dec 07 '22 13:12 jishnub

I don't understand actions / tokens at all so just tell me exactly what you want me to change

dlfivefifty avatar Dec 07 '22 21:12 dlfivefifty

Could you check Settings > Actions> General > Workflow permissions and see if the read and write permissions are enabled?

jishnub avatar Dec 08 '22 06:12 jishnub

It says they are enabled

dlfivefifty avatar Dec 08 '22 22:12 dlfivefifty

Could you check if the Documenter key in https://github.com/JuliaLinearAlgebra/BandedMatrices.jl/settings/keys has read/write permissions?

jishnub avatar Mar 14 '23 10:03 jishnub

Hmm there are no keys.... how do I add it?

dlfivefifty avatar Mar 14 '23 14:03 dlfivefifty

Oh, I see, that probably explains what's going on. You can add a key by following the instruction at https://documenter.juliadocs.org/stable/man/hosting/#travis-ssh, and adding the public key and secret that's generated. The key doesn't need to be named while creating it, but the secret must be called DOCUMENTER_KEY, as that's the name used in the TagBot currently

jishnub avatar Mar 14 '23 15:03 jishnub

OK I added it DOCUMENTER_KEY to "Repository secrets" and a "Documenter" Deploy key hopefully that resolves it

dlfivefifty avatar Mar 15 '23 14:03 dlfivefifty

This is fixed now

jishnub avatar Apr 01 '23 16:04 jishnub