[neon/ubuntu-core/models.add-models-pipeline] /: Models CI: Add CONTRIBUTING instructions

[Antoine Gonzalez]

Git commit 8ce62bb517ffaaec99ae6b4bff73b443d9b5a57c by Antoine Gonzalez.
Committed on 07/08/2024 at 09:31.
Pushed by daspood into branch 'models.add-models-pipeline'.

Models CI: Add CONTRIBUTING instructions

A  +15   -0    CONTRIBUTING
M  +1    -1    debian/snap-image-model.yml

https://invent.kde.org/neon/ubuntu-core/-/commit/8ce62bb517ffaaec99ae6b4bff73b443d9b5a57c

diff --git a/CONTRIBUTING b/CONTRIBUTING
new file mode 100644
index 0000000..33eeea4
--- /dev/null
+++ b/CONTRIBUTING
@@ -0,0 +1,15 @@
+## Generate new model files for the image
+
+After changing the `kde-neon-core-amd64.json` file, you will need to update the signed `kde-neon-core-*-amd64.model`
+files in order to build the image. If you do not have the necessary credentials to sign these models locally, you can
+use the CI instead.
+
+In the Gitlab web interface, go to the Pipelines page and click the "Run pipeline" button. This will take you to
+https://invent.kde.org/neon/ubuntu-core/-/pipelines/new. On this page, select your branch, and click the "Run pipeline"
+button again. In the pipeline view, you can click the "snap_image_model" job to manually start it.
+
+Your branch needs to be protected, and its name needs to match the `models.*` pattern for the job to run.
+
+Once the job is complete, it will upload both `dangerous` and `signed` versions of the model as pipeline artefacts, and
+push them to your branch in a "Update models" commit. Once you pull the commit, you will be able to build the full image
+locally.
\ No newline at end of file
diff --git a/debian/snap-image-model.yml b/debian/snap-image-model.yml
index 88e737a..bc4de36 100644
--- a/debian/snap-image-model.yml
+++ b/debian/snap-image-model.yml
@@ -40,7 +40,7 @@ snap_image_model:
     - git config user.email "ubuntu-neon-core-models-bot at kde.org"
     - git config user.name "ubuntu-neon-core models-bot"
     - git add -f ./*.model
-    - git commit -m "Models Bot: Update models"
+    - git commit -m "Update models"
     - git push https://project_17308_bot_a45360256b28775b175cf622f6b817ad:${UBUNTU_NEON_CORE_ACCESS_TOKEN}@invent.kde.org/neon/ubuntu-core.git HEAD:$CI_COMMIT_REF_NAME -o ci.skip
   interruptible: true
   after_script: