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

Hint about permission settings for repository packages #38

Open
lufire opened this issue Nov 25, 2024 · 6 comments
Open

Hint about permission settings for repository packages #38

lufire opened this issue Nov 25, 2024 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@lufire
Copy link

lufire commented Nov 25, 2024

For me, the initial GH Actions workflows failed due to the packages being set private by default in our organizations account (as far as i understand) and I had to link and set permissions in the package settings for the repository explicitly.
I think for people with no experience with this, as for me, it might cause trouble and a lot of time figuring out initially. Maybe additional hints in the README could help there. The second [!important] note is basically about this, however I could not directly see that "the distributed image" is equivalent to the package being pushed to "ghcr.io/.." and what is actually being talked about here without looking into the yaml files directly.
The current FAQ/Troubleshooting section is related, but only directly adresses the pulling step.

@hampusnasstrom hampusnasstrom self-assigned this Dec 11, 2024
@hampusnasstrom
Copy link
Collaborator

@lufire thank you for the feedback! I will add a part to the troubleshooting section about checking the package permissions if the actions fail. Do you happen to remember the error message you got?

I'm not sure I understand the second part. Do you mean that it is not clear from the README that the repository creates two docker images and publishes these to GitHub's package registry?

@hampusnasstrom hampusnasstrom added the documentation Improvements or additions to documentation label Dec 11, 2024
@hampusnasstrom
Copy link
Collaborator

@lufire, I read through the README again and there is a line right at the top in the "Important" box saying:
"If you want to make the image public (recommended), you should make sure that your organization settings allow public packages and make this package public after building it. You can read more about this in the GitHub docs here." Is this not the first issue you mentioned?

@lufire
Copy link
Author

lufire commented Dec 11, 2024

@hampusnasstrom Maybe rephrasing that part would be enough? Right now it looks like it's optional and could be done afterwards, however it is crucial for the pipeline, otherwise you would need to include credentials in the workflow yamls, right?

@lufire
Copy link
Author

lufire commented Dec 11, 2024

@lufire thank you for the feedback! I will add a part to the troubleshooting section about checking the package permissions if the actions fail. Do you happen to remember the error message you got?

#27 ERROR: failed to push ghcr.io/zbt-tools/nomad-oasis:main: unexpected status from HEAD request to https://ghcr.io/v2/zbt-tools/nomad-oasis/blobs/sha256:5d8aab86fdb5cf7ccf1950ad75113fafc5d513c9a5efbbb0a1178344eebbcc1e: 403 Forbidden

I'm not sure I understand the second part. Do you mean that it is not clear from the README that the repository creates two docker images and publishes these to GitHub's package registry?

Yes :)

@hampusnasstrom
Copy link
Collaborator

@hampusnasstrom Maybe rephrasing that part would be enough? Right now it looks like it's optional and could be done afterwards, however it is crucial for the pipeline, otherwise you would need to include credentials in the workflow yamls, right?

I'm not sure actually. I thought I managed to publish a private package. But maybe you were trying to publish a public package when your organization rules did not allow this. Then I don't think even credentials will help.

@hampusnasstrom
Copy link
Collaborator

Thanks for the clarification, I'll try to make some changes and then tag you and you can let me know what you think.

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

When branches are created from issues, their pull requests are automatically linked.

2 participants