Skip to content

Commit

Permalink
docs: improve README (#52)
Browse files Browse the repository at this point in the history
Signed-off-by: Gabriele Bartolini <[email protected]>
  • Loading branch information
gbartolini authored Aug 31, 2024
1 parent 04726e2 commit e976045
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 11 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build-commitfest.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Build Commitfest Container Images
name: Container Images from Commitest patch

on:
workflow_dispatch:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Build Postgres Container Images from sources
name: Container Images from PostgreSQL sources

on:
workflow_dispatch:
Expand Down
52 changes: 43 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,52 @@
# E2E tests for PostgreSQL Trunk Container Images
# Building PostgreSQL Container Images from the Development Trunk

This repository contains a Continuous Delivery workflow which runs daily and that:
This CloudNativePG project is designed to build PostgreSQL container images
directly from the PostgreSQL source code, providing developers with a seamless
way to test and deploy their patches in Kubernetes environments.

* Builds the latest snapshot image of the main trunk of the PostgreSQL server
* Runs the CloudNativePG E2E test suite using the latest main of the operator
By default, these images are built from the `master` branch of the official
PostgreSQL repository, commonly known as the *trunk*. However, you can also
leverage additional workflows to:

## License and copyright
- Build images from a specific branch in any PostgreSQL repository publicly
accessible
- Build images from a selected patch in a PostgreSQL Commitfest

This software is available under [Apache License 2.0](LICENSE).
Additionally, these container images can be used to run the suite of end-to-end
(E2E) tests of CloudNativePG through the continuous delivery workflow.

Copyright The CloudNativePG Contributors.
The primary goal of this project is to provide daily feedback on the status of
the PostgreSQL trunk, helping to identify and address regressions early in the
development process.

## How to Build a Container Image for Your PostgreSQL Patch

If you are developing a patch for PostgreSQL and want a quick way to test it in
Kubernetes with CloudNativePG, you can fork this project on GitHub. From there,
navigate to the "Actions" menu and run the relevant workflow called "Container
Images from PostgreSQL sources", specifying your Git repository and branch.

The action summary provides all the details you need to effectively use the
image.

## How to Build a Container Image for a Patch in the Commitfest

If you're interested in testing a PostgreSQL patch from a Commitfest in
Kubernetes with CloudNativePG, you can fork this project on GitHub. Then, run
the designated workflow called "Container Images from Commitfest patch" from the
"Actions" menu, entering the Commitfest ID and patch ID.

The action summary provides all the details you need to effectively use the
image.

## License and Copyright

This software is licensed under the [Apache License 2.0](LICENSE).

Copyright © The CloudNativePG Contributors.

## Trademarks

*[Postgres, PostgreSQL and the Slonik Logo](https://www.postgresql.org/about/policies/trademarks/)
*[Postgres, PostgreSQL, and the Slonik Logo](https://www.postgresql.org/about/policies/trademarks/)
are trademarks or registered trademarks of the PostgreSQL Community Association
of Canada, and used with their permission.*
of Canada and are used with their permission.*

0 comments on commit e976045

Please sign in to comment.