mirror of
https://github.com/siderolabs/kres.git
synced 2026-02-05 09:45:35 +01:00
49ba5d2babe8e5479cd4dbb6b8c53c4a8c6cc601
Add Helm docs and Helm JSON Schema generation. Signed-off-by: Mateusz Urbanek <mateusz.urbanek@siderolabs.com>
Kres
Kres is a tool to automate generation of build instructions based on project structure.
At the moment only Go projects are supported. Kres is opinionated, that's by design.
Following output files are generated automatically:
MakefileDockerfile.drone.yaml.dockerignore.gitignore.golangci.yml.markdownlint.json.golangci.yaml.codecov.ymlLICENSE
Access Tokens
Kres can leverage API access tokens to set up build environment or settings for the project:
GITHUB_TOKENenvironment variable should contain GitHub API personal access token withreposcope.
Running Kres
When running Kres for the first time, run it manually via Docker container:
docker run --rm -v ${PWD}:/src -w /src -e GITHUB_TOKEN ghcr.io/siderolabs/kres:latest
To update build instructions:
make rekres
Languages
Go
92%
Shell
2.7%
Makefile
2.7%
Dockerfile
2.2%
Smarty
0.2%
Other
0.2%