commit a0c82943d5885c28d54d9020684f92c6cb584835 Author: Jared Allard Date: Thu Feb 13 17:43:28 2025 -0800 chore: initial commit w/ stencil diff --git a/.cliff.toml b/.cliff.toml new file mode 100644 index 0000000..d9b5aff --- /dev/null +++ b/.cliff.toml @@ -0,0 +1,115 @@ +# git-cliff ~ configuration file +# https://git-cliff.org/docs/configuration +# +# Lines starting with "#" are comments. +# Configuration options are organized into tables and keys. +# See documentation for more information on available options. + +[changelog] +# changelog header +header = """""" +body = """ +{%- macro remote_url() -%} + https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }} +{%- endmacro -%} + +{% macro print_commit(commit) -%} + - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\ + {% if commit.breaking %}[**breaking**] {% endif %}\ + {{ commit.message | upper_first }} - \ + ([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\ +{% endmacro -%} + +{% if version %}\ + {% if previous.version %}\ + ## [{{ version | trim_start_matches(pat="v") }}]\ + ({{ self::remote_url() }}/compare/{{ previous.version }}..{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }} + {% else %}\ + ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }} + {% endif %}\ +{% else %}\ + + ## [unreleased] +{% endif %}\ + +{% for group, commits in commits | group_by(attribute="group") %} + ### {{ group | striptags | trim | upper_first }} + {% for commit in commits + | filter(attribute="scope") + | sort(attribute="scope") %} + {{ self::print_commit(commit=commit) }} + {%- endfor -%} + {% raw %}\n{% endraw %}\ + {%- for commit in commits %} + {%- if not commit.scope -%} + {{ self::print_commit(commit=commit) }}\ + {% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif -%}\ + {% if commit.remote.pr_number %} in \ + [#{{ commit.remote.pr_number }}]({{ self::remote_url() }}/pull/{{ commit.remote.pr_number }}) \ + {%- endif %}\ + {% raw %}\n{% endraw -%} + {% endif -%} + {% endfor -%} + {% raw %}\n{% endraw %}\ +{% endfor %}\n + +{%- if github -%} +{% if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %} + ## New Contributors{% raw %}\n{% endraw -%} +{%- endif %}\ +{% for contributor in github.contributors | filter(attribute="is_first_time", value=true) %} + - @{{ contributor.username }} made their first contribution + {%- if contributor.pr_number %} in \ + [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \ + {%- endif %} +{%- endfor -%} +{%- endif -%} +""" # template for the changelog body +# https://keats.github.io/tera/docs/#introduction +# template for the changelog footer +footer = """""" +# remove the leading and trailing whitespace from the templates +trim = true +# postprocessors +postprocessors = [ + { pattern = '', replace = "https://github.com/homelab/klefki" }, # replace repository URL +] + +[git] +# parse the commits based on https://www.conventionalcommits.org +conventional_commits = true +# filter out the commits that are not conventional +filter_unconventional = true +# process each line of a commit as an individual commit +split_commits = false +# regex for preprocessing the commit messages +commit_preprocessors = [ + { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](/issues/${2}))" }, +] +# regex for parsing and grouping commits +commit_parsers = [ + { message = "^feat", group = "โ›ฐ๏ธ Features" }, + { message = "^fix", group = "๐Ÿ› Bug Fixes" }, + { message = "^doc", group = "๐Ÿ“š Documentation" }, + { message = "^perf", group = "โšก Performance" }, + { message = "^refactor", group = "๐Ÿšœ Refactor" }, + { message = "^style", group = "๐ŸŽจ Styling" }, + { message = "^test", group = "๐Ÿงช Testing" }, + { message = "^chore\\(release\\): prepare for", skip = true }, + { message = "^chore\\(go\\)", skip = true }, + { message = "^chore|^ci|^build", group = "โš™๏ธ Miscellaneous Tasks" }, + { body = ".*security", group = "๐Ÿ›ก๏ธ Security" }, + { message = "^revert", group = "โ—€๏ธ Revert" }, +] +# protect breaking changes from being skipped due to matching a skipping commit_parser +protect_breaking_commits = false +# filter out the commits that are not matched by commit parsers +filter_commits = false +# regex for matching git tags +tag_pattern = "v[0-9].*" +# regex for ignoring tags +ignore_tags = "rc" +# sort the tags topologically +topo_order = false +# sort the commits inside sections by oldest/newest order +sort_commits = "newest" diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..109b54a --- /dev/null +++ b/.editorconfig @@ -0,0 +1,12 @@ +root = true + +[*] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +indent_style = tab + +# yaml is forced to use spaces :/ +[*.{yml,yaml}] +indent_style = space +indent_size = 2 diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..6d7504c --- /dev/null +++ b/.gitattributes @@ -0,0 +1,7 @@ +go*.sum linguist-generated +stencil.lock linguist-generated +bun.lockb linguist-generated + +## <> + +## <> diff --git a/.github/images/klefki.png b/.github/images/klefki.png new file mode 100644 index 0000000..3f3a9af Binary files /dev/null and b/.github/images/klefki.png differ diff --git a/.github/scripts/get-next-version.sh b/.github/scripts/get-next-version.sh new file mode 100755 index 0000000..74f99ac --- /dev/null +++ b/.github/scripts/get-next-version.sh @@ -0,0 +1,47 @@ +#!/usr/bin/env bash +# Determines the next version. +set -euo pipefail + +# VERSION_OVERRIDE is an environment variable that allows the next +# version to be overridden. If VERSION_OVERRIDE is set, the next version +# will be the value of VERSION_OVERRIDE. +VERSION_OVERRIDE=${VERSION_OVERRIDE:=} + +# BUILD_RC is an environment variable that determines whether the build +# is a release candidate. If BUILD_RC is set to true, the next version +# will be a release candidate version (-rc.X). +BUILD_RC=${BUILD_RC:=false} + +# As a special case, if the first argument is --rc, the next version +# will be a release candidate version. +if [[ "${1:-}" == "--rc" ]]; then + BUILD_RC=true +fi + +if [[ -n "$VERSION_OVERRIDE" ]]; then + echo "Overriding next version with: $VERSION_OVERRIDE" >&2 + echo "$VERSION_OVERRIDE" + exit 0 +fi + +# Determine the next version as reported by the next-version command. +next_version=$(get-next-version --prefix v 2>/dev/null | sed 's/-rc.*//' | tr -d '\n') + +echo "Next release version: $next_version" >&2 + +# If the build is a release candidate, determine the last release +# candidate version and increment the release candidate number. +if [[ "$BUILD_RC" == "true" ]]; then + last_rc_version=$(git tag -l --sort=-v:refname | grep -- "$next_version" | grep -- "-rc." | head -n 1 || true) + if [[ -z "$last_rc_version" ]]; then + next_version="${next_version}-rc.1" + else + echo "Last release candidate version: $last_rc_version" >&2 + last_rc_version_number=${last_rc_version##*-rc.} + next_rc_version_number=$((last_rc_version_number + 1)) + next_version="${next_version}-rc.${next_rc_version_number}" + fi +fi + +echo "Next version: $next_version" >&2 +echo "$next_version" diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml new file mode 100644 index 0000000..e3a7592 --- /dev/null +++ b/.github/workflows/release.yaml @@ -0,0 +1,104 @@ +name: release + +on: + # Only run when triggered through the Github UI or API. + workflow_dispatch: + inputs: + rc: + description: "Build a release candidate instead of a stable release" + required: false + default: false + type: boolean + version: + description: "Set a specific version to release, defaults to automatic versioning based on conventional commits" + required: false + default: "" + type: string + +permissions: + contents: write + packages: write + issues: write + # Used by attestations in the release workflow. + id-token: write + attestations: write + +concurrency: + group: ${{ github.workflow }}-${{ github.head_ref }} + cancel-in-progress: true + +jobs: + release: + runs-on: ubuntu-latest + steps: + ## <> + + ## <> + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + fetch-tags: true + - uses: https://git.rgst.io/rgst-io/mise-action@v2 + with: + experimental: true + ## <> + github_token: ${{ github.token }} + ## <> + - name: Get Go directories + id: go + run: | + echo "cache_dir=$(go env GOCACHE)" >> "$GITHUB_OUTPUT" + echo "mod_cache_dir=$(go env GOMODCACHE)" >> "$GITHUB_OUTPUT" + - uses: actions/cache@v4 + with: + path: ${{ steps.go.outputs.cache_dir }} + key: ${{ github.workflow }}-${{ runner.os }}-go-build-cache-${{ hashFiles('**/go.sum') }} + - uses: actions/cache@v4 + with: + path: ${{ steps.go.outputs.mod_cache_dir }} + key: ${{ github.workflow }}-${{ runner.os }}-go-mod-cache-${{ hashFiles('go.sum') }} + - name: Retrieve goreleaser version + run: |- + echo "version=$(mise current goreleaser)" >> "$GITHUB_OUTPUT" + id: goreleaser + - name: Login to GitHub Container Registry + uses: docker/login-action@v3 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + - name: Set up git user + uses: fregante/setup-git-user@v2 + - name: Download syft (SBOM) + uses: anchore/sbom-action/download-syft@v0.18.0 + + # Bumping logic + - name: Get next version + id: next_version + env: + BUILD_RC: ${{ github.event.inputs.rc }} + VERSION_OVERRIDE: ${{ github.event.inputs.version }} + run: |- + echo "version=$(./.github/scripts/get-next-version.sh)" >> "$GITHUB_OUTPUT" + - name: Create Tag + run: |- + git tag -a "${{ steps.next_version.outputs.version }}" -m "Release ${{ steps.next_version.outputs.version }}" + - name: Generate CHANGELOG + run: |- + mise run changelog-release + - name: Create release artifacts and Github Release + uses: goreleaser/goreleaser-action@v6 + with: + distribution: goreleaser + version: v${{ steps.goreleaser.outputs.version }} + args: release --release-notes CHANGELOG.md --clean + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + ## <> + + ## <> + - uses: actions/attest-build-provenance@v2 + with: + # We attest all generated _archives_ because those are what we + # upload to Github Releases. + subject-path: dist/klefki_*.*, dist/checksums.txt diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml new file mode 100644 index 0000000..bd2b833 --- /dev/null +++ b/.github/workflows/tests.yaml @@ -0,0 +1,73 @@ +name: tests +on: + push: + branches: + - main + pull_request: + +permissions: + contents: read + +concurrency: + group: ${{ github.workflow }}-${{ github.head_ref }} + cancel-in-progress: true + +jobs: + gotest: + name: go test + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: https://git.rgst.io/rgst-io/mise-action@v2 + with: + experimental: true + ## <> + github_token: ${{ github.token }} + ## <> + - name: Get Go directories + id: go + run: | + echo "cache_dir=$(go env GOCACHE)" >> "$GITHUB_OUTPUT" + echo "mod_cache_dir=$(go env GOMODCACHE)" >> "$GITHUB_OUTPUT" + - uses: actions/cache@v4 + with: + path: ${{ steps.go.outputs.cache_dir }} + key: ${{ runner.os }}-go-build-cache-${{ hashFiles('**/go.sum') }} + - uses: actions/cache@v4 + with: + path: ${{ steps.go.outputs.mod_cache_dir }} + key: ${{ runner.os }}-go-mod-cache-${{ hashFiles('go.sum') }} + - name: Download dependencies + run: go mod download + - name: Run go test + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + gotestsum -- -coverprofile=cover.out ./... + - name: Upload test coverage + uses: codecov/codecov-action@v5 + with: + token: ${{ secrets.CODECOV_TOKEN }} + files: ./cover.out + fail_ci_if_error: true + + golangci-lint: + name: golangci-lint + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: https://git.rgst.io/rgst-io/mise-action@v2 + with: + experimental: true + ## <> + github_token: ${{ github.token }} + ## <> + - name: Retrieve golangci-lint version + run: | + echo "version=$(mise current golangci-lint)" >> "$GITHUB_OUTPUT" + id: golangci_lint + - name: golangci-lint + uses: golangci/golangci-lint-action@v6 + with: + version: v${{ steps.golangci_lint.outputs.version }} + args: --timeout=30m diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d59a51e --- /dev/null +++ b/.gitignore @@ -0,0 +1,51 @@ +# Binaries for programs and plugins +*.exe +*.exe~ +*.dll +*.so +*.dylib + +# Editor files +*.swp +*~ +\#*\# +.idea/* +TAGS +*.sublime-project +*.sublime-workspace +.\#* +.dir-locals.el + +# Test binary, build with "go test -c" +*.test + +# Output of the go coverage tool, specifically when used with LiteIDE +*.out + +# Log files +*.log + +# Releases and other binaries +bin/ +dist/ +.dist/ + +# Don't. Commit. Vendor. Or other package manager dep directories +node_modules +vendor + +# macOS +.DS_Store + +# Task local state +.task + +# VSCode debugger launch configs +launch.json + +# Currently a build artifact +CHANGELOG.md + +## <> + +## <> diff --git a/.golangci.yml b/.golangci.yml new file mode 100644 index 0000000..158ce15 --- /dev/null +++ b/.golangci.yml @@ -0,0 +1,69 @@ +# yaml-language-server: $schema=https://json.schemastore.org/golangci-lint + +# Linter settings +linters-settings: + errcheck: + check-blank: true + gocyclo: + min-complexity: 25 + gocritic: + enabled-tags: + - diagnostic + - experimental + - opinionated + - performance + - style + lll: + line-length: 140 + +linters: + # Inverted configuration with enable-all and disable is not scalable + # during updates of golangci-lint. + disable-all: true + enable: + - bodyclose + - dogsled + - errcheck + - errorlint + - exhaustive + - copyloopvar + - gochecknoinits + - gocritic + - gocyclo + - gofmt + - goheader + - goimports + - gosec + - gosimple + - govet + - ineffassign + - lll + - misspell + - nakedret + - staticcheck + - revive + - typecheck + - unconvert + - unparam + - unused + - whitespace + +issues: + exclude: + # We allow error shadowing + - 'declaration of "err" shadows declaration at' + + # Excluding configuration per-path, per-linter, per-text and per-source + exclude-rules: + # Exclude some linters from running on tests files. + - path: _test\.go + linters: + - errcheck + - funlen + - gochecknoglobals # Globals in test files are tolerated. + - gocyclo + - goheader # Don't require license headers in test files. + - gosec + +output: + sort-results: true diff --git a/.goreleaser.yaml b/.goreleaser.yaml new file mode 100644 index 0000000..9bbc625 --- /dev/null +++ b/.goreleaser.yaml @@ -0,0 +1,49 @@ +# yaml-language-server: $schema=https://goreleaser.com/static/schema.json +version: 2 +project_name: klefki +report_sizes: true +metadata: + mod_timestamp: "{{ .CommitTimestamp }}" +builds: + - main: ./cmd/klefki + flags: + - -trimpath + ldflags: + - -s + - -w + ## <> + + ## <> + env: + - CGO_ENABLED=0 + goarch: + - amd64 + - arm64 + ## <> + + ## <> + goos: + - linux + - darwin + - windows + ## <> + + ## <> + ignore: + - goos: windows + goarch: arm + mod_timestamp: "{{ .CommitTimestamp }}" +checksum: + name_template: "checksums.txt" +snapshot: + version_template: "{{ incpatch .Version }}-next" +changelog: + use: git +release: + prerelease: "auto" + footer: |- + **Full Changelog**: https://git.rgst.io/homelab/klefki/compare/{{ .PreviousTag }}...{{ .Tag }} + +## <> + +## <> diff --git a/.mise.toml b/.mise.toml new file mode 100644 index 0000000..9093a8d --- /dev/null +++ b/.mise.toml @@ -0,0 +1,50 @@ + +# Default versions of tools, to update these, set [tools.override] +[tools] +bun = "latest" +git-cliff = "latest" +golang = "1.24.0" +golangci-lint = "1.64.5" +goreleaser = "latest" +"go:gotest.tools/gotestsum" = "1.12.0" +"go:golang.org/x/tools/cmd/goimports" = "latest" +"go:mvdan.cc/sh/v3/cmd/shfmt" = "latest" +"go:github.com/thenativeweb/get-next-version" = "latest" + +[tasks.build] +description = "Build a binary for the current platform/architecture" +run = "go build -trimpath -o ./bin/ -v ./cmd/..." + +[tasks.changelog] +description = "Generate a changelog for the current version" +outputs = ["CHANGELOG.md"] +run = ["git-cliff --config .cliff.toml --output CHANGELOG.md"] + +[tasks.fmt] +alias = "format" +description = "Format code" +run = [ + "go mod tidy", + "gofmt -s -w .", + "goimports -w .", + "shfmt -w .", + "bun node_modules/.bin/prettier --write '**/*.{json,yaml,yml,md,jsonschema.json}'", +] + +[tasks.lint] +description = "Run linters" +run = "golangci-lint run" + +[tasks.next-version] +description = """Get the version number that would be released if a release was ran right now. +Pass --rc to get the next release candidate version. +""" +run = ["./.github/scripts/get-next-version.sh"] + +[tasks.test] +description = "Run tests" +run = "gotestsum" + +## <> + +## <> diff --git a/.mise/tasks/changelog-release b/.mise/tasks/changelog-release new file mode 100755 index 0000000..2e8076d --- /dev/null +++ b/.mise/tasks/changelog-release @@ -0,0 +1,36 @@ +#!/usr/bin/env bash +# mise description="Creates a CHANGELOG.md file for the current git tag" +set -euo pipefail + +# Get the current tag that we're on. +CURRENT_TAG=$(git describe --tags --abbrev=0) + +args=("mise" "run" "changelog" "--") + +# If we're on a non-rc version, use the current tag, otherwise use +# unreleased. +if [[ $CURRENT_TAG == *"-rc"* ]]; then + # Get the previous rc version. + # shellcheck disable=SC2001 + PREVIOUS_RC_TAG=$(git tag --list --sort=-v:refname | + grep -E "$(sed 's/-rc\.[0-9]*//' <<<"$CURRENT_TAG")" | grep -v "$CURRENT_TAG" | + head -n 1 || true) + + if [[ -z $PREVIOUS_RC_TAG ]]; then + args+=("--unreleased") + else + echo "Previous rc tag: $PREVIOUS_RC_TAG" >&2 + args+=("--" "$PREVIOUS_RC_TAG..$CURRENT_TAG") + fi +else + args+=("--current") +fi + +# Run mise to generate the changelog. +"${args[@]}" + +# If we're on a rc version, fix the header. +if [[ $CURRENT_TAG == *"-rc"* ]]; then + sed -i.bak "s/^## \[unreleased\]/## $CURRENT_TAG/" CHANGELOG.md + rm CHANGELOG.md.bak +fi diff --git a/.vscode/common.code-snippets b/.vscode/common.code-snippets new file mode 100644 index 0000000..9ac5746 --- /dev/null +++ b/.vscode/common.code-snippets @@ -0,0 +1,25 @@ +{ + "Copyright": { + "description": "Inserts a copyright header", + "prefix": ["license", "copy", "copyright"], + "body": [ + "// Copyright (C) ${CURRENT_YEAR} klefki contributors", + "//", + "// This program is free software: you can redistribute it and/or modify", + "// it under the terms of the GNU Affero General Public License as", + "// published by the Free Software Foundation, either version 3 of the", + "// License, or (at your option) any later version.", + "//", + "// This program is distributed in the hope that it will be useful,", + "// but WITHOUT ANY WARRANTY; without even the implied warranty of", + "// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the", + "// GNU Affero General Public License for more details.", + "//", + "// You should have received a copy of the GNU Affero General Public License", + "// along with this program. If not, see .", + "//", + "// SPDX-License-Identifier: AGPL-3.0", + "", + ] + } +} diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..bc6d45c --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,10 @@ +{ + "recommendations": [ + "editorconfig.editorconfig", + "esbenp.prettier-vscode", + "golang.go", + "timonwong.shellcheck", + "redhat.vscode-yaml", + "foxundermoon.shell-format" + ] +} diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..0faf1a4 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,14 @@ +{ + "go.lintTool": "golangci-lint", + "go.formatTool": "goimports", + "go.useLanguageServer": true, + "files.trimTrailingWhitespace": true, + "editor.formatOnSave": true, + "shellcheck.customArgs": ["-P", "SCRIPTDIR", "-x"], + "[markdown]": { + "editor.defaultFormatter": "esbenp.prettier-vscode" + }, + "[yaml]": { + "editor.defaultFormatter": "redhat.vscode-yaml" + } +} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..8f92caf --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,8 @@ +# Contributing + +This project follows [@jaredallard's contribution +guidelines](https://github.com/jaredallard/jaredallard/blob/master/CONTRIBUTING.md). + + + + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..42b5c5a --- /dev/null +++ b/LICENSE @@ -0,0 +1,663 @@ + + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..f8bd9ce --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +
+ Klefki + +

LUKS automatic unlocking over network.

+ +
+
+ +## Usage + +Install a release from [the releases](/releaases) tab, or build from +source. + +## Build from Source + +1. Clone the repository: `git clone https://git.rgst.io/homelab/klefki` +2. Install [mise](https://mise.jdx.dev) then run `mise install` +3. Run `mise run build` and get an accompanying build at `./bin/klefki` + +## License + +AGPL-3.0 diff --git a/bun.lock b/bun.lock new file mode 100644 index 0000000..6a4174b --- /dev/null +++ b/bun.lock @@ -0,0 +1,14 @@ +{ + "lockfileVersion": 1, + "workspaces": { + "": { + "name": "@homelab/klefki", + "devDependencies": { + "prettier": "^3.5.1", + }, + }, + }, + "packages": { + "prettier": ["prettier@3.5.1", "", { "bin": { "prettier": "bin/prettier.cjs" } }, "sha512-hPpFQvHwL3Qv5AdRvBFMhnKo4tYxp0ReXiPn2bxkiohEX6mBeBwEpBSQTkD458RaaDKQMYSp4hX4UtfUTA5wDw=="], + } +} diff --git a/cmd/klefki/klefki.go b/cmd/klefki/klefki.go new file mode 100644 index 0000000..7b8767a --- /dev/null +++ b/cmd/klefki/klefki.go @@ -0,0 +1,5 @@ +package main + +func main() { + // Your logic here +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..a93165d --- /dev/null +++ b/go.mod @@ -0,0 +1,3 @@ +module git.rgst.io/homelab/klefki + +go 1.23 diff --git a/package.json b/package.json new file mode 100644 index 0000000..bd04c06 --- /dev/null +++ b/package.json @@ -0,0 +1,8 @@ +{ + "//": "Used for prettier", + "name": "@homelab/klefki", + "devDependencies": { + "prettier": "^3.5.1" + }, + "private": true +} diff --git a/stencil.lock b/stencil.lock new file mode 100644 index 0000000..dd7b25d --- /dev/null +++ b/stencil.lock @@ -0,0 +1,65 @@ +version: 2.1.0 +modules: + - name: github.com/rgst-io/stencil-golang + url: https://github.com/rgst-io/stencil-golang + version: + commit: f0322bcd01439b092b27cbaabdf2e3e3e2d0ebe3 + tag: v1.5.0 +files: + - name: .cliff.toml + template: .cliff.toml.tpl + module: github.com/rgst-io/stencil-golang + - name: .editorconfig + template: .editorconfig.tpl + module: github.com/rgst-io/stencil-golang + - name: .gitattributes + template: .gitattributes.tpl + module: github.com/rgst-io/stencil-golang + - name: .github/scripts/get-next-version.sh + template: .github/scripts/get-next-version.sh.tpl + module: github.com/rgst-io/stencil-golang + - name: .github/workflows/release.yaml + template: .github/workflows/release.yaml.tpl + module: github.com/rgst-io/stencil-golang + - name: .github/workflows/tests.yaml + template: .github/workflows/tests.yaml.tpl + module: github.com/rgst-io/stencil-golang + - name: .gitignore + template: .gitignore.tpl + module: github.com/rgst-io/stencil-golang + - name: .golangci.yml + template: .golangci.yml.tpl + module: github.com/rgst-io/stencil-golang + - name: .goreleaser.yaml + template: .goreleaser.yaml.tpl + module: github.com/rgst-io/stencil-golang + - name: .mise.toml + template: .mise.toml.tpl + module: github.com/rgst-io/stencil-golang + - name: .mise/tasks/changelog-release + template: .mise/tasks/changelog-release.tpl + module: github.com/rgst-io/stencil-golang + - name: .vscode/common.code-snippets + template: .vscode/common.code-snippets.tpl + module: github.com/rgst-io/stencil-golang + - name: .vscode/extensions.json + template: .vscode/extensions.json.tpl + module: github.com/rgst-io/stencil-golang + - name: .vscode/settings.json + template: .vscode/settings.json.tpl + module: github.com/rgst-io/stencil-golang + - name: CONTRIBUTING.md + template: CONTRIBUTING.md.tpl + module: github.com/rgst-io/stencil-golang + - name: LICENSE + template: LICENSE.tpl + module: github.com/rgst-io/stencil-golang + - name: cmd/klefki/klefki.go + template: cmd/$name/name.go.tpl + module: github.com/rgst-io/stencil-golang + - name: go.mod + template: go.mod.tpl + module: github.com/rgst-io/stencil-golang + - name: package.json + template: package.json.tpl + module: github.com/rgst-io/stencil-golang diff --git a/stencil.yaml b/stencil.yaml new file mode 100644 index 0000000..bcf1391 --- /dev/null +++ b/stencil.yaml @@ -0,0 +1,8 @@ +name: klefki +arguments: + vcs: forgejo + vcs_host: git.rgst.io + org: homelab + license: AGPL-3.0 +modules: + - name: github.com/rgst-io/stencil-golang