chore: update README with further deployment details
All checks were successful
Deploy eolas-api / deploy (push) Successful in 22s

This commit is contained in:
Thomas Bishop 2025-10-15 14:55:33 +01:00
parent 645be686be
commit d5c1763b2a

View file

@ -6,14 +6,10 @@ Deployment actions are always executed by the `deploy` user on the VPS.
On pushes to `main`:
- Automate versioning and Git tagging:
- Bump version depending on commit keyword, create Git tag (if necessary) and
automatically update [package.json](./package.json):
- Commit keyword corresponds to SemVer:
- Major: `major: <commit description>`,
- Minor: `feat: <commit description>`,
- Patch: `fix: <commit description>`
- Ignored keywords: `chore`, `test`, `refactor`, and anything else
- This updates the version in `package.json` and creates Git tag at this version.
- This updates the version in `package.json` and creates Git tag at this version.
- Install `rsync` on the `ubuntu-latest` runner
@ -22,6 +18,16 @@ On pushes to `main`:
- Restart eolas-api using `systemd`. See `/systemd/eolas-api.service` for copy
of file that runs service on VPS.
### Commit keywords
In accordance with SemVer:
- Major: `major: <commit description>`,
- Minor: `feat: <commit description>`,
- Patch: `fix: <commit description>`
Ignored keywords: `chore`, `test`, `refactor`, and anything else.
### `systemd` service
On the VPS, `eolas-api` runs as a `systemd` service. This service is restarted as part of