README
¶
stencil
A modern repository templating engine
Note: This has been forked from getoutreach/stencil and is currently under construction.
Development
Prerequisites
Note: If you opt to not use rtx, please install all dependencies
from .tool-versions manually.
Install the dependencies:
rtx install
Building
task build
Testing
task test
Releasing
Create a tag locally:
git tag -a vX.Y.Z
Push the tag:
git push origin vX.Y.Z
Wait for CI to build and publish the release (Github Actions).
License
The original code, as of the fork, is licensed under the Apache 2.0 license which can be found (as it was) at LICENSE.original. This applies to all code created before the commit ea98384ec4b1031ba032cedad90df4bb0451cdce.
All code after that commit is licensed under AGPL 3.0. The license for this can be found at LICENSE.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
stencil
command
Package main implements the stencil CLI.
|
Package main implements the stencil CLI. |
|
internal
|
|
|
cmd/stencil
Package stencil implements the stencil command, which is essentially a thing wrapper around the codegen package which does most of the heavy lifting.
|
Package stencil implements the stencil command, which is essentially a thing wrapper around the codegen package which does most of the heavy lifting. |
|
codegen
Package codegen implements the core code generation functionality of stencil.
|
Package codegen implements the core code generation functionality of stencil. |
|
dotnotation
Package dotnotation implements a dotnotation (hello.world) for accessing fields within a map[string]interface{}
|
Package dotnotation implements a dotnotation (hello.world) for accessing fields within a map[string]interface{} |
|
git
Package git implements helpers for interacting with git
|
Package git implements helpers for interacting with git |
|
gitauth
Package gitauth provides helpers for setting up auth
|
Package gitauth provides helpers for setting up auth |
|
modules
Package modules implements all logic needed for interacting with stencil modules and their interaction with a service generated by stencil.
|
Package modules implements all logic needed for interacting with stencil modules and their interaction with a service generated by stencil. |
|
modules/modulestest
Package modulestest contains code for interacting with modules in tests.
|
Package modulestest contains code for interacting with modules in tests. |
|
version
Package version contains the current version of the stencil CLI.
|
Package version contains the current version of the stencil CLI. |
|
pkg
|
|
|
configuration
Package configuration implements configuration loading logic for stencil repositories and template repositories
|
Package configuration implements configuration loading logic for stencil repositories and template repositories |
|
extensions
Package extensions consumes extensions in stencil
|
Package extensions consumes extensions in stencil |
|
extensions/apiv1
Package apiv1 implements the bridge between a extension and go-plugin providing most of the implementation for the extension if it's written in Go.
|
Package apiv1 implements the bridge between a extension and go-plugin providing most of the implementation for the extension if it's written in Go. |
|
stencil
Package stencil provides an entry point for interacting with Stencil.
|
Package stencil provides an entry point for interacting with Stencil. |
|
stenciltest
Package stenciltest contains code for testing templates
|
Package stenciltest contains code for testing templates |
Click to show internal directories.
Click to hide internal directories.