Commit 3865a5a4 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

Merge branch 'add-reference-table' into 'master'

Add reference overview

See merge request to-be-continuous/doc!39
parents 4d23928b a4173bc1
Loading
Loading
Loading
Loading
Loading

docs/css/grid.css

0 → 100644
+31 −0
Original line number Diff line number Diff line
.md-typeset .grid {
    grid-gap: 0.6rem;
    display: grid;
    grid-template-columns: repeat(auto-fit,minmax(16rem,1fr));
    margin: 1em 0;
}

.md-typeset .grid.cards>ul {
    display: contents;
}
.md-typeset .grid.cards>ol>li, .md-typeset .grid.cards>ul>li, .md-typeset .grid>.card {
    border: 0.05rem solid var(--md-default-fg-color--lightest);
    border-radius: 0.5rem;
    display: block;
    margin: 0;
    padding: 0.5rem;
    box-shadow: 0px 0px 4px 0px rgba(0,0,0,0.3);
}
.md-typeset .grid.cards>ol>li>hr, .md-typeset .grid.cards>ul>li>hr, .md-typeset .grid>.card>hr {
    margin: .6em 0;
}
.md-typeset .grid.cards>ol>li>:first-child, .md-typeset .grid.cards>ul>li>:first-child, .md-typeset .grid>.card>:first-child {
    margin-top: 0;
}
.md-typeset ol li blockquote, .md-typeset ol li p, .md-typeset ul li blockquote, .md-typeset ul li p {
    margin: 0.5em 0;
}
.md-typeset .grid>.card>hr {
    margin-bottom: 1em;
    margin-top: 1em;
}
 No newline at end of file
+27 −0
Original line number Diff line number Diff line
@@ -113,3 +113,30 @@ body, input {
.md-nav__item--active > label.md-nav__link {
  color: #ff7900;
}

/* ============== */
/* Specific parts */
/* ============== */
/* Note: we use a class on thead element in order to reuse any other CSS by mkdocs */
.md-typeset .tbc-stages th, .md-typeset .tbc-stages td {
  font-size: large;
  padding: .5em !important;
}

th.tbc-stage {
  writing-mode: vertical-lr;
  min-width:1rem !important;
}

td.tbc-tmpl-icon {
  background-position: center center;
  background-repeat: no-repeat;
  background-size: contain;
  min-width: 2.2em;
}

img.tbc-tmpl-icon {
  max-width: 2rem;
  vertical-align: middle;
  margin-right: .25rem;
}

docs/ref/index.md

0 → 100644
+24 −0
Original line number Diff line number Diff line
# Templates Reference

## Templates

Here is the list of available templates:

<div class="grid cards" markdown>

--8<-- "docs/ref/templates-grid.part.html"

</div>

## Used Stages

Here is the list of [generic stages](../understand.md#generic-pipeline-stages) used by each _to-be-continuous_ template:

<table>
<thead class="tbc-stages">
--8<-- "docs/ref/templates-stages-head.part.html"
</thead>
<tbody class="tbc-stages">
--8<-- "docs/ref/templates-stages-body.part.html"
</tbody>
</table>
 No newline at end of file
+273 −0
Original line number Diff line number Diff line

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/aws/-/avatar"> [**Amazon Web Services**](aws)

    ---

    Deploy your application to [Amazon Web Services](https://aws.amazon.com/)

    Version: `2.3`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/angular/-/avatar"> [**Angular**](angular)

    ---

    Build, test and analyse your [Angular](https://angular.io/) projects

    Version: `4.2`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/ansible/-/avatar"> [**Ansible**](ansible)

    ---

    Provision your infrastructure and deploy your application with [Ansible](https://www.ansible.com/)

    Version: `3.4`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/bash/-/avatar"> [**Bash**](bash)

    ---

    Test and analyse your shell code

    Version: `3.1`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/cloud-foundry/-/avatar"> [**Cloud Foundry**](cloud-foundry)

    ---

    Deploy your application to a [Cloud Foundry](https://www.cloudfoundry.org/) platform

    Version: `2.1`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/cnb/-/avatar"> [**Cloud Native Buildpacks**](cnb)

    ---

    Transform your application source code into images that can run on any cloud with [Cloud Native Buildpacks](https://buildpacks.io/)

    Version: `1.0`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/cypress/-/avatar"> [**Cypress**](cypress)

    ---

    Run your automated (web) tests with [Cypress](https://www.cypress.io/)

    Version: `3.2`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/docker/-/avatar"> [**Docker**](docker)

    ---

    Build, check and inspect your containers with [Docker](https://www.docker.com/)

    Version: `3.5`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/gitleaks/-/avatar"> [**Gitleaks**](gitleaks)

    ---

    Detect and prevent hardcoded secrets in your Git repository with [Gitleaks](https://github.com/zricethezav/gitleaks/wiki)

    Version: `2.1`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/golang/-/avatar"> [**Go**](golang)

    ---

    Build, test and analyse your [Go](https://golang.org/) projects

    Version: `4.1`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/gcloud/-/avatar"> [**Google Cloud**](gcloud)

    ---

    Deploy your application to the [Google Cloud](https://cloud.google.com/) platform

    Version: `2.3`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/gradle/-/avatar"> [**Gradle**](gradle)

    ---

    Build, test and analyse your [Gradle](https://gradle.org/)-based projects

    Version: `2.2`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/helm/-/avatar"> [**Helm**](helm)

    ---

    Build your Helm Charts and/or deploy your application to a Kubernetes platform using [Helm](https://helm.sh/)

    Version: `4.0`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/kubernetes/-/avatar"> [**Kubernetes**](kubernetes)

    ---

    Deploy your application to a [Kubernetes](https://kubernetes.io/) platform using [declarative configuration](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/) or [Kustomize](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/kustomization/)

    Version: `3.3`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/maven/-/avatar"> [**Maven**](maven)

    ---

    Build, test and analyse your [Maven](https://maven.apache.org/)-based projects

    Version: `3.2`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/mkdocs/-/avatar"> [**MkDocs**](mkdocs)

    ---

    Build your static website with [MkDocs](https://www.mkdocs.org/)

    Version: `2.0`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/mobsf/-/avatar"> [**MobSF**](mobsf)

    ---

    Perform pen-testing, malware analysis and security assessment for mobile applications with [Mobile Security Framework](https://github.com/MobSF/Mobile-Security-Framework-MobSF) (MobSF)

    Version: `2.0`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/node/-/avatar"> [**Node.js**](node)

    ---

    Build, test and analyse your JavaScript/TypeScript/[Node.js](https://nodejs.org/) projects

    Version: `3.5`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/openshift/-/avatar"> [**OpenShift**](openshift)

    ---

    Deploy your application to an [OpenShift](https://www.openshift.com/) platform

    Version: `2.2`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/php/-/avatar"> [**PHP**](php)

    ---

    Build, test and analyse your [PHP](https://www.php.net/) projects

    Version: `4.2`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/postman/-/avatar"> [**Postman**](postman)

    ---

    Run your automated (API) tests with [Postman](https://www.postman.com/automated-testing)

    Version: `3.1`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/puppeteer/-/avatar"> [**Puppeteer**](puppeteer)

    ---

    Run your automated (web) tests with [Puppeteer](https://pptr.dev/)

    Version: `3.1`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/python/-/avatar"> [**Python**](python)

    ---

    Build, test and analyse your [Python](https://www.python.org/) projects

    Version: `6.1`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/robotframework/-/avatar"> [**Robot Framework**](robotframework)

    ---

    Run your automated tests with [Robot Framework](https://robotframework.org/)

    Version: `3.2`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/s3/-/avatar"> [**S3 (Simple Storage Service)**](s3)

    ---

    Deploy your objects to any [S3](https://en.wikipedia.org/wiki/Amazon_S3) (Simple Storage Service) compatible object storage service

    Version: `4.1`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/sqlfluff/-/avatar"> [**SQLFluff lint**](sqlfluff)

    ---

    Lint your SQL files (whichever your dialect) with [SQLFluff](https://docs.sqlfluff.com)

    Version: `1.0`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/sonar/-/avatar"> [**SonarQube**](sonar)

    ---

    Continuously inspect your codebase with [SonarQube](https://www.sonarqube.org/)

    Version: `3.1`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/terraform/-/avatar"> [**Terraform**](terraform)

    ---

    Manage your infrastructure with [Terraform](https://www.terraform.io/)

    Version: `3.6`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/testssl/-/avatar"> [**Test SSL**](testssl)

    ---

    Test your TLS/SSL servers compliance with [Test SSL](https://testssl.sh/)

    Version: `3.1`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/dbt/-/avatar"> [**dbt**](dbt)

    ---

    Continuously integrate and deploy your data with [dbt](https://www.getdbt.com/)

    Version: `1.1`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/defectdojo/-/avatar"> [**DefectDojo**](defectdojo)

    ---

    Import security reports into [DefectDojo](https://www.defectdojo.org/)

    Version: `2.0`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/k6/-/avatar"> [**k6**](k6)

    ---

    Run your automated load-testing with [k6](https://k6.io/)

    Version: `3.1`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/sbt/-/avatar"> [**Scala/SBT**](sbt)

    ---

    Build, test and analyse your [sbt](https://www.scala-sbt.org/)-based projects

    Version: `1.1`

-   <img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/semantic-release/-/avatar"> [**semantic-release**](semantic-release)

    ---

    Automate your versionning and release management with [semantic-release](https://github.com/semantic-release/semantic-release)

    Version: `3.2`
+35 −0
Original line number Diff line number Diff line

<!-- Amazon Web Services --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/aws/-/avatar"> <a href="aws">Amazon Web Services</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- Angular --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/angular/-/avatar"> <a href="angular">Angular</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- Ansible --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/ansible/-/avatar"> <a href="ansible">Ansible</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- Bash --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/bash/-/avatar"> <a href="bash">Bash</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- Cloud Foundry --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/cloud-foundry/-/avatar"> <a href="cloud-foundry">Cloud Foundry</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- Cloud Native Buildpacks --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/cnb/-/avatar"> <a href="cnb">Cloud Native Buildpacks</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- Cypress --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/cypress/-/avatar"> <a href="cypress">Cypress</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- dbt --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/dbt/-/avatar"> <a href="dbt">dbt</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- DefectDojo --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/defectdojo/-/avatar"> <a href="defectdojo">DefectDojo</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- Docker --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/docker/-/avatar"> <a href="docker">Docker</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- Gitleaks --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/gitleaks/-/avatar"> <a href="gitleaks">Gitleaks</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- Go --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/golang/-/avatar"> <a href="golang">Go</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- Google Cloud --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/gcloud/-/avatar"> <a href="gcloud">Google Cloud</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- Gradle --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/gradle/-/avatar"> <a href="gradle">Gradle</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- Helm --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/helm/-/avatar"> <a href="helm">Helm</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- k6 --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/k6/-/avatar"> <a href="k6">k6</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- Kubernetes --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/kubernetes/-/avatar"> <a href="kubernetes">Kubernetes</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- Maven --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/maven/-/avatar"> <a href="maven">Maven</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- MkDocs --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/mkdocs/-/avatar"> <a href="mkdocs">MkDocs</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- MobSF --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/mobsf/-/avatar"> <a href="mobsf">MobSF</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- Node.js --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/node/-/avatar"> <a href="node">Node.js</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- OpenShift --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/openshift/-/avatar"> <a href="openshift">OpenShift</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- PHP --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/php/-/avatar"> <a href="php">PHP</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- Postman --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/postman/-/avatar"> <a href="postman">Postman</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- Puppeteer --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/puppeteer/-/avatar"> <a href="puppeteer">Puppeteer</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- Python --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/python/-/avatar"> <a href="python">Python</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- Robot Framework --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/robotframework/-/avatar"> <a href="robotframework">Robot Framework</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- S3 (Simple Storage Service) --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/s3/-/avatar"> <a href="s3">S3 (Simple Storage Service)</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- Scala/SBT --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/sbt/-/avatar"> <a href="sbt">Scala/SBT</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- semantic-release --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/semantic-release/-/avatar"> <a href="semantic-release">semantic-release</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- SonarQube --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/sonar/-/avatar"> <a href="sonar">SonarQube</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- SQLFluff lint --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/sqlfluff/-/avatar"> <a href="sqlfluff">SQLFluff lint</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- Terraform --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/terraform/-/avatar"> <a href="terraform">Terraform</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
<!-- Test SSL --><tr><td class="tbc-tmpl-name"><img class="tbc-tmpl-icon" src="https://gitlab.com/to-be-continuous/testssl/-/avatar"> <a href="testssl">Test SSL</a></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td><td></td></tr>
Loading