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

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

Open
edwardchalstrey1 opened this issue Jul 8, 2024 · 7 comments
Open

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

edwardchalstrey1 opened this issue Jul 8, 2024 · 7 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@edwardchalstrey1
Copy link

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

@edwardchalstrey1 edwardchalstrey1 added the documentation Improvements or additions to documentation label Jul 8, 2024
@edwardchalstrey1 edwardchalstrey1 self-assigned this Jul 11, 2024
@kallewesterling
Copy link
Member

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
Copy link
Author

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

@kallewesterling
Copy link
Member

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
Copy link
Author

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
Copy link
Member

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
Copy link
Member

Done: #26

@edwardchalstrey1 edwardchalstrey1 removed their assignment Aug 14, 2024
@edwardchalstrey1 edwardchalstrey1 added this to the Vienna workshop milestone Sep 24, 2024
@edwardchalstrey1 edwardchalstrey1 removed this from the Vienna workshop milestone Oct 11, 2024
@edwardchalstrey1
Copy link
Author

This should reflect what gets merged in #26

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

No branches or pull requests

2 participants