From 7e6357220178e914949ecf58aec301aa4a3caa9d Mon Sep 17 00:00:00 2001 From: kjeld Schouten-Lebbing Date: Sun, 30 May 2021 13:14:37 +0200 Subject: [PATCH] rename `.tools` to `tools` --- .github/workflows/docs.copy.yaml | 8 ++++---- docs/development/app development/chart-yaml-structure.md | 6 +++--- docs/development/getting-started.md | 2 +- {.tools => tools}/bump-major.sh | 0 {.tools => tools}/bump-minor.sh | 0 {.tools => tools}/bump-patch.sh | 0 {.tools => tools}/copy-common.sh | 0 {.tools => tools}/gen-helm-docs.sh | 8 ++++---- {.tools => tools}/pre-commit-install.bat | 0 {.tools => tools}/templates/app/.helmignore | 0 {.tools => tools}/templates/app/Chart.yaml | 0 {.tools => tools}/templates/app/README.md | 0 {.tools => tools}/templates/app/values.yaml | 0 {.tools => tools}/templates/docs/CONFIG.md.gotmpl | 0 {.tools => tools}/templates/docs/README.md.gotmpl | 0 {.tools => tools}/update_dependencies | 0 {.tools => tools}/values-change.sh | 0 17 files changed, 12 insertions(+), 12 deletions(-) rename {.tools => tools}/bump-major.sh (100%) rename {.tools => tools}/bump-minor.sh (100%) rename {.tools => tools}/bump-patch.sh (100%) rename {.tools => tools}/copy-common.sh (100%) mode change 100755 => 100644 rename {.tools => tools}/gen-helm-docs.sh (76%) mode change 100755 => 100644 rename {.tools => tools}/pre-commit-install.bat (100%) rename {.tools => tools}/templates/app/.helmignore (100%) rename {.tools => tools}/templates/app/Chart.yaml (100%) rename {.tools => tools}/templates/app/README.md (100%) rename {.tools => tools}/templates/app/values.yaml (100%) rename {.tools => tools}/templates/docs/CONFIG.md.gotmpl (100%) rename {.tools => tools}/templates/docs/README.md.gotmpl (100%) rename {.tools => tools}/update_dependencies (100%) rename {.tools => tools}/values-change.sh (100%) mode change 100755 => 100644 diff --git a/.github/workflows/docs.copy.yaml b/.github/workflows/docs.copy.yaml index 2f373154385..9afa61d3b37 100644 --- a/.github/workflows/docs.copy.yaml +++ b/.github/workflows/docs.copy.yaml @@ -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: | diff --git a/docs/development/app development/chart-yaml-structure.md b/docs/development/app development/chart-yaml-structure.md index caef727eccd..69482ed1275 100644 --- a/docs/development/app development/chart-yaml-structure.md +++ b/docs/development/app development/chart-yaml-structure.md @@ -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. diff --git a/docs/development/getting-started.md b/docs/development/getting-started.md index 74b68ed24cf..59eeceb5e39 100644 --- a/docs/development/getting-started.md +++ b/docs/development/getting-started.md @@ -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 diff --git a/.tools/bump-major.sh b/tools/bump-major.sh similarity index 100% rename from .tools/bump-major.sh rename to tools/bump-major.sh diff --git a/.tools/bump-minor.sh b/tools/bump-minor.sh similarity index 100% rename from .tools/bump-minor.sh rename to tools/bump-minor.sh diff --git a/.tools/bump-patch.sh b/tools/bump-patch.sh similarity index 100% rename from .tools/bump-patch.sh rename to tools/bump-patch.sh diff --git a/.tools/copy-common.sh b/tools/copy-common.sh old mode 100755 new mode 100644 similarity index 100% rename from .tools/copy-common.sh rename to tools/copy-common.sh diff --git a/.tools/gen-helm-docs.sh b/tools/gen-helm-docs.sh old mode 100755 new mode 100644 similarity index 76% rename from .tools/gen-helm-docs.sh rename to tools/gen-helm-docs.sh index a5c6fd1b18c..b9a46b502cb --- a/.tools/gen-helm-docs.sh +++ b/tools/gen-helm-docs.sh @@ -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 diff --git a/.tools/pre-commit-install.bat b/tools/pre-commit-install.bat similarity index 100% rename from .tools/pre-commit-install.bat rename to tools/pre-commit-install.bat diff --git a/.tools/templates/app/.helmignore b/tools/templates/app/.helmignore similarity index 100% rename from .tools/templates/app/.helmignore rename to tools/templates/app/.helmignore diff --git a/.tools/templates/app/Chart.yaml b/tools/templates/app/Chart.yaml similarity index 100% rename from .tools/templates/app/Chart.yaml rename to tools/templates/app/Chart.yaml diff --git a/.tools/templates/app/README.md b/tools/templates/app/README.md similarity index 100% rename from .tools/templates/app/README.md rename to tools/templates/app/README.md diff --git a/.tools/templates/app/values.yaml b/tools/templates/app/values.yaml similarity index 100% rename from .tools/templates/app/values.yaml rename to tools/templates/app/values.yaml diff --git a/.tools/templates/docs/CONFIG.md.gotmpl b/tools/templates/docs/CONFIG.md.gotmpl similarity index 100% rename from .tools/templates/docs/CONFIG.md.gotmpl rename to tools/templates/docs/CONFIG.md.gotmpl diff --git a/.tools/templates/docs/README.md.gotmpl b/tools/templates/docs/README.md.gotmpl similarity index 100% rename from .tools/templates/docs/README.md.gotmpl rename to tools/templates/docs/README.md.gotmpl diff --git a/.tools/update_dependencies b/tools/update_dependencies similarity index 100% rename from .tools/update_dependencies rename to tools/update_dependencies diff --git a/.tools/values-change.sh b/tools/values-change.sh old mode 100755 new mode 100644 similarity index 100% rename from .tools/values-change.sh rename to tools/values-change.sh