diff --git a/README.md b/README.md index 9378b45..71e0af3 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,21 @@ TBC | GET | `refs` | `entry_title` | List of linked entries | | GET | `full_metadata` | `entry_title` | Tags, links, last modified | | GET | `graph` | `null` | Full network graph | + +## Deployment + +Deployment is automated via Forgejo action (see `.forgejo/workflows/deploy.yml`). + +On pushes to `main`: + +- Automatically bump version in accordance with Semver: + + - Major: `major: `, + - Minor: `feat: `, + - Patch: `fix: ` + - Ignored keywords: `chore`, `test`, `refactor`, and anything else + +- SSH to VPS using `deploy` user and : + - Purge existing source files at `var/www/eolas-api`, + - Copy over new source files + - TODO: restart Node server