Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sgibson91/bump-helm-deps-action
GitHub Action to update dependencies of a Helm Chart
https://github.com/sgibson91/bump-helm-deps-action
action dependency dependency-manager docker dockerfile github-action helm helm-chart python python3
Last synced: 3 months ago
JSON representation
GitHub Action to update dependencies of a Helm Chart
- Host: GitHub
- URL: https://github.com/sgibson91/bump-helm-deps-action
- Owner: sgibson91
- License: mit
- Created: 2021-10-08T10:53:26.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-08T14:23:37.000Z (4 months ago)
- Last Synced: 2024-10-12T15:08:31.026Z (4 months ago)
- Topics: action, dependency, dependency-manager, docker, dockerfile, github-action, helm, helm-chart, python, python3
- Language: Python
- Homepage:
- Size: 670 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Bump Helm Chart Dependencies
This is an GitHub Action that will check the chart dependencies of a Helm chart are up to date with their source.
If a new version is available, the Action will open a Pull Request inserting the new chart dependency versions into the helm chart file.
[](https://github.com/sgibson91/bump-helm-deps-action/actions/workflows/ci.yaml) [](https://results.pre-commit.ci/latest/github/sgibson91/bump-helm-deps-action/main) [](https://codecov.io/gh/sgibson91/bump-helm-deps-action)  [](CODE_OF_CONDUCT.md) [](CONTRIBUTING.md)
**Table of Contents:**
- [:mag: Overview](#mag-overview)
- [🤔 Assumptions `bump-helm-deps` Makes](#-assumptions-bump-helm-deps-makes)
- [:inbox_tray: Inputs](#inbox_tray-inputs)
- [:lock: Permissions](#lock-permissions)
- [:recycle: Example Usage](#recycle-example-usage)
- [:gift: Acknowledgements](#gift-acknowledgements)
- [:sparkles: Contributing](#sparkles-contributing)
---
## :mag: Overview
This is an overview of the steps the Action executes.
- Read the helm chart file and find the versions of the dependencies
- Scrape the helm chart source indexes and find the most recent version release for each dependency
- If there is a newer chart version available, then:
- Create a new branch in the repository
- Add the new version(s) to the helm chart file
- Commit the file to the branch
- Open a Pull Request to the default branch
- Assign labels and reviewers to the Pull Request if required
A moderator should check and merge the Pull Request as appropriate.
## 🤔 Assumptions `bump-helm-deps` Makes
Here is a list detailing the assumptions that the Action makes.
1. You have a GitHub Token with enough permissions to access the GitHub API and create branches, commits and Pull Requests
2. The configuration for your helm chart is available in a **public** GitHub repository, or you have a token with sufficient permissions to read/write to a **private** repository
3. The dependent chart indexes are available at public URLs
## :inbox_tray: Inputs
| Variable | Description | Required? | Default Value |
| :--- | :--- | :--- | :--- |
| `chart_path` | The path to the file that stores the helm chart dependencies | :white_check_mark: | - |
| `chart_urls` | A string-serialised dictionary storing the location of the dependent and their versions. E.g. `'{"binderhub": "https://raw.githubusercontent.com/jupyterhub/helm-chart/gh-pages/index.yaml"}'` | :white_check_mark: | - |
| `github_token` | A GitHub token to make requests to the API with. Requires write permissions to: create new branches, make commits, and open Pull Requests. | :x: | `${{github.token}}` |
| `repository` | The GitHub repository where the helm chart is stored | :x: | `${{github.repository}}` |
| `base_branch` | The base branch to open the Pull Request against | :x: | `main` |
| `head_branch` | The branch to commit to and open a Pull Request from | :x: | `bump-helm-deps/{{ chart name }}/WXYZ` where `chart name` is derived from the `chart_path`, and `WXYZ` will be a randomly generated ascii string (to avoid clashes) |
| `labels` | A comma-separated list of labels to apply to the opened Pull Request. Labels must already exist in the repository. | :x: | `[]` |
| `reviewers` | A comma-separated list of GitHub users (without the leading `@`) to request reviews from | :x: | `[]` |
| `team_reviewers` | A comma-separated list of GitHub teams to request reviews from | :x: | `[]` |
| `dry_run` | Perform a dry-run of the action. A Pull Request will not be opened, but a log message will indicate if any helm chart versions can be bumped. | :x: | `False` |
## :lock: Permissions
This Action will need permission to read the contents of a file stored in your repository, create a new branch, commit to that branch, and open a Pull Request.
The [default permissive settings of `GITHUB_TOKEN`](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) should provide the relevant permissions.
If instead your repository is using the default restricted settings of `GITHUB_TOKEN`, you could grant just enough permissions to the Action using a [`permissions`](https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idpermissions) config, such as the one below:
```yaml
permissions:
contents: write
pull-requests: write
```
## :recycle: Example Usage
The simplest way to use the Action is documented below.
This config features a `workflow_dispatch` trigger to allow manual running whenever the maintainers desire, and a cron job trigger scheduled to run at 10am every weekday.
```yaml
name: Check and Bump Helm Chart Dependencies
on:
workflow_dispath:
schedule:
- cron: "0 10 * * 1-5"
jobs:
bump-helm-deps:
runs-on: ubuntu-latest
steps:
- uses: sgibson91/bump-helm-deps-action@main
with:
chart_path: path/to/config
chart_urls: '{"chart_1": "https://example.com/chart_1/index.yaml"}'
```
## :gift: Acknowledgements
Thank you to Christopher Hench ([@henchc](https://github.com/henchc)) who wrote and documented [`henchbot`](https://github.com/henchbot) which automatically opens Pull Requests to upgrade mybinder.org.
[Give his blog post a read!](https://hackmd.io/qC4ooA5TTn6xA2w-2OLHbA)
## :sparkles: Contributing
Thank you for wanting to contribute to the project! :tada:
Please read our [Code of Conduct](CODE_OF_CONDUCT.md) :purple_heart: and [Contributing Guidelines](CONTRIBUTING.md) :space_invader: to get you started.