Update GITEA_SETUP.md for binary-only CI/CD pipeline
Some checks failed
Build and Release / build (push) Failing after 1s
Some checks failed
Build and Release / build (push) Failing after 1s
- Clarify Docker is not required for CI/CD - Note that Docker images are built manually - Simplify troubleshooting section - Remove Docker setup instructions from setup guide - Link to manual Docker build documentation
This commit is contained in:
@@ -86,51 +86,55 @@ To get a runner token:
|
|||||||
|
|
||||||
### Installing Docker on the Runner (Optional)
|
### Installing Docker on the Runner (Optional)
|
||||||
|
|
||||||
If you want to build Docker images as part of your releases, install Docker on the runner:
|
Docker is **not required** for the CI/CD pipeline. Binary builds work without Docker.
|
||||||
|
|
||||||
|
If you want to manually build Docker images:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Install Docker
|
# Build server image
|
||||||
curl -fsSL https://get.docker.com -o get-docker.sh
|
docker build -t nerd-monitor-server -f Dockerfile.server .
|
||||||
sudo sh get-docker.sh
|
|
||||||
|
|
||||||
# Add permissions for the runner user to use Docker
|
# Build agent image
|
||||||
sudo usermod -aG docker $USER
|
docker build -t nerd-monitor-agent -f Dockerfile.agent .
|
||||||
|
|
||||||
# Verify Docker is working
|
# Or use docker-compose for both
|
||||||
docker --version
|
docker-compose build
|
||||||
|
docker-compose up
|
||||||
# Note: You may need to logout and login for group permissions to take effect
|
|
||||||
```
|
```
|
||||||
|
|
||||||
**Without Docker**: The binary builds will still work. Only Docker image generation will be skipped (the workflow will show a warning but still succeed).
|
|
||||||
|
|
||||||
## What Happens Next
|
## What Happens Next
|
||||||
|
|
||||||
Once you've set everything up:
|
Once you've set everything up:
|
||||||
|
|
||||||
1. **Every push to main/master** triggers the build job:
|
1. **Every push to main/master** triggers the build job:
|
||||||
- Compiles all platform binaries
|
- Compiles all platform binaries (Linux, macOS, Windows)
|
||||||
- Attempts to build Docker images (skips if Docker unavailable)
|
- Creates SHA256 checksums
|
||||||
- Uploads artifacts as build artifacts
|
- Artifacts available for 30 days
|
||||||
|
|
||||||
2. **Every git tag push** (e.g., `v1.0.0`) triggers the full release:
|
2. **Every git tag push** (e.g., `v1.0.0`) triggers the full release:
|
||||||
- Does all of the above
|
- Does all of the above
|
||||||
- Creates a Gitea Release
|
- Creates a Gitea Release
|
||||||
- Uploads all binaries and checksums to the release
|
- Uploads all binaries and checksums to the release (permanent storage)
|
||||||
- Uploads Docker images if available
|
|
||||||
|
|
||||||
3. **Releases are available in**:
|
3. **Releases are available in**:
|
||||||
- Repository Releases tab in Gitea
|
- Repository Releases tab in Gitea
|
||||||
- Binaries ready for download
|
- All binaries ready for download
|
||||||
- Docker images (if Docker is available on runner)
|
- SHA256SUMS file for verification
|
||||||
|
|
||||||
|
Note: Docker images are not built automatically. To build Docker images manually, use:
|
||||||
|
```bash
|
||||||
|
docker build -t nerd-monitor-server -f Dockerfile.server .
|
||||||
|
docker build -t nerd-monitor-agent -f Dockerfile.agent .
|
||||||
|
# Or use docker-compose: docker-compose build
|
||||||
|
```
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
### "docker: command not found" in workflow
|
### "docker: command not found" in workflow
|
||||||
- Docker is not installed on your runner
|
- Docker support is not required - the workflow builds binaries without it
|
||||||
- This is **optional** - binaries will still build
|
- Binary builds will always succeed
|
||||||
- If you want Docker images, install Docker on the runner (see above)
|
- Docker images must be built manually using: `docker build -f Dockerfile.server .`
|
||||||
- The workflow will gracefully skip Docker builds and show a warning
|
- See QUICKSTART.md or DOCKER_COMPOSE.md for manual Docker build instructions
|
||||||
|
|
||||||
### "Action not found" error
|
### "Action not found" error
|
||||||
- Make sure Gitea Actions is enabled
|
- Make sure Gitea Actions is enabled
|
||||||
|
|||||||
Reference in New Issue
Block a user