From e73b316a1326bc542f7075675ebf1a210f6f5bf5 Mon Sep 17 00:00:00 2001 From: SPT-dev Date: Thu, 2 Mar 2023 21:25:07 -0500 Subject: [PATCH] docs: Update documentation about deployment --- .ansible/README.md | 19 +++++++++++++++++++ README.md | 7 ++++++- 2 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 .ansible/README.md diff --git a/.ansible/README.md b/.ansible/README.md new file mode 100644 index 0000000..ba5e92a --- /dev/null +++ b/.ansible/README.md @@ -0,0 +1,19 @@ +# Website Deployment +The deployment happens on commit and merge on `master` branch and it is handled by [DroneCI](https://drone.sp-tarkov.com/SPT-AKI/Website) and Ansible. + +## Deployment flow +On development and feature branches, the deployment flow is: +- cloning the project +- replacing values for ansible inventory file using DroneCI secrets +- Checking the playbook syntax +- Running the playbook in dry-run mode + +On master, the deployment flow is: +- cloning the project +- replacing values for ansible inventory file using DroneCI secrets +- Checking the playbook syntax +- Running the playbook in dry-run mode +- Executing the playbook + +## The playbook +It has only one instruction: Go to the directory in the server and `git pull` to update everything. \ No newline at end of file diff --git a/README.md b/README.md index c98b4d9..d257c8d 100644 --- a/README.md +++ b/README.md @@ -7,4 +7,9 @@ db.sp-tarkov.com have been made by Shirito and Revingly This repository contain the following websites content: * www.sp-tarkov.com * codepaste.sp-tarkov.com -* [db.sp-tarkov.com](https://db.sp-tarkov.com) (see [developer documentation](https://dev.sp-tarkov.com/WillDaPope/DB-Website/src/branch/main/README.md)) \ No newline at end of file +* [db.sp-tarkov.com](https://db.sp-tarkov.com) (see [developer documentation](https://dev.sp-tarkov.com/WillDaPope/DB-Website/src/branch/main/README.md)) + +## Deployment +The deployment happens on commit and merge on `master` branch and it is automatically handled by [DroneCI](https://drone.sp-tarkov.com/SPT-AKI/Website) and Ansible. + +See the [documentation for deployment](.ansible/README.md). \ No newline at end of file