Skip to content

docs: document automatic build arguments #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
czhu12 merged 1 commit into from
Jul 13, 2026
Merged

docs: document automatic build arguments #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/basics/02-projects/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,26 @@ Navigate to **Project > Environment Variables** to manage configuration:

You can download all environment variables as a `.env` file for local development.

#### Automatic Build Arguments

Canine automatically injects the following build arguments into every build:

| Variable | Description |
|----------|-------------|
| `GIT_SHA` | The Git commit SHA being built |
| `BUILD_TIMESTAMP` | UTC timestamp of when the build started (ISO 8601) |

These are available as Docker build arguments. To use them at runtime, add the following to your Dockerfile:

```dockerfile
ARG GIT_SHA
ARG BUILD_TIMESTAMP
ENV GIT_SHA=$GIT_SHA
ENV BUILD_TIMESTAMP=$BUILD_TIMESTAMP
```

For buildpack-based builds, these are automatically set as environment variables.

### Preview Apps

When enabled, Canine automatically creates a temporary deployment for each pull request. See [Preview Apps](./04-preview-apps.md) for detailed configuration.
Expand Down
Loading