search

showyourwork / showyourwork-action

Build showyourwork articles on GitHub Actions
MIT License
2 stars 4 forks source link

Emphasize `GITHUB_TOKEN` setting #10

Closed MilesCranmer closed 1 year ago

MilesCranmer commented 1 year ago

I think this GITHUB_TOKEN setting has tripped me up maybe ~3 times now. I always end up reading the actions page, rather than the FAQ... Thus I think this tip about permissive settings for the GITHUB_TOKEN should be highlighted front-and-center on the actions page as that is where people will go when they're first setting it up.

@dfm could you review this?

Also - the "Suggest Edit" button on the rendered version seems to link to actions.rst on the main repository. How can we fix that?

dfm commented 1 year ago

Interesting! I don't remember running into this before, but happy to merge. Can you open an issue in the main repo to track the question about linking (it may be more trouble than it's worth, but I'm not sure!)?

MilesCranmer commented 1 year ago

If you do not see I think it is because of your security settings. I think there is one setting that makes all new repos have read-only access to GITHUB_TOKEN by default.