Skip to content

Commit 4d9eb33

Browse files
authored
chore(docs): add note about visibility of GHCR images (#133)
## Description Adds a note about GHCR image visibility and how to request that images be make public if that option isn't available for a repo. ## Related Tickets & Documents * MZCLD-1436
1 parent 9a11af0 commit 4d9eb33

2 files changed

Lines changed: 15 additions & 0 deletions

File tree

.github/workflows/docs/build-and-push.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,10 @@ jobs:
137137
should_tag_ghcr: true
138138
```
139139
140+
**Note**: GHCR images are private by default. Depending on which GitHub organization your
141+
repository belongs to, you may need to [file a bug][ghcr-visibility-bug] to allow making
142+
published GHCR images publicly accessible (see [example][ghcr-visibility-example]).
143+
140144
## Troubleshooting
141145
142146
Is your build failing? The "[How to: Publish Container Images to GAR][how-to]"
@@ -145,3 +149,5 @@ wiki page may include some answers, specifically around permissions issues.
145149
[`docker-build`]: ../../../docker-build/README.md
146150
[`docker-push`]: ../../../docker-push/README.md
147151
[how-to]: https://mozilla-hub.atlassian.net/wiki/spaces/SRE/pages/997163545/How+to+Publish+Container+Images+to+GAR
152+
[ghcr-visibility-bug]: https://bugzilla.mozilla.org/enter_bug.cgi?product=mozilla.org&component=Github%3A+Administration
153+
[ghcr-visibility-example]: https://bugzilla.mozilla.org/show_bug.cgi?id=2009036

docker-push/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,15 @@ This value should be available as the repository variable `vars.GCPV2_WORKLOAD_I
3333
[1]: https://cloud.google.com/artifact-registry/docs/docker/pushing-and-pulling#tag
3434
[2]: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#pushing-container-images
3535

36+
### GHCR Image Visibility
37+
38+
GHCR images are private by default. Depending on which GitHub organization your repository
39+
belongs to, you may need to [file a bug][ghcr-visibility-bug] to allow making published GHCR
40+
images publicly accessible (see [example][ghcr-visibility-example]).
41+
42+
[ghcr-visibility-bug]: https://bugzilla.mozilla.org/enter_bug.cgi?product=mozilla.org&component=Github%3A+Administration
43+
[ghcr-visibility-example]: https://bugzilla.mozilla.org/show_bug.cgi?id=2009036
44+
3645
## Example Usage
3746

3847
```yaml

0 commit comments

Comments
 (0)