Merge pull request #67 from oldgiova/MC-7477-app-update-module-bootstrap

ci: remote trigger and docs fixes
mendersoftware · Sep 18, 2024 · b343fee · b343fee
2 parents e3a8b4b + 69513a2
commit b343fee
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 77 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+cliff.toml
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -141,6 +141,8 @@ changelog:
     - npm install -g git-cliff
     # GITHUB_TOKEN for Github cli authentication
     - export GITHUB_TOKEN=${GITHUB_CLI_TOKEN}
+    # getting the centralized git cliff config
+    - wget --output-document cliff.toml https://raw.githubusercontent.com/mendersoftware/mendertesting/master/utils/cliff.toml
   script:
     - release-please release-pr
         --token=${GITHUB_BOT_TOKEN_REPO_FULL}
@@ -154,12 +156,12 @@ changelog:
     - test -z "$RELEASE_PLEASE_PR" && echo "No release-please PR found" && exit 0
     - echo "INFO - generating changelog notes from git cliff"
         && gh pr checkout $RELEASE_PLEASE_PR
-        && git cliff --output CHANGELOG.md --bump
+        && git cliff --output CHANGELOG.md --bump --github-repo ${GITHUB_REPO_URL}
         && git add CHANGELOG.md
         && git commit --amend -s --no-edit
         && git push origin --force
     - echo "INFO - updating PR body"
-        && git cliff --unreleased --bump -o tmp_pr_body.md
+        && git cliff --unreleased --bump -o tmp_pr_body.md --github-repo ${GITHUB_REPO_URL}
         && gh pr edit $RELEASE_PLEASE_PR --body-file tmp_pr_body.md
         && rm tmp_pr_body.md
 
@@ -184,7 +186,7 @@ release:mender-docs-changelog:
   tags:
     - hetzner-amd-beefy
   rules:
-    - if: $CI_COMMIT_BRANCH == $DEFAULT_BRANCH && $RUN_RELEASE == "true"
+    - if: $CI_COMMIT_TAG =~ "/^\d+\.\d+\.\d+$/"
   before_script:
     - apk add git bash curl jq github-cli
     - |
@@ -197,8 +199,8 @@ release:mender-docs-changelog:
     - cd ${GITHUB_CHANGELOG_REPO_URL#*/}
     - git checkout -b changelog-${CI_PIPELINE_ID}
     - |
-      cat docs_header.md > ${CHANGELOG_REMOTE_FILE}
-      cat ../CHANGELOG.md >> ${CHANGELOG_REMOTE_FILE}
+      cat ../docs_header.md > ${CHANGELOG_REMOTE_FILE}
+      cat ../CHANGELOG.md | grep -v -E '^---' >> ${CHANGELOG_REMOTE_FILE}
       git add ${CHANGELOG_REMOTE_FILE}
       git commit -s -m "chore: add app-update-module changelog"
       git push origin changelog-${CI_PIPELINE_ID}
@@ -211,6 +213,6 @@ release:mender-dist-packages:
     project: Northern.tech/Mender/mender-dist-packages
     strategy: depend
   variables:
-    MENDER_APP_UPDATE_MODULE_VERSION: ${CI_COMMIT_REF_NAME}
+    MENDER_APP_UPDATE_MODULE_VERSION: ${CI_COMMIT_TAG}
   rules:
-    - if: $CI_COMMIT_TAG =~ "/^\d+\.\d+\.x$/"
+    - if: $CI_COMMIT_TAG =~ "/^\d+\.\d+\.\d+$/"
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,71 +21,6 @@
 
 ## 1.0.0 - 2024-01-03
 
-
-### Bug Fixes
-
-
-- Bash test framework: cleanup phase, and misc. ([MEN-6366](https://northerntech.atlassian.net/browse/MEN-6366)) ([79a13a9](79a13a9024671c45434a4a1f22f20b5302bfab0f))
-  misc fixes:
-  * local variable (bt framework)
-  * license in config file
-  * misspell (in tests)
-- Create modules directory if does not exist during install ([MEN-6196](https://northerntech.atlassian.net/browse/MEN-6196)) ([11e827a](11e827a0d41bcedd184923b11e77d511f0424440))
-- Pass mode properly to install  ([f9b69e5](f9b69e555bc502e97cc1d3bd5ef76387c82d362e))
-- DESTDIR and prefix support in the Makefile  ([2049e62](2049e626eb4719de582b6232a25572a7eb959707))
-- Missing default declarations of `k8s_ctr_address` and `k8s_namespace`  ([bd069fe](bd069fe6d4cf0bb44d7bda7315fa1f48945b7dad))
-
-
-
-
-### Documentation
-
-
-- *(compose)* Add documentation to compose configuration
-- Basic readme content  ([5647a62](5647a62affb7d63e13016daadadc36631cee1860))
-
-
-
-
-### Features
-
-
-- App update module generator generator. ([MEN-6080](https://northerntech.atlassian.net/browse/MEN-6080)) ([31c843c](31c843c04a74912cb9d0d335098cd2f06dedf156))
-- App Update Module. ([MEN-6076](https://northerntech.atlassian.net/browse/MEN-6076)) ([4d4c36e](4d4c36ee03aafa19fc8c56d5ad0416c8f18238d8))
-- Deep delta support: binary delta between image layers. ([MEN-6081](https://northerntech.atlassian.net/browse/MEN-6081)[MEN-6195](https://northerntech.atlassian.net/browse/MEN-6195)) ([f23d554](f23d5545189d9b320224bdd12bf29263ff46edf1))
-  We can significantly reduce the binary delta size by taking
-  into account corresponding layers inside the image.
-
-  * add support for the generation of delta between layer.tar files
-  * modify LOAD operation in the docker-compose orchestrator sub-module
-- Bash test framework ([MEN-6082](https://northerntech.atlassian.net/browse/MEN-6082)) ([69951a4](69951a4359333d84f73bbe54650b21337e2c6c58))
-- Detecting composition errors and handling ([MEN-6367](https://northerntech.atlassian.net/browse/MEN-6367)) ([3f2a6b6](3f2a6b643cfee01adba355f4b0f4bd20bcfaadbc))
-- Configuration for orchestrator sub modules ([MEN-6366](https://northerntech.atlassian.net/browse/MEN-6366)) ([7ed8099](7ed809977f8ae0ef7dd5186b36bdcf6717370479))
-- Requirements check. ([MEN-6368](https://northerntech.atlassian.net/browse/MEN-6368)) ([add40cd](add40cd29cd8f78e8b45ee5e67e43fdace9241c3))
-- K8s support ([MEN-6194](https://northerntech.atlassian.net/browse/MEN-6194)) ([e1bb1eb](e1bb1ebb27dab628fdf6cb32ac461dd413db55df))
-- Cleanup, save, rollback. ([MEN-6077](https://northerntech.atlassian.net/browse/MEN-6077)) ([4538e3c](4538e3c8472d8a9ffd19ac42a3430136b555fb5a))
-
-
-
-
-### Testing
-
-
-- App-gen smoke test ([MEN-6079](https://northerntech.atlassian.net/browse/MEN-6079)) ([c812e1f](c812e1f2832de0be5bec2d58c6ee9530711cab64))
-- Update module ArtifactInstall test. ([MEN-6079](https://northerntech.atlassian.net/browse/MEN-6079)) ([3a3b944](3a3b94410b8a1a30e3bb2c195bd89ba33fe57532))
-- Fixing the expected shasums mechanism  ([b6d41da](b6d41daa0baf0eba36af3a5161e9fe5447aaa359))
-- Acceptance test. ([MEN-6082](https://northerntech.atlassian.net/browse/MEN-6082)) ([2055a31](2055a3136c8c73f6823875db7f3e08ab81bd8463))
-- Verify that no pulling appeared ([MEN-6556](https://northerntech.atlassian.net/browse/MEN-6556)) ([45ba921](45ba9214fd12a8fee74f9cf1750176bd3aadc384))
-
-
-
-
-### Refac
-
-
-- *(app)* Refactor assert_requirements to only check status code
-
-
-
+* First release of app-update-module
 
 ---
diff --git a/cliff.toml b/cliff.toml
@@ -1,6 +1,12 @@
 # git-cliff ~ configuration file
 # https://git-cliff.org/docs/configuration
 
+
+# Documentation:
+# Set a script step like this in the pipeline where git cliff is used: 
+# wget https://github.com/mendersoftware/mendertesting/blob/master/utils/cliff.toml
+
+
 [changelog]
 # template for the changelog footer
 header = """---"""
@@ -27,7 +33,16 @@ body = """
     {%- for commit in commits | unique(attribute="message") %}
         {%- if commit.scope -%}
         {% else -%}
-            - {{ commit.message | upper_first }} {% if commit.links %}({% for link in commit.links | unique(attribute="text") %}[{{ link.text }}]({{ link.href }}){% endfor -%}){% endif %} ([{{ commit.id | truncate(length=7, end="") }}]({{ commit.id }}))
+            - {{ commit.message | upper_first }}\
+                  {% if commit.links %}\
+                    ({% for link in commit.links | unique(attribute="text") %}\
+                        [{{ link.text }}]({{ link.href }})\
+                    {% endfor -%})\
+                  {% endif %} \
+                  ([{{ commit.id | truncate(length=7, end="") }}]\
+                  (https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}/commit/{{ commit.id }})) \
+                  {% if commit.github.username %} by @{{ commit.github.username }}{%- endif %}\
+                  {% if commit.github.pr_number %} in #{{ commit.github.pr_number }}{%- endif %}
             {% if commit.breaking -%}
             {% raw %}  {% endraw %}- **BREAKING**: {{commit.breaking_description}}
             {% endif -%}
@@ -75,7 +90,7 @@ commit_parsers = [
     { message = "^perf", group = "Performance" },
     { message = "^refactor", group = "Refactor" },
     { message = "^style", group = "Styling" },
-    { message = "^test", group = "Testing" },
+    { message = "^test", group = "Testing", skip = true },
     { message = ".*Changelog: None", skip = true },
     { message = "^chore: bump", group = "Security" },
     { message = "^chore|^ci", skip = true },
@@ -105,4 +120,3 @@ sort_commits = "oldest"
 [bump]
 features_always_bump_minor = true
 breaking_always_bump_major = true
-
diff --git a/docs_header.md b/docs_header.md
@@ -6,4 +6,3 @@ shortcode-core:
     active: false
 github: false
 ---
-