This action checks that all the Helm Charts in the repository have a category and the category belongs to a pre-defined list of categories.
The categories should be set at the Chart.yaml file in the way:
annotations:
category: category-nameRequired The command to pass to the category-checker.sh script. Default: check-categories. (At this moment only check-categories is supported)
The path to the file containing the categories inside your Helm Chart repository. Default: CHART_CATEGORIES.
Whether or not the changed Helm Charts have a correct category.
check-categories:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Fetch history
run: git fetch --prune --unshallow
- name: Check categories
uses: bitnami/chart-categories-action@master
with:
command: 'check-categories'
categories-file: 'my_Categories_file'See: https://github.com/bitnami/charts/blob/master/.github/workflows/lint-test.yaml
- Add option to pass your own list of categories.
Build the docker image:
docker build . -t <image-name>
Run the image mounting your Helm Charts repository:
docker run --rm -v <absolute-path-to-your-repo>:/github/workspace --workdir /github/workspace -it <image-name> check-categories
Copyright © 2024 Broadcom. The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.