From 76c336f8c31a2bcb013272a13c4a76b24389e66b Mon Sep 17 00:00:00 2001 From: edivalentinitu Date: Thu, 20 Mar 2025 14:34:10 +0100 Subject: [PATCH 1/3] Update README.md --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 0b6041d..33a0d6a 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,7 @@ Following is an overview of the generated files and folders: | ``templates`` | Folder for your Jinja templates. | | ``.invenio`` | Common file used by Invenio-CLI to be version controlled. | | ``.invenio.private`` | Private file used by Invenio-CLI *not* to be version controlled. | +| ``.github/workflows`` | Folder to add or edit github workflows. | ## Documentation @@ -59,3 +60,19 @@ For detailed steps on working with UV, check the [Working with UV](./UV-GUIDE.md | ``Dockerfile`` | Dockerfile used to build base image, without theme. | | ``Dockerfile.mug`` | Dockerfile used to build MUG image. | | ``Dockerfile.theme`` | Dockerfile used to build default override theme image. | + + +## CI/CD + +There are 2 workflows implemented now. The main goal is CI so that the end result of these workflows is a fully functional and deployed instance image, whenever triggered. + +- **build and push docker image** + - runs either on a commit in the main branch or by manual trigger in Actions tab, Run workflow + - builds the MUG image with latest invenio-override main branch + - builds Theme image + + - **deploy** + - runs when **build and push docker image** is completed + - triggers Gitlab pipeline with the current docker image tags which will handle the actual deployment of the newly created images + + From 012a625593f88c12bd8fc52d31347e16b581afcc Mon Sep 17 00:00:00 2001 From: mb-wali <44528277+mb-wali@users.noreply.github.com> Date: Fri, 21 Mar 2025 08:31:24 +0100 Subject: [PATCH 2/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 33a0d6a..16e2b01 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ For detailed steps on working with UV, check the [Working with UV](./UV-GUIDE.md There are 2 workflows implemented now. The main goal is CI so that the end result of these workflows is a fully functional and deployed instance image, whenever triggered. - **build and push docker image** - - runs either on a commit in the main branch or by manual trigger in Actions tab, Run workflow + - This workflow runs automatically on every commit to the main branch and whenever a new tag is created for the repository. Additionally, it can be triggered manually from the Actions tab under 'Run workflow,' where you can select a different branch. This process results in the creation of a new Docker image, tagged with the branch name or the tag name. - builds the MUG image with latest invenio-override main branch - builds Theme image From 4089b34a5abfba0568760fe68f873d4ff2f2fe71 Mon Sep 17 00:00:00 2001 From: mb-wali <44528277+mb-wali@users.noreply.github.com> Date: Fri, 21 Mar 2025 08:32:14 +0100 Subject: [PATCH 3/3] Update README.md --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 16e2b01..0553ba0 100644 --- a/README.md +++ b/README.md @@ -68,8 +68,6 @@ There are 2 workflows implemented now. The main goal is CI so that the end resul - **build and push docker image** - This workflow runs automatically on every commit to the main branch and whenever a new tag is created for the repository. Additionally, it can be triggered manually from the Actions tab under 'Run workflow,' where you can select a different branch. This process results in the creation of a new Docker image, tagged with the branch name or the tag name. - - builds the MUG image with latest invenio-override main branch - - builds Theme image - **deploy** - runs when **build and push docker image** is completed