Skip to content

Improve README.md and the release.yml workflow #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ThoSap merged 8 commits into from
Jan 29, 2026
Merged

Improve README.md and the release.yml workflow #13

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2136b88
improve README.md and the release.yml workflow
ThoSap Jan 29, 2026
893d716
add a section describing on how to generated the pg_catalog jOOQ sources
ThoSap Jan 29, 2026
24925b2
add declarative management section to the README.md
ThoSap Jan 29, 2026
472f9cf
improve wording
ThoSap Jan 29, 2026
e463771
fix the release.yml workflow
ThoSap Jan 29, 2026
5a639a7
fix company name in file LICENSE
ThoSap Jan 29, 2026
8aab37a
lowercase the URLs
ThoSap Jan 29, 2026
128f7f9
Revert "fix company name in file LICENSE"
ThoSap Jan 29, 2026
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
14 changes: 13 additions & 1 deletion .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ jobs:
- name: Push tag to remote
run: ./gradlew --console=colored pushRelease
shell: bash
- uses: aboutbits/github-actions-base/github-create-release@v2
- name: Create GitHub Release
uses: aboutbits/github-actions-base/github-create-release@v2

@alexlanz alexlanz Jan 29, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- name: Create GitHub Release
uses: aboutbits/github-actions-base/github-create-release@v2
- uses: aboutbits/github-actions-base/github-create-release@v2

Just a minor thing, but I had the rule of thumb that I only provide a message when I don't use another action. Because the action itself has then the different steps descriped. I would follow this rule. Can you please adjust it also for the other steps in this project?

@ThoSap ThoSap Jan 29, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I don't see why this should not work on other branches.
But we usually should only run the release.yml Workflow only against main.

We could add something like

    jobs:
      test:
        if: github.ref == 'refs/heads/main'
        uses: ./.github/workflows/test.yml
        secrets: inherit

so the release workflow only runs against main.

The build-and-release stage depends on test, so the whole build would fail.

image

@ThoSap ThoSap Jan 29, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

with:
tag-name: 'v${{ steps.nextVersion.outputs.version }}'
release-description: |
Expand All @@ -70,6 +71,9 @@ jobs:
helm install postgresql-operator https://github.com/${{ github.repository }}/releases/download/v${{ steps.nextVersion.outputs.version }}/postgresql-operator-${{ steps.nextVersion.outputs.version }}.tgz
```

With the Helm chart, the Custom Resource Definitions (CRDs) are installed automatically.
However, if you deploy the operator directly from the OCI image, the CRDs are not automatically applied and must be installed separately.

### Manual CRD Installation
```bash
kubectl apply -f https://github.com/${{ github.repository }}/releases/download/v${{ steps.nextVersion.outputs.version }}/clusterconnections.postgresql.aboutbits.it-v1.yml
Expand All @@ -86,3 +90,11 @@ jobs:
run: |
gh release upload v${{ steps.nextVersion.outputs.version }} operator/build/helm/kubernetes/*.tgz operator/build/kubernetes/*.postgresql.aboutbits.it-v1.yml
shell: bash
- name: Update README.md

@alexlanz alexlanz Jan 29, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this also working as expected when the release is performed on another branch than the main branch?

@ThoSap ThoSap Jan 29, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See #13 (comment)

Added the comment on the wrong review feedback comment.

run: |
sed -i "s|releases/download/v[0-9.]*/postgresql-operator-[0-9.]*.tgz|releases/download/v${{ steps.nextVersion.outputs.version }}/postgresql-operator-${{ steps.nextVersion.outputs.version }}.tgz|g" README.md
Comment thread
ThoSap marked this conversation as resolved.
git add README.md
# Guard against failing if there are no changes
git diff-index --quiet HEAD || git commit -m "Update README.md with version ${{ steps.nextVersion.outputs.version }}"
Comment thread
ThoSap marked this conversation as resolved.
Outdated
Comment thread
ThoSap marked this conversation as resolved.
Outdated
git push
Comment thread
ThoSap marked this conversation as resolved.
shell: bash
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,18 @@ AboutBits PostgreSQL Operator is a Kubernetes operator that helps you manage Pos
└──────────────────────────────────────────────────────────────────────────┘
```

## Installation

### Helm Chart

```bash
helm install postgresql-operator https://github.com/AboutBits/postgresql-operator/releases/download/v0.1.1/postgresql-operator-0.1.1.tgz

@alexlanz alexlanz Jan 29, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
helm install postgresql-operator https://github.com/AboutBits/postgresql-operator/releases/download/v0.1.1/postgresql-operator-0.1.1.tgz
helm install postgresql-operator https://github.com/aboutbits/postgresql-operator/releases/download/v0.1.1/postgresql-operator-0.1.1.tgz

@ThoSap ThoSap Jan 29, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was technically right as the username is AboutBits, but URLs should preferably always be lowercase
https://github.com/AboutBits/

```

With the Helm chart, the Custom Resource Definitions (CRDs) are installed automatically.
However, if you deploy the operator directly from the OCI image, the CRDs are not automatically applied and must be installed separately.
See the release notes for the [latest version](https://github.com/AboutBits/postgresql-operator/releases/latest) for more information.
Comment thread
ThoSap marked this conversation as resolved.
Outdated

## Usage

This operator allows you to manage PostgreSQL resources using Kubernetes manifests.
Expand Down