Skip to content

Commit 39345f3

Browse files
damdonrb
andauthored
📖 Add documentation for nightly builds (#4968)
* add documentation for nightly builds * Update docs/book/src/development/nightlies.md Co-authored-by: Nolan Brubaker <[email protected]> * Update docs/book/src/development/nightlies.md Co-authored-by: Nolan Brubaker <[email protected]> * Update docs/book/src/development/nightlies.md Co-authored-by: Nolan Brubaker <[email protected]> --------- Co-authored-by: Nolan Brubaker <[email protected]>
1 parent 7c58cfd commit 39345f3

File tree

2 files changed

+34
-0
lines changed

2 files changed

+34
-0
lines changed

docs/book/src/SUMMARY_SUFFIX.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
- [Development with Tilt](./development/tilt-setup.md)
33
- [Developing E2E tests](./development/e2e.md)
44
- [Coding Conventions](./development/conventions.md)
5+
- [Try unreleased changes with Nightly Builds](./development/nightlies.md)
56
- [CRD Reference](./crd/index.md)
67
- [Reference](./topics/reference/reference.md)
78
- [Glossary](./topics/reference/glossary.md)
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Nightly Builds
2+
3+
Nightly builds are regular automated builds of the CAPA source code that occur every night.
4+
5+
These builds are generated directly from the latest commit of source code on the main branch.
6+
7+
Nightly builds serve several purposes:
8+
9+
- **Early Testing**: They provide an opportunity for developers and testers to access the most recent changes in the codebase and identify any issues or bugs that may have been introduced.
10+
- **Feedback Loop**: They facilitate a rapid feedback loop, enabling developers to receive feedback on their changes quickly, allowing them to iterate and improve the code more efficiently.
11+
- **Preview of New Features**: Users and can get a preview of upcoming features or changes by testing nightly builds, although these builds may not always be stable enough for production use.
12+
13+
Overall, nightly builds play a crucial role in software development by promoting user testing, early bug detection, and rapid iteration.
14+
15+
CAPA Nightly build jobs run in Prow. For details on how this is configured you can check the [Periodics Jobs section](../topics/reference/jobs.md#periodics).
16+
17+
## Usage
18+
19+
To try a nightly build, you can download the latest built nightly CAPA manifests, you can find the available ones by executing the following command:
20+
```bash
21+
curl -sL -H 'Accept: application/json' "https://storage.googleapis.com/storage/v1/b/k8s-staging-cluster-api-aws/o" | jq -r '.items | map(select(.name | startswith("components/nightly_main"))) | .[] | [.timeCreated,.mediaLink] | @tsv'
22+
```
23+
The output should look something like this:
24+
```
25+
2024-05-03T08:03:09.087Z https://storage.googleapis.com/download/storage/v1/b/k8s-staging-cluster-api-aws/o/components%2Fnightly_main_2024050x?generation=1714723389033961&alt=media
26+
2024-05-04T08:02:52.517Z https://storage.googleapis.com/download/storage/v1/b/k8s-staging-cluster-api-aws/o/components%2Fnightly_main_2024050y?generation=1714809772486582&alt=media
27+
2024-05-05T08:02:45.840Z https://storage.googleapis.com/download/storage/v1/b/k8s-staging-cluster-api-aws/o/components%2Fnightly_main_2024050z?generation=1714896165803510&alt=media
28+
```
29+
30+
Now visit the link for the manifest you want to download. This will automatically download the manifest for you.
31+
32+
Once downloaded you can apply the manifest directly to your testing CAPI management cluster/namespace (e.g. with kubectl), as the downloaded CAPA manifest
33+
will already contain the correct, corresponding CAPA nightly image reference.

0 commit comments

Comments
 (0)