1
Fork 0
mirror of https://github.com/Steffo99/sophon.git synced 2024-12-22 14:54:22 +00:00

📔 Add CI and CD

This commit is contained in:
Steffo 2021-11-05 18:15:28 +01:00
parent 2856fd0d57
commit e3d047b155
Signed by: steffo
GPG key ID: 6965406171929D01
12 changed files with 52 additions and 2 deletions

View file

@ -19,6 +19,7 @@ Per sviluppare Sophon sono usati i seguenti strumenti:
- `GitHub Actions`_, un sistema di `Continuous Integration`_ e `Continuous Deployment`_ integrato in `GitHub`_; - `GitHub Actions`_, un sistema di `Continuous Integration`_ e `Continuous Deployment`_ integrato in `GitHub`_;
- `GitHub Containers`_, un registro di container Docker integrato in `GitHub`_; - `GitHub Containers`_, un registro di container Docker integrato in `GitHub`_;
- `CodeQL`_, un tool di analisi statica integrato in `GitHub`_; - `CodeQL`_, un tool di analisi statica integrato in `GitHub`_;
- `Dependabot`_, un tool di analisi delle dipendenze integrato in `GitHub`_;
- `Sphinx`_, uno strumento per la creazione di documentazione. - `Sphinx`_, uno strumento per la creazione di documentazione.
@ -32,6 +33,7 @@ Per sviluppare Sophon sono usati i seguenti strumenti:
.. _CodeQL: https://codeql.github.com/ .. _CodeQL: https://codeql.github.com/
.. _GitHub Containers: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry .. _GitHub Containers: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry
.. _Sphinx: https://www.sphinx-doc.org/ .. _Sphinx: https://www.sphinx-doc.org/
.. _Dependabot: https://dependabot.com/
.. seealso:: .. seealso::

View file

@ -0,0 +1,6 @@
Continuous Integration
----------------------
Il codice sorgente del modulo viene automaticamente controllato attraverso GitHub Actions da **CodeQL** e **Dependabot** ad ogni modifica, segnalando gli eventuali errori o dipendenze non aggiornate nel pannello *Security* del repository.
.. image:: ci_example.png

View file

@ -0,0 +1,10 @@
Continuous Deployment
---------------------
L'immagine del modulo viene automaticamente ricompilata da GitHub Actions e pubblicata su GitHub Containers ogni volta che un file all'interno della cartella del modulo viene modificato.
Questo workflow è definito all'interno del file ``.github/workflows/build-docker-backend.yml``.
.. seealso::
`La pagina del container <https://github.com/Steffo99/sophon/pkgs/container/sophon-backend>`_ su GitHub Containers.

BIN
docs/source/3_dev/2_structure/1_backend/cd_example.png (Stored with Git LFS) Normal file

Binary file not shown.

BIN
docs/source/3_dev/2_structure/1_backend/ci_example.png (Stored with Git LFS) Normal file

Binary file not shown.

View file

@ -24,3 +24,5 @@ Il *modulo backend* consiste in un server web che espone un'API e un sito web pe
3_core 3_core
4_projects 4_projects
5_notebooks 5_notebooks
6_ci
7_cd

View file

@ -0,0 +1,6 @@
Continuous Integration
----------------------
Il codice sorgente del modulo viene automaticamente controllato attraverso GitHub Actions da **CodeQL** e **Dependabot** ad ogni modifica, segnalando gli eventuali errori o dipendenze non aggiornate nel pannello *Security* del repository.
.. image:: ci_example.png

View file

@ -0,0 +1,10 @@
Continuous Deployment
---------------------
L'immagine del modulo viene automaticamente ricompilata da GitHub Actions e pubblicata su GitHub Containers ogni volta che un file all'interno della cartella del modulo viene modificato.
Questo workflow è definito all'interno del file ``.github/workflows/build-docker-frontend.yml``.
.. seealso::
`La pagina del container <https://github.com/Steffo99/sophon/pkgs/container/sophon-frontend>`_ su GitHub Containers.

BIN
docs/source/3_dev/2_structure/2_frontend/cd_example.png (Stored with Git LFS) Normal file

Binary file not shown.

BIN
docs/source/3_dev/2_structure/2_frontend/ci_example.png (Stored with Git LFS) Normal file

Binary file not shown.

View file

@ -17,3 +17,6 @@ Il modulo è formato dal package JavaScript :mod:`@steffo45/sophon-frontend`, ch
2_tree 2_tree
3_resources 3_resources
4_contexts 4_contexts
5_ci
6_cd

View file

@ -4,7 +4,6 @@ Struttura del progetto
Sophon è composto da quattro moduli, *backend*, *frontend*, *proxy* e *jupyter*, che interagiscono tra loro per fornire agli utenti tutti i servizi necessari. Sophon è composto da quattro moduli, *backend*, *frontend*, *proxy* e *jupyter*, che interagiscono tra loro per fornire agli utenti tutti i servizi necessari.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2