Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions .github/workflows/docs-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,27 @@ name: Documentation Quality Check

on:
pull_request:
branches: [main, docs-ng]
branches: [main]
types: [opened, synchronize, reopened, closed]
paths:
- 'docs/**'
push:
branches: [main, docs-ng]
branches: [main]
paths:
- 'docs/**'

jobs:
docs-checks:
# Skip checks on closed PRs (only need the notification)
if: github.event_name != 'pull_request' || github.event.action != 'closed'
uses: gardenlinux/docs-ng/.github/workflows/docs-checks.yml@main
uses: gardenlinux/docs/.github/workflows/docs-checks.yml@main
with:
override-repo: ${{ github.event.repository.name }}
override-ref: ${{ github.head_ref || github.ref_name }}
override-commit: ${{ github.event.pull_request.head.sha || github.sha }}

notify-docs-ng:
name: Notify docs-ng
notify-docs:
name: Notify docs
needs: [docs-checks]
runs-on: ubuntu-24.04
# Only notify for PR events (not push events which lack PR context)
Expand All @@ -41,9 +41,9 @@ jobs:
with:
app-id: ${{ secrets.DOCS_BOT_APP_ID }}
private-key: ${{ secrets.DOCS_BOT_PRIVATE_KEY }}
repositories: docs-ng
repositories: docs

- name: Send repository dispatch to docs-ng
- name: Send repository dispatch to docs
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
with:
github-token: ${{ steps.app-token.outputs.token }}
Expand All @@ -59,7 +59,7 @@ jobs:

await github.rest.repos.createDispatchEvent({
owner: 'gardenlinux',
repo: 'docs-ng',
repo: 'docs',
event_type: 'docs-pr',
client_payload: {
repo: '${{ github.event.repository.name }}',
Expand All @@ -71,4 +71,4 @@ jobs:
event: isMergedPR ? 'merged' : 'pr_success'
}
});
core.info('Repository dispatch sent to docs-ng');
core.info('Repository dispatch sent to docs');
31 changes: 15 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,27 @@ delegates all internal build steps to it. As a result, the only hard dependency
on the host system is a working container engine — no specific Linux
distribution, compiler toolchain, or package set is required on the build host.

If you want to use a modified builder docker image, you can edit your changes into the `Dockerfile` and run the image build with
```
cd gardenlinux
./build --container-image localhost/builder aws-gardener_prod
```

## SBOM Generation

After image build time a Software Bill of Materials (SBOM) is created in CycloneDX JSON-format. To produce the SBOM a tool called `syft` is downloaded during build container time. To verify the integrity the offloaded checksums file is included in the builder's directory. To update to a newer syft-release update the container ARG in the `Dockerfile` and update the checksums-file for this release as well.

## Documentation

For
[explanations](https://gardenlinux-docs.netlify.app/explanation/builder.html) on
[explanations](https://docs.gardenlinux.org/explanation/builder.html) on
the structure of our build system,
[references](https://gardenlinux-docs.netlify.app/reference/builder.html) of
[references](https://docs.gardenlinux.org/reference/builder.html) of
builder's CLI interface and detailed
[how-to guides](https://gardenlinux-docs.netlify.app/how-to/building-images.html)
[how-to guides](https://docs.gardenlinux.org/how-to/building-images.html)
on how to build images for different
[flavors](https://gardenlinux-docs.netlify.app/explanation/flavors.html), visit
our [documentation](https://gardenlinux-docs.netlify.app/).
[flavors](https://docs.gardenlinux.org/explanation/flavors.html), visit
our [documentation](https://docs.gardenlinux.org/).

# Community

Expand All @@ -40,17 +50,6 @@ For embargoed security related topics, this list is for you:

https://lists.neonephos.org/g/gardenlinux-security-embargo


If you want to use a modified builder docker image, you can edit your changes into the `Dockerfile` and run the image build with
```
cd gardenlinux
./build --container-image localhost/builder aws-gardener_prod
```

## SBOM Generation

After image build time a Software Bill of Materials (SBOM) is created in CycloneDX JSON-format. To produce the SBOM a tool called `syft` is downloaded during build container time. To verify the integrity the offloaded checksums file is included in the builder's directory. To update to a newer syft-release update the container ARG in the `Dockerfile` and update the checksums-file for this release as well.

## Licensing

Copyright 2025 SAP SE or an SAP affiliate company and GardenLinux contributors.
Expand Down
Loading