README
¶
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/talos-systems/kres:latest
To update build instructions:
make rekres
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
kres
command
|
|
|
kres/cmd
Package cmd implements Kres commands.
|
Package cmd implements Kres commands. |
|
internal
|
|
|
config
Package config provides config loading and mapping.
|
Package config provides config loading and mapping. |
|
dag
Package dag represents abstract directed acyclic graph.
|
Package dag represents abstract directed acyclic graph. |
|
output
Package output defines basic output features.
|
Package output defines basic output features. |
|
output/codecov
Package codecov implements output to .codecov.yml.
|
Package codecov implements output to .codecov.yml. |
|
output/conform
Package conform implements output to .conform.yaml.
|
Package conform implements output to .conform.yaml. |
|
output/dockerfile
Package dockerfile implements output to Dockerfiles.
|
Package dockerfile implements output to Dockerfiles. |
|
output/dockerfile/step
Package step defines Dockerfile steps
|
Package step defines Dockerfile steps |
|
output/drone
Package drone implements output to .drone.yml.
|
Package drone implements output to .drone.yml. |
|
output/github
Package github implements interface to GitHub API.
|
Package github implements interface to GitHub API. |
|
output/gitignore
Package gitignore implements output to .gitignore.
|
Package gitignore implements output to .gitignore. |
|
output/golangci
Package golangci implements output to .golangci.yml.
|
Package golangci implements output to .golangci.yml. |
|
output/license
Package license implements output to LICENSE.
|
Package license implements output to LICENSE. |
|
output/makefile
Package makefile implements output to Makefiles.
|
Package makefile implements output to Makefiles. |
|
output/markdownlint
Package markdownlint implements output to .markdownlint.json.
|
Package markdownlint implements output to .markdownlint.json. |
|
output/release
Package release implements output for releases.
|
Package release implements output for releases. |
|
output/template
Package template implements custom template output.
|
Package template implements custom template output. |
|
project
Package project provides top-level view of the whole project consisting of building blocks.
|
Package project provides top-level view of the whole project consisting of building blocks. |
|
project/auto
Package auto provides automatic detector of project type, reflections.
|
Package auto provides automatic detector of project type, reflections. |
|
project/common
Package common provides building blocks applicable to all projects.
|
Package common provides building blocks applicable to all projects. |
|
project/custom
Package custom provides blocks defined in the config manually.
|
Package custom provides blocks defined in the config manually. |
|
project/golang
Package golang provides building blocks for Go-based projects.
|
Package golang provides building blocks for Go-based projects. |
|
project/js
Package js provides building blocks for JS-based projects.
|
Package js provides building blocks for JS-based projects. |
|
project/js/templates
Package templates defines default templates for various JS components.
|
Package templates defines default templates for various JS components. |
|
project/markdown
Package markdown provides building blocks for Markdown handling.
|
Package markdown provides building blocks for Markdown handling. |
|
project/meta
Package meta provides project options from source code.
|
Package meta provides project options from source code. |
|
project/service
Package service provides building blocks connecting to other services.
|
Package service provides building blocks connecting to other services. |
|
project/wrap
Package wrap provides helper methods to wrap blocks to suppress (or add) some interfaces.
|
Package wrap provides helper methods to wrap blocks to suppress (or add) some interfaces. |
|
version
Package version provides version information.
|
Package version provides version information. |
Click to show internal directories.
Click to hide internal directories.