Improve README.md and the release.yml workflow
#13
Conversation
There was a problem hiding this comment.
Pull request overview
This PR enhances the repository documentation and release automation by adding installation instructions to the README and automating version updates in the release workflow.
Changes:
- Added an Installation section to README.md with Helm chart installation instructions
- Enhanced the release workflow to include clearer step naming and automatic README version updates
- Improved release notes to clarify CRD installation requirements
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Adds Installation section with Helm chart command and CRD installation notes |
| .github/workflows/release.yml | Adds step name for GitHub release creation, expands release notes with CRD information, and automates README version updates |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
ThoSap
force-pushed
the
improve-readme-and-release-notes
branch
from
583788b to
472f9cf
Compare
operator/src/main/helm/LICENSE
Outdated
| @@ -0,0 +1,7 @@ | |||
| Copyright About Bits GmbH | |||
There was a problem hiding this comment.
| Copyright About Bits GmbH | |
| Copyright AboutBits GmbH |
There was a problem hiding this comment.
We need to fix this is every project readme, this is also like this in for example https://github.com/aboutbits/react-ui/blob/main/license.md
There was a problem hiding this comment.
My fault. Then I would leave it. Thank you
There was a problem hiding this comment.
I already changed it. Should I revert it?
I saw your comment too late.
operator/src/main/helm/LICENSE
Outdated
There was a problem hiding this comment.
MIT, the one we also use here https://github.com/aboutbits/react-ui/blob/main/license.md
This was added here, so also in the resulting Helm chart *.tgz file, we include the LICENSE file.
README.md
Outdated
| ### Helm Chart | ||
|
|
||
| ```bash | ||
| helm install postgresql-operator https://github.com/AboutBits/postgresql-operator/releases/download/v0.1.1/postgresql-operator-0.1.1.tgz |
There was a problem hiding this comment.
| 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 |
There was a problem hiding this comment.
This was technically right as the username is AboutBits, but URLs should preferably always be lowercase
https://github.com/AboutBits/
| 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 |
There was a problem hiding this comment.
Is this also working as expected when the release is performed on another branch than the main branch?
There was a problem hiding this comment.
See #13 (comment)
Added the comment on the wrong review feedback comment.
.github/workflows/release.yml
Outdated
| - name: Create GitHub Release | ||
| uses: aboutbits/github-actions-base/github-create-release@v2 |
There was a problem hiding this comment.
| - 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?
There was a problem hiding this comment.
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: inheritso the release workflow only runs against main.
The build-and-release stage depends on test, so the whole build would fail.
LICENSE
Outdated
| @@ -1,4 +1,4 @@ | |||
| Copyright About Bits GmbH | |||
| Copyright AboutBits GmbH | |||
There was a problem hiding this comment.
| Copyright AboutBits GmbH | |
| Copyright About Bits GmbH |
Sorry, the other comment was my fault. But I would keep it consistent with the other projects. You were totally right here.
This reverts commit 5a639a7.
No description provided.