📚 [Documentation] Add info on how GH actions handled

Seshat-Global-History-Databank / seshat

Seshat: A groundbreaking resource that is bringing together the most current and comprehensive body of knowledge about human history available.

https://seshat-db.com/

2 stars 0 forks source link

📚 [Documentation] Add info on how GH actions handled #18

Open edwardchalstrey1 opened 2 months ago

edwardchalstrey1 commented 2 months ago

Section of Documentation

Developer

Description of Improvement

An admin of the organisation (currently @edwardchalstrey1 ) has generated a personal access token with GitHub package write permissions, in order to run the build.yml and tests.yml GH actions
This token was added to the secrets in the repo and is accessed by the actions
Add instructions so that admin developers in future can repeat this in future if @edwardchalstrey1 is ever removed as admin

Benefits of Improvement

Development continuity

Additional Context

No response

kallewesterling commented 2 months ago

I think if you use secrets.GITHUB_TOKEN, those are automatically generated and don't have to be managed manually. I may be wrong, however, so double-check this?

edwardchalstrey1 commented 2 months ago

I had to generate it from my personal account and add it to the repo where it is accessed via secrets.GITHUB_TOKEN

kallewesterling commented 2 months ago

I think you're using a GH_TOKEN but, to be clear, what I'm saying is that there's an auto-generated token from GitHub that is called GITHUB_TOKEN which I'm curious if it would work, without needing the manual setup:

At the start of each workflow job, GitHub automatically creates a unique GITHUB_TOKEN secret to use in your workflow. You can use the GITHUB_TOKEN to authenticate in the workflow job.

When you enable GitHub Actions, GitHub installs a GitHub App on your repository. The GITHUB_TOKEN secret is a GitHub App installation access token. You can use the installation access token to authenticate on behalf of the GitHub App installed on your repository. The token's permissions are limited to the repository that contains your workflow.

edwardchalstrey1 commented 2 months ago

To test this, I guess I'd have to remove the secret I added - but before I do perhaps you can test on your fork, open a PR to yourself and see if it works?

kallewesterling commented 2 months ago

To test this, I guess I'd have to remove the secret I added - but before I do perhaps you can test on your fork, open a PR to yourself and see if it works?

Yep - let me see!

kallewesterling commented 2 months ago

Done: https://github.com/Seshat-Global-History-Databank/seshat/pull/26