1be9fae08b
### Description of the change Switch to official `helm-unittest` which is now alive again at https://github.com/helm-unittest/helm-unittest ### Applicable issues - ref #199 ### Checklist <!-- [Place an '[X]' (no spaces) in all applicable fields. Please remove unrelated fields.] --> - [ ] Parameters are documented in the `values.yaml` and added to the `README.md` using [readme-generator-for-helm](https://github.com/bitnami-labs/readme-generator-for-helm) - [ ] Breaking changes are documented in the `README.md` Reviewed-on: https://gitea.com/gitea/helm-chart/pulls/410 Reviewed-by: justusbunsi <justusbunsi@noreply.gitea.io> Reviewed-by: pat-s <pat-s@noreply.gitea.io> Co-authored-by: Michael Kriese <michael.kriese@visualon.de> Co-committed-by: Michael Kriese <michael.kriese@visualon.de>
2.5 KiB
2.5 KiB
Contribution Guidelines
Any type of contribution is welcome; from new features, bug fixes, tests, refactorings for easier maintainability or documentation improvements.
Development environment
When using Visual Studio Code as IDE, following plugins might be useful:
Documentation Requirements
The README.md
must include all configuration options. The parameters section
is generated by extracting the parameter annotations from the values.yaml
file,
by using this tool.
If changes were made on configuration options, run make readme
to update the
README file.
Pull Request Requirements
When submitting or updating a PR:
- make sure it passes CI builds.
- do not make independent changes in one PR.
- try to avoid rebases. They make code reviews for large PRs and comments much harder.
- if applicable, use the PR template for a well-defined PR description.
- clearly mark breaking changes.
Local development & testing
For local development and testing of pull requests, the following workflow can be used:
- Install
minikube
andhelm
. - Start a
minikube
cluster viaminikube start
. - From the
gitea/helm-chart
directory execute the following command. This will install the dependencies listed inChart.yml
and deploy the current state of the helm chart found locally. If you want to test a branch, make sure to switch to the respective branch first.helm install --dependency-update gitea . -f values.yaml
. - Gitea is now deployed in
minikube
. To access it, it's port needs to be forwarded first fromminikube
to localhost first viakubectl --namespace default port-forward svc/gitea-http 3000:3000
. Now Gitea is accessible at http://localhost:3000.
Unit tests
# install the unittest plugin
$ helm plugin install https://github.com/helm-unittest/helm-unittest
# run the unittests
make unittests