rename .tools to tools
This commit is contained in:
8
.github/workflows/docs.copy.yaml
vendored
8
.github/workflows/docs.copy.yaml
vendored
@@ -9,9 +9,9 @@ on:
|
||||
- '**'
|
||||
paths:
|
||||
- 'library/**/Chart.yaml'
|
||||
- '.tools/gen-helm-docs.sh'
|
||||
- '.tools/templates/docs/**'
|
||||
- '.tools/templates/app/*.gotmpl'
|
||||
- 'tools/gen-helm-docs.sh'
|
||||
- 'tools/templates/docs/**'
|
||||
- 'tools/templates/app/*.gotmpl'
|
||||
- '**.gotmpl'
|
||||
- '**/LICENSE'
|
||||
- '**LICENSE'
|
||||
@@ -40,7 +40,7 @@ jobs:
|
||||
|
||||
- name: (re)generate docs
|
||||
run: |
|
||||
.tools/gen-helm-docs.sh
|
||||
tools/gen-helm-docs.sh
|
||||
|
||||
- name: Copy general readme to website
|
||||
run: |
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Chart.yaml layout
|
||||
|
||||
At TrueCharts we try to keep some files standardised, this enables us to make changes to these charts in bulk with less risk of mistakes. Chart.yaml is one of these files.
|
||||
In this documentation we will explain the standardised layout options. For an example layout, please see our standard Chart.yaml [template](https://github.com/truecharts/apps/tree/master/.tools/templates/chart/Chart.yaml)
|
||||
In this documentation we will explain the standardised layout options. For an example layout, please see our standard Chart.yaml [template](https://github.com/truecharts/apps/tree/master/tools/templates/chart/Chart.yaml)
|
||||
|
||||
|
||||
### Layout Explained
|
||||
@@ -44,7 +44,7 @@ annotations:
|
||||
|
||||
In the above description there are a lot of values that are not actually used. Some of those, like `deprecated`, we just set to false. While others, like `annotations` get commented out.
|
||||
|
||||
Please refer to our standard Chart.yaml [template](https://github.com/truecharts/apps/tree/master/.tools/templates/chart/Chart.yaml) to see which unused values needs which treatment.
|
||||
Please refer to our standard Chart.yaml [template](https://github.com/truecharts/apps/tree/master/tools/templates/chart/Chart.yaml) to see which unused values needs which treatment.
|
||||
|
||||
##### Dependencies
|
||||
|
||||
@@ -55,7 +55,7 @@ All other dependencies are expected to be listed in alphabetical order.
|
||||
##### Maintainers
|
||||
|
||||
The first maintainer should always be TrueCharts, as the TrueCharts core team is expected to step in if the other maintainers fail to maintain their work.
|
||||
An example of how to list TrueCharts as a maintainer is available in our standard Chart.yaml [template](https://github.com/truecharts/apps/tree/master/.tools/templates/chart/Chart.yaml).
|
||||
An example of how to list TrueCharts as a maintainer is available in our standard Chart.yaml [template](https://github.com/truecharts/apps/tree/master/tools/templates/chart/Chart.yaml).
|
||||
|
||||
While currently we primarily use the CODEOWNERS file to define maintainers. We might in the future either automate keeping track of maintainers, completely rely on the maintainers or do both. For this reason it's important to add yourself as a maintainer if you expect to maintain your work.
|
||||
All other maintainers are, ofcoarse, expected to be entered in importance. With the primary maintainer under "truecharts" and secondary maintainers thereunder.
|
||||
|
||||
@@ -85,7 +85,7 @@ Are you done downloading? Awesome! Now your local repo is automagically soul-lin
|
||||
|
||||
Pre-Commit makes sure to fix small warnings that might prevent us from merging your changes into our repo. For now it isn't really important why, how and what. But realise it does so in each step called "commit" in the future.
|
||||
|
||||
To setup Pre-Commit on windows, simply double click `.tools/pre-commit-install.bat`, on Linux you can install pre-commit by using `pip install pre-commit` and `pre-commit install` from the project top-most directory
|
||||
To setup Pre-Commit on windows, simply double click `tools/pre-commit-install.bat`, on Linux you can install pre-commit by using `pip install pre-commit` and `pre-commit install` from the project top-most directory
|
||||
|
||||
|
||||
### Opening the project and editing the project
|
||||
|
||||
0
.tools/copy-common.sh → tools/copy-common.sh
Executable file → Normal file
0
.tools/copy-common.sh → tools/copy-common.sh
Executable file → Normal file
8
.tools/gen-helm-docs.sh → tools/gen-helm-docs.sh
Executable file → Normal file
8
.tools/gen-helm-docs.sh → tools/gen-helm-docs.sh
Executable file → Normal file
@@ -14,8 +14,8 @@ command -v helm-docs >/dev/null 2>&1 || {
|
||||
repository=$(git rev-parse --show-toplevel)
|
||||
|
||||
# Templates to copy into each chart directory
|
||||
readme_template="${repository}/.tools/templates/docs/README.md.gotmpl"
|
||||
config_template="${repository}/.tools/templates/docs/CONFIG.md.gotmpl"
|
||||
readme_template="${repository}/tools/templates/docs/README.md.gotmpl"
|
||||
config_template="${repository}/tools/templates/docs/CONFIG.md.gotmpl"
|
||||
root="${repository}"
|
||||
|
||||
for train in stable incubator develop non-free deprecated; do
|
||||
@@ -27,12 +27,12 @@ for train in stable incubator develop non-free deprecated; do
|
||||
helm-docs \
|
||||
--ignore-file=".helmdocsignore" \
|
||||
--output-file="README.md" \
|
||||
--template-files="${repository}/.tools/templates/docs/README.md.gotmpl" \
|
||||
--template-files="${repository}/tools/templates/docs/README.md.gotmpl" \
|
||||
--chart-search-root="${chart}"
|
||||
helm-docs \
|
||||
--ignore-file=".helmdocsignore" \
|
||||
--output-file="CONFIG.md" \
|
||||
--template-files="${repository}/.tools/templates/docs/CONFIG.md.gotmpl" \
|
||||
--template-files="${repository}/tools/templates/docs/CONFIG.md.gotmpl" \
|
||||
--chart-search-root="${chart}"
|
||||
fi
|
||||
done
|
||||
0
.tools/values-change.sh → tools/values-change.sh
Executable file → Normal file
0
.tools/values-change.sh → tools/values-change.sh
Executable file → Normal file
Reference in New Issue
Block a user