dhorn/medlab-hugo-template
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added more clarity to instructions

Browse Source
This commit is contained in:
Drew
2025-04-26 15:04:39 -06:00
parent c70da2eaac
commit b1d49a5ef3
1 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -44,18 +44,23 @@ This project includes automated CI/CD pipelines that handle building and deployi
### Setting up the pipeline ### Setting up the pipeline
We will use Gitea (git.medlab.host) as the external repository and GitLab for CI/CD. You will need the following:
- A GitLab account
- A Gitea repository (Also works with most other Git hosting service)
- A Surfer instance along with the access token
1. **Create GitLab Project** 1. **Create GitLab Project**
- For external repositories (like git.medlab.host): - For external repositories (like git.medlab.host):
- Use GitLab's "Run CI/CD for external repo" option - Use GitLab's "Run CI/CD for external repo" option
- This creates a mirrored GitLab project - This creates a mirrored GitLab project
2. **Configure Repository Mirroring** (for external hosting) 2. **Configure Gitea Repository Mirroring**
- Navigate to: `Settings > Repository > Mirror Settings` - From your Gitea repo go to: `Settings > Repository > Mirror Settings`
- Add your GitLab repository URL - Add your GitLab repository URL
- Enable push mirroring - Enable push mirroring
3. **Set Required Variables** 3. **Set Required Variables on GitLab**
- Go to: `Settings > CI/CD > Variables` - From your GitLab repo go to: `Settings > CI/CD > Variables`
- Add these variables: - Add these variables:
- `SURFER_TOKEN`: Your Surfer access token - `SURFER_TOKEN`: Your Surfer access token
- Mark as "Masked and hidden" - Mark as "Masked and hidden"
@@ -75,6 +80,5 @@ This project includes automated CI/CD pipelines that handle building and deployi
- Ensure `.gitlab-ci.yml` exists in your repository root - Ensure `.gitlab-ci.yml` exists in your repository root
- The pipeline uses `hugomods/hugo:node` for Hugo Extended support - The pipeline uses `hugomods/hugo:node` for Hugo Extended support
- Deployments only trigger on the `publish` branch - Deployments only trigger on the `publish` branch
- Build artifacts are retained for 1 hour
For more details about Surfer deployment, see: https://docs.cloudron.io/apps/surfer/ For more details about Surfer deployment, see: https://docs.cloudron.io/apps/surfer/