https://github.com/khuedoan/micropaas
Git push to deploy, with optional Nix-based CI (experimental, it powers code.khuedoan.com and my other projects, but may not be useful outside my specific use cases)
https://github.com/khuedoan/micropaas
Last synced: 8 months ago
JSON representation
Git push to deploy, with optional Nix-based CI (experimental, it powers code.khuedoan.com and my other projects, but may not be useful outside my specific use cases)
- Host: GitHub
- URL: https://github.com/khuedoan/micropaas
- Owner: khuedoan
- License: gpl-3.0
- Created: 2024-10-21T03:12:32.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2025-01-13T17:23:38.000Z (9 months ago)
- Last Synced: 2025-02-21T20:46:09.670Z (8 months ago)
- Language: Rust
- Homepage:
- Size: 80.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# MicroPaaS
Git push to deploy - slightly larger than
[NanoPaas](https://github.com/khuedoan/nanopaas), but with more goodies :)
## Usage
### Container image build
A `Dockerfile` in the project root is automatically built on push for any
branch. If it's the default branch, the image will be pushed to the registry
and deployed automatically via the GitOps repository.
### CI
If a project has a `flake.nix` file and a `Makefile` with a `ci:` target, CI
will automatically run on push for any branch. The `ci` target has access to
the following variables:
| Variable | Description | Example value |
| ------------- | ----------------------------------------------------------- | -------------------------------------------- |
| `REF_NAME` | The name of the ref being updated | `refs/heads/master` |
| `OLD_OBJECT` | The old object name stored in the ref | `4e54684045b5d2cda33b9843fd6de80863cb97ee` |
| `NEW_OBJECT` | The new object name to be stored in the ref | `2423e33f06df9ef080f931a0e39b41f0287837b1` |
| `CACHE_DIR` | Shared cache directory for each ref name on each repository | `/var/lib/cache/micropaas/refs/heads/master` |
Example `Makefile` with a `ci` target:
```make
ci:
# Create a target cache directory for Cargo build output
mkdir -p "${CACHE_DIR}/target"
# Symlink the target cache directory to the build directory
ln -s "${CACHE_DIR}/target" "target"
# Run tests utilizing the cached target directory
cargo test
```
## Configuration
| Environment variable | Default | Description |
| ------------------------- | ----------------- | ---------------------------------------------------- |
| `DEFAULT_BRANCH` | `master` | Default branch that triggers deployment on push |
| `DOCKER_HOST` | | Specifies the remote Docker host |
| `REGISTRY_HOST` | | Hostname or prefix for the container registry |
| `GIT_USER_NAME` | `Bot` | Git committer user name for the deploy step |
| `GIT_USER_EMAIL` | `bot@example.com` | Git committer user email for the deploy step |
| `GITOPS_REPO` | | Specifies the GitOps repository used in deployment |
| `ARGOCD_WEBHOOK_ENDPOINT` | | ArgoCD webhook endpoint to trigger sync more quickly |