Skip to content

Commit

Permalink
Stop keeping the READMEs in the repo
Browse files Browse the repository at this point in the history
- Removed the helm.yml workflow
- Removed bin/helm-docs-diff, not used anywhere
- Updated the helm-publish action to use helm-docs from the setup-tools action
- Removed the generated charts `README.md` files; people can consult the `values.yaml` files directly, or the generated READMEs at https://artifacthub.io/
- Uptaded the `BUILD.md` file to remove instructions about helm-docs.
  • Loading branch information
alpeb committed Dec 13, 2024
1 parent 8da4e17 commit c689e58
Show file tree
Hide file tree
Showing 12 changed files with 4 additions and 1,092 deletions.
2 changes: 2 additions & 0 deletions .github/actions/helm-publish/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@ runs:
steps:
- name: Set up Cloud SDK
uses: 'google-github-actions/setup-gcloud@e30db14379863a8c79331b04a9969f4c1e225e0b'
- uses: linkerd/dev/actions/setup-tools@v44
- shell: bash
run: |
mkdir -p target/helm
gsutil cp gs://helm.linkerd.io/edge/index.yaml target/helm/index-pre.yaml
bin/helm-bump-edge
helm-docs
bin/helm-build package
cp charts/artifacthub-repo-edge.yml target/helm/artifacthub-repo.yml
gsutil rsync target/helm gs://helm.linkerd.io/edge
22 changes: 0 additions & 22 deletions .github/workflows/helm.yml

This file was deleted.

30 changes: 2 additions & 28 deletions BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,6 @@ about testing from source can be found in the [TEST.md](TEST.md) guide.
- [Linkerd Helm Chart](#linkerd-helm-chart)
- [Extensions Helm charts](#extensions-helm-charts)
- [Making changes to the chart templates](#making-changes-to-the-chart-templates)
- [Generating Helm charts docs](#generating-helm-charts-docs)
- [Using helm-docs](#using-helm-docs)
- [Annotating values.yaml](#annotating-valuesyaml)
- [Markdown templates](#markdown-templates)

Expand Down Expand Up @@ -509,31 +507,7 @@ Whenever you make changes to the files under
[`bin/helm-build`](bin/helm-build) which will refresh the dependencies and lint
the templates.

### Generating Helm charts docs

Whenever a new chart is created or updated a README should be generated from the
chart's `values.yaml`. This can be done by utilizing
[helm-docs](https://github.com/norwoodj/helm-docs) (included in the dev
container). For adding additional information, such as specific installation
instructions a README template is required to be created. Check existing charts
for examples.
#### Using helm-docs
Example usage:
```sh
helm-docs
helm-docs --dry-run #Prints to cli instead
helm-docs --chart-search-root=./charts #Sets search root for charts
helm-docs --template-files=README.md.gotmpl #Sets the template file used
```
Note:
The tool searches through the current directory and sub-directories by default.
For additional information checkout their repo above.
#### Annotating values.yaml
### Annotating values.yaml

To allow helm-docs to properly document the values in `values.yaml` a descriptive
comment is required. This can be done in two ways.
Expand All @@ -542,7 +516,7 @@ Either comment the value directly above with
annotates the value. Another explicit usage is to type out the value name.
`# global.MyNiceValue -- I really like this value`

#### Markdown templates
### Markdown templates

In order to accommodate for extra data that might not have a proper place in the
´values.yaml´ file the corresponding ´README.md.gotmpl´ can be modified for each
Expand Down
15 changes: 0 additions & 15 deletions bin/helm-docs-diff

This file was deleted.

325 changes: 0 additions & 325 deletions charts/linkerd-control-plane/README.md

This file was deleted.

73 changes: 0 additions & 73 deletions charts/linkerd-crds/README.md

This file was deleted.

71 changes: 0 additions & 71 deletions charts/linkerd2-cni/README.md

This file was deleted.

9 changes: 0 additions & 9 deletions charts/partials/README.md

This file was deleted.

Loading

0 comments on commit c689e58

Please sign in to comment.