### Description of the change This adds a `.vscode` folder with recommended extensions and some useful settings like unittest schema validation. The `.vscode` folder is already helm ignored during packaging. ### Possible drawbacks We would have to be careful about PR changes in that directory. Reviewed-on: #536 Co-authored-by: justusbunsi <email@example.com> Co-committed-by: justusbunsi <firstname.lastname@example.org>
Any type of contribution is welcome; from new features, bug fixes, tests, refactorings for easier maintainability or documentation improvements.
When using Visual Studio Code as IDE, a ready-to-use profile is available.
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.
The ToC is created via the VSCode Markdown All in One extension which can/must also be used used to update it.
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:
- Start a
- From the
gitea/helm-chartdirectory execute the following command. This will install the dependencies listed in
Chart.ymland 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 from
minikubeto localhost first via
kubectl --namespace default port-forward svc/gitea-http 3000:3000. Now Gitea is accessible at http://localhost:3000.
# install the unittest plugin
$ helm plugin install https://github.com/helm-unittest/helm-unittest
# run the unittests
See plugin documentation for usage instructions.
- Create a tag following the tagging schema
- Push the tag
- Let CI do it's work