Skip to content

Commit df3c5d3

Browse files
authored
fix: GitHub Actions as recommended for developers (#315)
1 parent 092ee12 commit df3c5d3

2 files changed

Lines changed: 4 additions & 2 deletions

File tree

content/CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ And if you like the project, but just don't have time to contribute, that's fine
2525
- [Reporting Bugs](#reporting-bugs)
2626
- [Pull Requests](#pull-requests)
2727
- [How to test incoming changes](#how-to-test-incoming-changes)
28+
- [Building with GitHub Actions (recommended)](#building-ga)
2829
- [Building Locally](#building-locally)
2930
- [Styleguides](#styleguides)
3031
- [Commit Messages](#commit-messages)
@@ -88,7 +89,8 @@ One of the nice things about the image model is that we can generate an entire O
8889

8990
We strive towards a model where proposed changes are more thoroughly reviewed and tested by the community. So here's how to do it. If you see a pull request that is opened up on an image you're following, you can leave a review on how it's working for you.
9091

91-
## Building your images with GitHub Actions (recommended)
92+
## [Building with GitHub Actions (recommended)](#building-ga)
93+
{: #building-ga}
9294

9395
Start from your own fork with a branch for the pull request/feature you want to develop. Follow the instructions [here](https://blue-build.org/how-to/cosign/) to add your own keys to verify your own custom image. From there, it's recommended you go to .github/workflows/build.yml and comment out all of the image variants except the ones you use/intend to test. This drastically speeds up your workflow runtime. Then just go to actions > build-secureblue and select run workflow, making sure you select the branch you just set up.
9496

content/FAQ.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -386,7 +386,7 @@ Note that Distrobox is not a security tool. It focuses on [integration, not isol
386386
### [How do I customize secureblue?](#customization)
387387
{: #customization}
388388

389-
If you want to add your own customizations on top of secureblue that go beyond installing packages, you are advised strongly against forking. Instead, create a repo for your own image by using the [BlueBuild template](https://github.com/blue-build/template), then change your `base-image` to a secureblue image. This allows you to apply your customizations to secureblue in a concise and maintainable way, without the need to constantly sync with upstream. For local development, [building locally](/contributing#building-locally) is the recommended approach.
389+
If you want to add your own customizations on top of secureblue that go beyond installing packages, unless you are [contributing](/contributing), you are advised strongly against forking. Instead, create a repo for your own image by using the [BlueBuild template](https://github.com/blue-build/template), then change your `base-image` to a secureblue image. This allows you to apply your customizations to secureblue in a concise and maintainable way, without the need to constantly sync with upstream. For secureblue development purposes, forking then [building with GitHub Actions](/contributing#building-ga) is the recommended approach.
390390

391391
### [How do I add a repo?](#adding-repos)
392392
{: #adding-repos}

0 commit comments

Comments
 (0)