[bitnami/*] ci: 👷 Add tag and changelog support #25359

javsalgar · 2024-04-24T11:39:52Z

Signed-off-by: Javier Salmeron Garcia jsalmeron@vmware.com

Description of the change

This PR improves the traceability of bitnami/charts changes by performing the following changes in our GitHub workflows:

ci-pipeline.yaml: We extend the "Update README and CRDs" job also to generate a CHANGELOG.md file using conventional-changelogs-cli. Normally, CHANGELOG.md files are updated in a separate commit of the kind "cut release x.y.z", where a tag is created as well. However, due to the nature of our repository, changing it in a subsequent commit would imply doubling the number of commits in the repo, which would have high-performance penalties down the line. In this example we see what the CHANGELOG.md would look like.

## <small>6.2.3 (2024-05-21)</small>

* [bitnami/*] ci: :construction_worker: Add tag and changelog support (#25359) ([91c707c](https://github.com/bitnami/charts/commit/91c707c)), closes [#25359](https://github.com/bitnami/charts/issues/25359)
* [bitnami/argo-cd] Release 6.2.3 (#26100) ([881a692](https://github.com/bitnami/charts/commit/881a692)), closes [#26100](https://github.com/bitnami/charts/issues/26100)

## <small>6.2.2 (2024-05-13)</small>

* [bitnami/argo-cd] Release 6.2.2 updating components versions (#25749) ([9bc1029](https://github.com/bitnami/charts/commit/9bc1029)), closes [#25749](https://github.com/bitnami/charts/issues/25749)

cd-pipeline.yaml: If there is a chart change, it will tag the commit with the following format: APP/VERSION. This is a sample tag: https://github.com/bitnami/charts/releases/tag/spark%2F9.0.4

Benefits

More traceability of the chart

Possible drawbacks

Performance impact on the update README GitHub action

Applicable issues

fixes Provide changelog for charts #18903

Checklist

Chart version bumped in Chart.yaml according to semver. This is not necessary when the changes only affect README.md files.
Variables are documented in the values.yaml and added to the README.md using readme-generator-for-helm
Title of the pull request follows this pattern [bitnami/<name_of_the_chart>] Descriptive title
All commits signed off and in agreement of Developer Certificate of Origin (DCO)

Signed-off-by: Javier Salmeron Garcia <jsalmeron@vmware.com>

github-actions · 2024-05-15T01:24:55Z

This Pull Request has been automatically marked as "stale" because it has not had recent activity (for 15 days). It will be closed if no further activity occurs. Thank you for your contribution.

carrodher

Could you add those new CHANGELOG.md files to the .helmignore so they are not bundled into the tarball?

Signed-off-by: Javier Salmeron Garcia <jsalmeron@vmware.com>

rafariossaa

LGTM

fmulero

Great work @javsalgar!

I've just left some comments about the CD pipeline, Could you give it a glance?

fmulero · 2024-05-21T06:04:29Z

.github/workflows/cd-pipeline.yml

@@ -25,6 +25,7 @@ jobs:
        with:
          path: charts
          fetch-depth: 2 # to be able to obtain files changed in the latest commit
+          token: ${{ secrets.BITNAMI_BOT_TOKEN }}


Why is BITNAMI_BOT_TOKEN required? This could trigger other workflows, is that expected? If you need write access to the repository you can change the permissions section int the job definition.

charts/.github/workflows/cd-pipeline.yml

Lines 18 to 19 in ef3fea4

permissions:

contents: read

We need write access to push the tags

fmulero · 2024-05-21T06:23:41Z

.github/workflows/cd-pipeline.yml

@@ -59,6 +60,21 @@ jobs:
        with:
          script: |
              core.setFailed('${{ steps.get-chart.outputs.error }}')
+      - id: push-tag


Not sure if this is the best place to push the tag, at this point the chart is not yet published and the repository is not updated with the new version. We can reach a situation where the tag is created and the chart is not published. We could leave this job as read-only and create a new job depending on the update-index to push the tag if everything went well.

AFAIK, several in several repositories release jobs get triggered when a tag is set, right?

Signed-off-by: Javier Salmeron Garcia <jsalmeron@vmware.com>

fmulero

Great!!! Thanks a lot @javsalgar!

* [bitnami/*] chore: 👷 Add tag and changelog support Signed-off-by: Javier Salmeron Garcia <jsalmeron@vmware.com> * perf: ⚡ Avoid fetching the index branch Signed-off-by: Javier Salmeron Garcia <jsalmeron@vmware.com> * chore: 🔧 Do not scan CHANGELOG.md files Signed-off-by: Javier Salmeron Garcia <jsalmeron@vmware.com> * chore: 🙈 Update .helmignore files Signed-off-by: Javier Salmeron Garcia <jsalmeron@vmware.com> * refactor: ♻️ Separate push-tag section Signed-off-by: Javier Salmeron Garcia <jsalmeron@vmware.com> --------- Signed-off-by: Javier Salmeron Garcia <jsalmeron@vmware.com> Signed-off-by: Fran Mulero <fmulero@vmware.com>

lusu007 · 2024-05-25T19:13:19Z

Thank you for this change @javsalgar! It's much easier to see what's changed.

[bitnami/*] chore: 👷 Add tag and changelog support

28a1203

Signed-off-by: Javier Salmeron Garcia <jsalmeron@vmware.com>

bitnami-bot added the verify Execute verification workflow for these changes label Apr 24, 2024

github-actions bot added the bitnami label Apr 24, 2024

github-actions bot assigned jotamartos Apr 24, 2024

github-actions bot requested a review from jotamartos April 24, 2024 11:40

javsalgar mentioned this pull request Apr 24, 2024

Provide changelog for charts #18903

Closed

javsalgar requested a review from fmulero April 24, 2024 11:44

javsalgar assigned fmulero Apr 24, 2024

javsalgar removed the request for review from jotamartos April 24, 2024 11:44

javsalgar unassigned jotamartos Apr 24, 2024

carrodher requested a review from rafariossaa April 24, 2024 11:44

carrodher assigned rafariossaa Apr 24, 2024

carrodher marked this pull request as draft April 24, 2024 11:59

javsalgar added 2 commits April 29, 2024 16:18

perf: ⚡ Avoid fetching the index branch

9553899

Signed-off-by: Javier Salmeron Garcia <jsalmeron@vmware.com>

chore: 🔧 Do not scan CHANGELOG.md files

f4a3cb4

Signed-off-by: Javier Salmeron Garcia <jsalmeron@vmware.com>

carrodher mentioned this pull request May 13, 2024

Release notes, changelog on a chart by chart basis #25668

Closed

github-actions bot added the stale 15 days without activity label May 15, 2024

javsalgar removed the stale 15 days without activity label May 15, 2024

carrodher marked this pull request as ready for review May 16, 2024 12:23

carrodher reviewed May 16, 2024

View reviewed changes

javsalgar added 2 commits May 16, 2024 15:35

chore: 🙈 Update .helmignore files

e472bfe

Signed-off-by: Javier Salmeron Garcia <jsalmeron@vmware.com>

chore: 🔀 Merge branch 'main' into ci/changelogs-and-tags

e459d86

Signed-off-by: Javier Salmeron Garcia <jsalmeron@vmware.com>

carrodher previously approved these changes May 16, 2024

View reviewed changes

rafariossaa previously approved these changes May 20, 2024

View reviewed changes

fmulero reviewed May 21, 2024

View reviewed changes

refactor: ♻️ Separate push-tag section

9d7b2be

Signed-off-by: Javier Salmeron Garcia <jsalmeron@vmware.com>

javsalgar dismissed stale reviews from rafariossaa and carrodher via 9d7b2be May 21, 2024 08:18

fmulero approved these changes May 21, 2024

View reviewed changes

javsalgar merged commit 91c707c into main May 21, 2024
8 of 9 checks passed

javsalgar deleted the ci/changelogs-and-tags branch May 21, 2024 08:24

github-actions bot added the solved label May 21, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[bitnami/*] ci: 👷 Add tag and changelog support #25359

[bitnami/*] ci: 👷 Add tag and changelog support #25359

javsalgar commented Apr 24, 2024 •

edited by carrodher

github-actions bot commented May 15, 2024

carrodher left a comment

rafariossaa left a comment

fmulero left a comment

fmulero May 21, 2024

javsalgar May 21, 2024

fmulero May 21, 2024

javsalgar May 21, 2024

fmulero left a comment

lusu007 commented May 25, 2024 •

edited

[bitnami/*] ci: 👷 Add tag and changelog support #25359

[bitnami/*] ci: 👷 Add tag and changelog support #25359

Conversation

javsalgar commented Apr 24, 2024 • edited by carrodher

Description of the change

Benefits

Possible drawbacks

Applicable issues

Checklist

github-actions bot commented May 15, 2024

carrodher left a comment

Choose a reason for hiding this comment

rafariossaa left a comment

Choose a reason for hiding this comment

fmulero left a comment

Choose a reason for hiding this comment

fmulero May 21, 2024

Choose a reason for hiding this comment

javsalgar May 21, 2024

Choose a reason for hiding this comment

fmulero May 21, 2024

Choose a reason for hiding this comment

javsalgar May 21, 2024

Choose a reason for hiding this comment

fmulero left a comment

Choose a reason for hiding this comment

lusu007 commented May 25, 2024 • edited

javsalgar commented Apr 24, 2024 •

edited by carrodher

lusu007 commented May 25, 2024 •

edited