From d8d44c5e3be7bd3ee7d09ba8fe73819b08f0a707 Mon Sep 17 00:00:00 2001 From: Jason Meridth Date: Sun, 7 May 2023 00:07:58 -0500 Subject: [PATCH] chore(github): Update and clean-up github pages branch (#2016) chore(github): Update and clean-up github pages - [x] update README with latest from main but ensure paths are absolute and not relative (they will 404 like they are now) - [x] drop `.circleci` folder Signed-off-by: jmeridth --- .circleci/config.yml | 17 ----------------- README.md | 33 +++++++++++++++++++++++++++++++-- 2 files changed, 31 insertions(+), 19 deletions(-) delete mode 100644 .circleci/config.yml diff --git a/.circleci/config.yml b/.circleci/config.yml deleted file mode 100644 index 3e4b2958..00000000 --- a/.circleci/config.yml +++ /dev/null @@ -1,17 +0,0 @@ -version: 2.1 -jobs: - noop: - docker: - - image: bash - steps: - - run: echo "CircleCI is disabled on gh-pages branch" - -workflows: - version: 2 - gh-pages: - jobs: - - noop: - filters: - branches: - ignore: - - gh-pages diff --git a/README.md b/README.md index 5ecf8d4e..ea860487 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,43 @@ # Argo Helm Charts +[![Slack](https://img.shields.io/badge/slack-%23argo--helm--charts-brightgreen.svg?logo=slack)](https://argoproj.github.io/community/join-slack) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Chart Publish](https://github.com/argoproj/argo-helm/actions/workflows/publish.yml/badge.svg?branch=main)](https://github.com/argoproj/argo-helm/actions/workflows/publish.yml) +[![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/argo)](https://artifacthub.io/packages/search?repo=argo) +[![CLOMonitor](https://img.shields.io/endpoint?url=https://clomonitor.io/api/projects/cncf/argo/badge)](https://clomonitor.io/projects/cncf/argo) +[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/argoproj/argo-helm/badge)](https://api.securityscorecards.dev/projects/github.com/argoproj/argo-helm) Argo Helm is a collection of **community maintained** charts for [https://argoproj.github.io](https://argoproj.github.io) projects. The charts can be added using following command: -``` +```bash helm repo add argo https://argoproj.github.io/argo-helm ``` ## Contributing -We'd love to have you contribute! Please refer to our [contribution guidelines](CONTRIBUTING.md) for details. +We'd love to have you contribute! Please refer to our [contribution guidelines](https://github.com/argoproj/argo-helm/blob/main/CONTRIBUTING.md) for details. + +### Custom resource definitions + +Some users would prefer to install the CRDs _outside_ of the chart. You can disable the CRD installation of the main four charts (argo-cd, argo-workflows, argo-events, argo-rollouts) by using `--set crds.install=false` when installing the chart. + +Helm cannot upgrade custom resource definitions in the `/crds` folder [by design](https://helm.sh/docs/chart_best_practices/custom_resource_definitions/#some-caveats-and-explanations). Our CRDs have been moved to `/templates` to address this design decision. + +If you are using versions of a chart that have the CRDs in the root of the chart or have elected to manage the Argo Workflows CRDs outside of the chart, please use `kubectl` to upgrade CRDs manually from [templates/crds](templates/crds/) folder or via the manifests from the upstream project repo: + +Example: + +```bash +kubectl apply -k "https://github.com/argoproj/argo-cd/manifests/crds?ref=" + +# Eg. version v2.4.9 +kubectl apply -k "https://github.com/argoproj/argo-cd/manifests/crds?ref=v2.4.9" +``` + +### Security Policy + +Please refer to [SECURITY.md](https://github.com/argoproj/argo-helm/blob/main/SECURITY.md) for details on how to report security issues. + +### Changelog + +Releases are managed independently for each helm chart, and changelogs are tracked on each release. Read more about this process [here](https://github.com/argoproj/argo-helm/blob/main/CONTRIBUTING.md#changelog).