Skip to content

Commit 3cf5e74

Browse files
authored
Merge pull request #95 from fhict-skilltree/feature/59
feat: document build and deployment process
2 parents 95918c6 + 0d9ac74 commit 3cf5e74

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed
+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
layout: default
3+
title: Build and Deployment
4+
nav_order: 6
5+
parent: Technical Documentation
6+
permalink: /docs/technical/build-and-deployment
7+
---
8+
9+
# Build and Deployment
10+
11+
## Building
12+
13+
The backend application is containerized using Docker. The built image is based on the official PHP-FPM image and adds
14+
the necessary dependencies and tools, to run the container on any environment. The Dockerfile can be found
15+
at: `./docker/php/build.Dockerfile`.
16+
17+
The image build and publishing process is automated using
18+
a [GitHub Action](https://github.com/fhict-skilltree/backend-application/actions/workflows/build.yml). The container
19+
image is published to the GitHub Container Registry.
20+
21+
Builds are automatically started for the following events:
22+
1. Commits to the `main` or `develop` branches. The image tag is equal to the branch name.
23+
2. Created Git tags. The image tag is equal to the tag name.
24+
25+
## Releasing new versions
26+
27+
### Versioning Scheme
28+
29+
Calendar Versioning (CalVer) is the versioning scheme used for naming our releases. You can read more about this specification at https://calver.org/.
30+
31+
The actual version scheme that we're going to use is still being researched.
32+
33+
## Deploying
34+
35+
Deployments to environments can be done by using the created Deployments workflows. Choose the deployment workflow that has been created for the desired environment. You need to provide the version number, you want to deploy to that environment.
36+
37+
Deployments to production requires an approval from @cyrildewit.

0 commit comments

Comments
 (0)