readme
All checks were successful
/ job (push) Successful in 1h4m19s

This commit is contained in:
Marc Beninca 2024-08-23 07:57:45 +02:00
parent 90b9b0a091
commit b85288ee80
Signed by: marc.beninca
GPG key ID: 9C7613450C80C24F

View file

@ -1,6 +1,6 @@
# Shell to Python Continuous Deployment # Shell to Python Continuous Deployment
Get a common set of Python CI & CD commands\ Get a common set of Python based CI / CD commands\
from various contexts of CA, DNS, CI and OS / OCI. from various contexts of CA, DNS, CI and OS / OCI.
--- ---
@ -10,7 +10,7 @@ from various contexts of CA, DNS, CI and OS / OCI.
Project workflows can occur in: Project workflows can occur in:
* an online or offline context, dealing with custom CA & DNS servers * an online or offline context, dealing with custom CA & DNS servers
* various Continuous Integration platforms, with different workflow syntaxes * various Continuous Integration platforms, with different workflow syntaxes
* specific Operating Systems, having different sets of commands and packages * specific Operating Systems, having different commands and package names
* specific containers for JavaScript based actions (ForgeJo, Gitea, GitHub) * specific containers for JavaScript based actions (ForgeJo, Gitea, GitHub)
What if there was a unified way to do so? What if there was a unified way to do so?
@ -26,23 +26,23 @@ Picture it…
* numbered * numbered
* Certificate Authority armored certificates * Certificate Authority armored certificates
* Domain Name System servers IP addresses * Domain Name System servers IP addresses
* set group environment variables for * ref names for deployment contexts of feature, staging & release
* ref names for deployment contexts of feature, staging & release * alternate locations of
* alternate locations of * Git repositories of this project & its parent framework
* Git repositories of this project & its parent framework * Operating Systems & Software packages
* Operating Systems & Software packages * SSH key & hosts for deployments
* SSH key & hosts for deployments * a standalone POSIX shell script payload
* a standalone POSIX shell script payload
### Workflow files ### Workflow files
* calling the POSIX shell script payload as their very first step * calling the POSIX shell script payload as their very first step
* using a unified YAML syntax made of actions implemented in Python * using a unified YAML syntax made of actions implemented in Python
### Continous Integration & Deployment ### Integration & Deployment
* configuring the Operating System container * configuring the Operating System container
* installing Python system & virtual environments * installing Python system & virtual environments
* parsing common YAML syntax to launch Python actions
--- ---
@ -50,7 +50,7 @@ Picture it…
### Features ### Features
Handle project workflows in a unified way: SPCD handles project workflows in a unified way:
* whether the network infrastructure is * whether the network infrastructure is
* [X] online * [X] online
@ -233,4 +233,5 @@ Handle project workflows in a unified way:
### Later ### Later
* automate versions fetching
* turn readme into documentation * turn readme into documentation