Introduce NPM dependencies for development

We use `readme-generator-for-helm` and `markdownlint-cli` which are both
NPM packages. So they should be available for developers in a more usual
way: `package.json` and `package-lock.json`.

As the currently used `readme-generator-for-helm` from npmjs.com is not
officially maintained by Bitnami (see issue link below), the change also
includes switching to the official GitHub repository.

https://github.com/bitnami-labs/readme-generator-for-helm/issues/36

Signed-off-by: justusbunsi <sk.bunsenbrenner@gmail.com>
This commit is contained in:
2022-06-11 16:28:12 +02:00
parent b3b91e2044
commit 3c8cfe8f46
7 changed files with 756 additions and 16 deletions

3
.gitignore vendored
View File

@ -1,3 +1,4 @@
charts
charts/
node_modules/
Chart.lock
.DS_Store

View File

@ -20,5 +20,9 @@
.idea/
*.tmproj
.vscode/
node_modules/
.npmrc
package.json
package-lock.json
#charts/
#Chart.lock

1
.npmrc Normal file
View File

@ -0,0 +1 @@
engine-strict=true

View File

@ -1,15 +1,8 @@
readme: helm-doc
readme-generator -v values.yaml -r README.md
markdownlint *.md -f
.PHONY: prepare-environment
prepare-environment:
npm install
.PHONY: helm-doc
helm-doc:
ifeq (, $(shell which readme-generator))
@{ \
set -e ;\
echo 'installing readme-generator-for-helm' ;\
npm install -g readme-generator-for-helm ;\
}
else
echo 'readme-generator-for-helm is already installed'
endif
.PHONY: readme
readme: prepare-environment
npm run readme:parameters
npm run readme:lint

722
package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

19
package.json Normal file
View File

@ -0,0 +1,19 @@
{
"name": "gitea-helm-chart",
"homepage": "https://gitea.com/gitea/helm-chart.git",
"license": "MIT",
"private": true,
"engineStrict": true,
"engines": {
"node": ">=16.0.0",
"npm": ">=8.0.0"
},
"scripts": {
"readme:lint": "markdownlint *.md -f",
"readme:parameters": "readme-generator -v values.yaml -r README.md"
},
"devDependencies": {
"markdownlint-cli": "^0.31.1",
"readme-generator-for-helm": "git+https://github.com/bitnami-labs/readme-generator-for-helm.git"
}
}

View File

@ -389,7 +389,7 @@ gitea:
## @section Memcached
#
## @param memcached.enabled Memcached is loaded as a dependency from [Bitnami](https://github.com/bitnami/charts/tree/master/bitnami/memcached) if enabled in the values. Complete Configuration can be taken from their website.
## @param memcached.service.port Port for memcached
## @param memcached.service.port Port for Memcached
memcached:
enabled: true
service: