Skip to content

add Dockerfile, CI/CD, and README#5

Merged
krakenhavoc merged 1 commit intomainfrom
feature/docker-ci-docs
Mar 18, 2026
Merged

add Dockerfile, CI/CD, and README#5
krakenhavoc merged 1 commit intomainfrom
feature/docker-ci-docs

Conversation

@krakenhavoc
Copy link
Contributor

This pull request introduces the initial release setup for the KrakenKey Probe project, establishing its build, test, release, and deployment infrastructure. It adds CI/CD workflows, Docker and Compose support, release automation, licensing, and comprehensive documentation for users and contributors.

CI/CD and Release Automation

  • Added GitHub Actions workflows for continuous integration (ci.yaml) and automated releases on tag pushes (release.yaml), including linting, testing, building, and artifact management. [1] [2]
  • Introduced goreleaser.yaml to automate multi-platform builds, archive packaging, Docker image creation, and publishing to GitHub Container Registry, with manifest generation for easy multi-architecture pulls.

Containerization and Deployment

  • Created a production-ready Dockerfile using Go and Distroless, supporting environment configuration and volume mounts for probe state, and exposing the health endpoint.
  • Added docker-compose.yaml for simple local deployment, including persistent state volume and environment variable configuration.

Documentation and Licensing

  • Added a detailed README.md covering usage, configuration, deployment (Docker, Compose, Kubernetes), troubleshooting, and probe operation, with API key setup and health endpoint details.
  • Introduced the AGPLv3 license in LICENSE for open-source compliance.

@krakenhavoc krakenhavoc merged commit b9ed599 into main Mar 18, 2026
5 of 6 checks passed
@krakenhavoc krakenhavoc deleted the feature/docker-ci-docs branch March 18, 2026 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant