chore: update README with deploy details
All checks were successful
Deploy eolas-api / deploy (push) Successful in 11s
All checks were successful
Deploy eolas-api / deploy (push) Successful in 11s
This commit is contained in:
parent
bac1d38cf8
commit
f049e4cd36
1 changed files with 18 additions and 0 deletions
18
README.md
18
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: <commit description>`,
|
||||
- Minor: `feat: <commit description>`,
|
||||
- Patch: `fix: <commit description>`
|
||||
- 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
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue