readme/toc
Some checks failed
/ alpine (push) Successful in 48s
/ debian (push) Failing after 4m33s
/ ubuntu (push) Failing after 1m21s
/ arch (push) Failing after 9s
/ opensuse (push) Successful in 2m54s
/ fedora (push) Successful in 9m18s
/ alma (push) Failing after 2m26s
/ rocky (push) Failing after 3m19s
Some checks failed
/ alpine (push) Successful in 48s
/ debian (push) Failing after 4m33s
/ ubuntu (push) Failing after 1m21s
/ arch (push) Failing after 9s
/ opensuse (push) Successful in 2m54s
/ fedora (push) Successful in 9m18s
/ alma (push) Failing after 2m26s
/ rocky (push) Failing after 3m19s
This commit is contained in:
parent
07011797e4
commit
3bafd04d5e
1 changed files with 44 additions and 24 deletions
68
readme.md
68
readme.md
|
@ -5,7 +5,29 @@ from various contexts of CA, DNS, CI and OS / OCI.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 1 Why
|
## Table Of Contents {#toc}
|
||||||
|
|
||||||
|
* 1 [Why](#why)
|
||||||
|
* 2 [How](#how)
|
||||||
|
* 2.1 [Group environment variables](#how-variables)
|
||||||
|
* 2.2 [Workflow files](#how-workflows)
|
||||||
|
* 2.3 [Integration & Deployment](#how-actions)
|
||||||
|
* 3 [What](#what)
|
||||||
|
* 3.1 [Features](#what-features)
|
||||||
|
* 3.2 [Environment variables](#what-variables)
|
||||||
|
* 3.3 [Operating Systems containers](#what-systems)
|
||||||
|
* 4 [Who](#who)
|
||||||
|
* 5 [Where](#where)
|
||||||
|
* 5.1 [Chat](#where-chat)
|
||||||
|
* 5.2 [Repo](#where-repo)
|
||||||
|
* 5.3 [Site](#where-site)
|
||||||
|
* 6 [When](#when)
|
||||||
|
* 6.1 [Release tasks](#when-release)
|
||||||
|
* 6.2 [Further tasks](#when-further)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 1 [Why](#toc) {#why}
|
||||||
|
|
||||||
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
|
||||||
|
@ -17,11 +39,11 @@ What if there was a unified way to do so?
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 2 How
|
## 2 [How](#toc) {how}
|
||||||
|
|
||||||
Picture it…
|
Picture it…
|
||||||
|
|
||||||
### 2.1 Group environment variables
|
### 2.1 [Group environment variables](#how) {#how-variables}
|
||||||
|
|
||||||
* numbered
|
* numbered
|
||||||
* Certificate Authority armored certificates
|
* Certificate Authority armored certificates
|
||||||
|
@ -37,12 +59,12 @@ Picture it…
|
||||||
* SSH key & hosts for deployments
|
* SSH key & hosts for deployments
|
||||||
* a standalone POSIX shell script payload
|
* a standalone POSIX shell script payload
|
||||||
|
|
||||||
### 2.2 Workflow files
|
### 2.2 [Workflow files](#how) {#how-workflows}
|
||||||
|
|
||||||
* 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
|
||||||
|
|
||||||
### 2.3 Integration & Deployment
|
### 2.3 [Integration & Deployment](#how) {#how-actions}
|
||||||
|
|
||||||
#### Shell
|
#### Shell
|
||||||
|
|
||||||
|
@ -76,9 +98,9 @@ Picture it…
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 3 What
|
## 3 [What](#toc) {#what}
|
||||||
|
|
||||||
### 3.1 Features
|
### 3.1 [Features](#what) {#what-features}
|
||||||
|
|
||||||
Handle project workflows in a unified way:
|
Handle project workflows in a unified way:
|
||||||
|
|
||||||
|
@ -107,7 +129,7 @@ Handle project workflows in a unified way:
|
||||||
| Rocky | ☑ 9 | ☑ 8 |
|
| Rocky | ☑ 9 | ☑ 8 |
|
||||||
| Ubuntu | ☑ Noble (24.04) | ☐ Jammy (22.04) |
|
| Ubuntu | ☑ Noble (24.04) | ☐ Jammy (22.04) |
|
||||||
|
|
||||||
### 3.2 Environment variables
|
### 3.2 [Environment variables](#what) {#what-variables}
|
||||||
|
|
||||||
| Variable | Description | Default |
|
| Variable | Description | Default |
|
||||||
|:------------------|:-------------------------|:--------------------------------|
|
|:------------------|:-------------------------|:--------------------------------|
|
||||||
|
@ -134,7 +156,7 @@ Handle project workflows in a unified way:
|
||||||
| SPCD_URL_ROCKY | Rocky repository URL | https://dl.rockylinux.org |
|
| SPCD_URL_ROCKY | Rocky repository URL | https://dl.rockylinux.org |
|
||||||
| SPCD_URL_UBUNTU | Ubuntu repository URL | https://ubuntu.mirrors.ovh.net |
|
| SPCD_URL_UBUNTU | Ubuntu repository URL | https://ubuntu.mirrors.ovh.net |
|
||||||
|
|
||||||
### 3.3 Operating Systems containers
|
### 3.3 [Operating Systems containers](#what) {#what-systems}
|
||||||
|
|
||||||
#### Latest
|
#### Latest
|
||||||
|
|
||||||
|
@ -166,36 +188,34 @@ Handle project workflows in a unified way:
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 4 Who
|
## 4 [Who](#toc) {#who}
|
||||||
|
|
||||||
### Author
|
* Author: [Marc Beninca](https://forge.rwx.work/marc.beninca)
|
||||||
|
|
||||||
* [Marc Beninca](https://forge.rwx.work/marc.beninca)
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 5 Where
|
## 5 [Where](#toc) {#where}
|
||||||
|
|
||||||
### Chat
|
### 5.1 [Chat](#where) {#where-chat}
|
||||||
|
|
||||||
* [Discord](https://discord.com/channels/983145051985154108/1255894420092485652)
|
* [Discord](https://discord.com/channels/983145051985154108/1255894420092485652)
|
||||||
* [IRC](ircs://irc.libera.chat/#spcd)
|
* [IRC](ircs://irc.libera.chat/#spcd)
|
||||||
|
|
||||||
### Forge
|
### 5.2 [Repo](#where) {#where-repo}
|
||||||
|
|
||||||
* [Repository](https://forge.rwx.work/rwx.work/spcd)
|
* [Code](https://forge.rwx.work/rwx.work/spcd)
|
||||||
* [RSS](https://forge.rwx.work/rwx.work/spcd.rss)
|
* [Feed](https://forge.rwx.work/rwx.work/spcd.rss)
|
||||||
* [Workflows](https://forge.rwx.work/rwx.work/spcd/actions)
|
* [Actions](https://forge.rwx.work/rwx.work/spcd/actions)
|
||||||
|
|
||||||
### Deployment
|
### 5.3 [Site](#where) {#where-site}
|
||||||
|
|
||||||
* [Site](https://spcd.rwx.work)
|
* [Web](https://spcd.rwx.work)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 6 When
|
## 6 [When](#toc) {#when}
|
||||||
|
|
||||||
### 6.1 Tasks for a 1st stable release
|
### 6.1 [Release tasks](#when) {#when-release}
|
||||||
|
|
||||||
#### Documentation
|
#### Documentation
|
||||||
|
|
||||||
|
@ -265,7 +285,7 @@ Handle project workflows in a unified way:
|
||||||
* try git repo url variable first for shunit
|
* try git repo url variable first for shunit
|
||||||
* test
|
* test
|
||||||
|
|
||||||
### 6.2 Task stack
|
### 6.2 [Further tasks](#when) {#when-further}
|
||||||
|
|
||||||
* automate versions fetching
|
* automate versions fetching
|
||||||
* gource, xvfb, xauth
|
* gource, xvfb, xauth
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue