helm-version-updater

README

🔗 Table of Contents

• Why
• Usage
  • Build from Source
• Support & Assistance
• Contributing
• License

❔ Why

Multiple of my helm charts have their appVersion synced with docker images. With this GitHub action, I can easily automatically update the chart versions, even through a PR workflow.

⚙ Usage

Create a config file called ci-config.yaml in the directory where your Chart.yaml is located. The contents should look similar to this:

source:
  image: ghcr.io/user/some-image # standard registry image reference (without tag).

Create a workflow to run helm-version-updater

name: helm-version-updater

on:
  schedule:
    - cron: "0 13 * * *" # run once a day.
  workflow_dispatch: {} # be able to trigger manually.

jobs:
  helm-version-updater:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: lrstanley/helm-version-updater@latest
        with:
          check-dir: charts/
      # likely want to either commit after the above step, or use something like:
      #   - https://github.com/marketplace/actions/create-pull-request

---

Full list of supported options specified below.

input name	required	default	description
version	false	<latest-version>	Version of helm-version-updater to use (defaults to the same version as the action)
output-file	false	-	Output json file containing change set (- for stdout)
check-dir	false	.	Directory to recursively check for ci-config.yaml files
support-prerelease	false	false	Support pre-release tags as versions
dry-run	false	false	Do not write update Chart.yaml files, only output changeset

---

Check out the releases page for prebuilt versions of the binary.

Build from Source

Note that you must have Go installed (latest is usually best).

git clone https://github.com/lrstanley/helm-version-updater.git && cd helm-version-updater
make
./helm-version-updater --help

🙋♂ Support & Assistance

• ❤ Please review the Code of Conduct for guidelines on ensuring everyone has the best experience interacting with the community.
• 🙋♂ Take a look at the support document on guidelines for tips on how to ask the right questions.
• 🐞 For all features/bugs/issues/questions/etc, head over here.

🤝 Contributing

• ❤ Please review the Code of Conduct for guidelines on ensuring everyone has the best experience interacting with the community.
• 📋 Please review the contributing doc for submitting issues/a guide on submitting pull requests and helping out.
• 🗝 For anything security related, please review this repositories security policy.

⚖ License

MIT License

Copyright (c) 2023 Liam Stanley <me@liamstanley.io>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Also located here