Merge branch 'release_by_ci-cd' into v2.0.0

.gitlab-ci.yml

 variables:
     GIT_SUBMODULE_STRATEGY: recursive
     GIT_SUBMODULE_FORCE_HTTPS: "true"
+
     DOCKER_HOST: tcp://docker:2375
     DOCKER_TLS_CERTDIR:
     DOCKER_DRIVER: overlay2
+
+    PROJECT_NAME: DojoExerciseChecker
+
+    VERSION_DEV_SUFFIX: '-dev'
+
+    GITLAB_API_PROJECT_URL: ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}
+
     DOCKERFILE: Dockerfile_ExerciseChecker
-    PLATFORMS: linux/amd64,linux/arm64/v8
-    CHECKER_PROJECT_FOLDER: ExerciseChecker
+    DOCKER_PLATFORMS: linux/amd64,linux/arm64/v8
 
-stages:
-    - build
-    - release
+    PROJECT_FOLDER: ExerciseChecker
 
-default:
-    tags:
-        - docker
-    image: docker:latest
-    services:
-        - docker:dind
-    before_script:
+
+.get_version:
+    script:
+        - IS_DEV=$([[ $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH ]] && echo false || echo true)
+        - VERSION=$(jq -r .version $PROJECT_FOLDER/package.json)$([[ $IS_DEV == true ]] && echo $VERSION_DEV_SUFFIX || echo '')
+        - DOCKER_LOCAL_IMAGE_PATH=$ARTIFACTS_FOLDER/$VERSION.tar
+
+.get_packages_url:
+    script:
+        - PACKAGE_URL_DOCKER_IMAGE="${PACKAGE_REGISTRY_URL}/${VERSION}/${PROJECT_NAME}.tar"
+
+.init_dind_script:
+    script:
+        # Install dependencies
         - apk update
         - apk add git
         - apk add jq
-        - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
+        # Init docker buildx
+        - docker login -u $DOCKER_REGISTRY_USER -p $DOCKER_REGISTRY_PASSWORD $DOCKER_REGISTRY
         - docker buildx create --use
-        - > 
-            VERSION=$(jq -r .version $CHECKER_PROJECT_FOLDER/package.json)
-        - >
-            CONTAINER_IMAGE=$CI_REGISTRY_IMAGE:$VERSION-dev
+        # Get version from package.json
+        - !reference [.get_version, script]
+        - CONTAINER_IMAGE=$DOCKER_REGISTRY_IMAGE:$VERSION
 
-build:
-    stage: build
-    tags:
-        - build
+.build_script:
     script:
+        - !reference [ .init_dind_script, script ]
+        - mkdir -p $ARTIFACTS_FOLDER
+        # Download secure files
         - apk add curl
         - curl --silent "https://gitlab.com/gitlab-org/incubation-engineering/mobile-devops/download-secure-files/-/raw/main/installer" | sh
-        - mv .secure_files/env_$VERSION $CHECKER_PROJECT_FOLDER/.env
+        - mv .secure_files/env_$VERSION $PROJECT_FOLDER/.env
         # Need to build for each platform separately because of multi-stage builds (docker buildx don't use cache same way as docker build)
         - >
-            platform_array=$(echo $PLATFORMS | tr "," "\n");
+            platform_array=$(echo $DOCKER_PLATFORMS | tr "," "\n");
             for platform in $platform_array; do
               echo "Buildind for : $platform"
               docker buildx build --pull --platform $platform --file $DOCKERFILE --tag $CONTAINER_IMAGE .
             done
+
+.clean_release:
+    script:
+        # Delete release if it already exists
+        - 'curl --request DELETE --header "JOB-TOKEN: $CI_JOB_TOKEN" "${GITLAB_API_PROJECT_URL}/releases/${VERSION}"'
+        # Delete tag if it already exists (use private-token because job-token don't have permission to delete tags)
+        - 'curl --request DELETE --header "PRIVATE-TOKEN: $GITLAB_PROJECT_ACCESS_TOKEN" "${GITLAB_API_PROJECT_URL}/repository/tags/${VERSION}"'
+    
+
+stages:
+    - build
+    - clean-same-release
+    - clean-dev-release
+    - release
+
+build:test:
+    stage: build
+    tags:
+        - build
+        - dind
+    image: docker:latest
+    services:
+        - docker:dind
+    script:
+        - !reference [ .build_script, script ]
+    rules:
+        - if: '$CI_COMMIT_TAG =~ "/^$/" && $CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH && $CI_COMMIT_BRANCH !~ /^v[0-9]+(\.[0-9]+)*$/'
+
+build:version:
+    stage: build
+    tags:
+        - build
+        - dind
+    image: docker:latest
+    services:
+        - docker:dind
+    script:
+        - !reference [ .build_script, script ]
         # Here docker buildx can use cached images created in previous step
-        - docker buildx build --platform $PLATFORMS --file $DOCKERFILE --push --tag $CONTAINER_IMAGE .
+        - docker buildx build --platform $DOCKER_PLATFORMS --file $DOCKERFILE --push --tag $CONTAINER_IMAGE .
+    rules:
+        - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH || $CI_COMMIT_BRANCH =~ /^v[0-9]+(\.[0-9]+)*$/'
+
+clean:release:
+    stage: clean-same-release
+    tags:
+        - gitlab_clean
+    image: registry.gitlab.com/gitlab-ci-utils/curl-jq:latest
+    script:
+        - !reference [.get_version, script]
+        - !reference [.clean_release, script]
     rules:
         - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH || $CI_COMMIT_BRANCH =~ /^v[0-9]+(\.[0-9]+)*$/'
 
-release-image:
+clean-dev:release:
+    stage: clean-dev-release
+    tags:
+        - gitlab_clean
+    image: registry.gitlab.com/gitlab-ci-utils/curl-jq:latest
+    script:
+        - !reference [.get_version, script]
+        - VERSION="${VERSION}${VERSION_DEV_SUFFIX}"
+        - !reference [.clean_release, script]
+    rules:
+        - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+
+clean:dockerhub:dev:
+    stage: clean-dev-release
+    tags:
+        - clean
+        - dind
+    image: docker:latest
+    services:
+        - docker:dind
+    script:
+        - !reference [.init_dind_script, script]
+        - VERSION="${VERSION}${VERSION_DEV_SUFFIX}"
+        # Remove dev tag
+        ## Login to dockerhub (get JWT token)
+        - GET_TOKEN_DATA=$(jq --null-input --arg username "$DOCKER_REGISTRY_USER" --arg password "$DOCKER_REGISTRY_PASSWORD" '{"username":$username,"password":$password}')
+        - >
+            TOKEN=`curl --data "${GET_TOKEN_DATA}" \
+              --header "Content-Type: application/json" \
+              --header "JOB-TOKEN: $CI_JOB_TOKEN" \
+              "https://hub.docker.com/v2/users/login/" | jq -r .token`
+        ## Delete tag
+        - 'curl --header "Authorization: JWT ${TOKEN}" --request DELETE "https://hub.docker.com/v2/repositories/${DOCKER_REGISTRY_IMAGE}/tags/${VERSION}/"'
+    rules:
+         - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+
+release:dockerhub:latest:
     stage: release
     tags:
         - release
+        - dind
+    image: docker:latest
+    services:
+        - docker:dind
     script:
-        - docker buildx imagetools create $CONTAINER_IMAGE --tag $CI_REGISTRY_IMAGE:$VERSION
-        - docker buildx imagetools create $CONTAINER_IMAGE --tag $CI_REGISTRY_IMAGE:latest
+        - !reference [.init_dind_script, script]
+        # Push latest tag
+        - docker buildx imagetools create $CONTAINER_IMAGE --tag $DOCKER_REGISTRY_IMAGE:latest
     rules:
          - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+
+release_job:
+    stage: release
+    tags:
+        - release
+    image: registry.gitlab.com/gitlab-ci-utils/curl-jq:latest
+    script:
+        - !reference [.get_version, script]
+        - !reference [.get_packages_url, script]
+        - echo 'Running release_job'
+        # Extract description from CHANGELOG.md
+        - CHANGELOG_LINE_START=`awk '/##\ [0-9]+\.[0-9]+\.[0-9]+/{print NR; exit;}' CHANGELOG.md`
+        - CHANGELOG_LINE_END=`awk '/##\ [0-9]+\.[0-9]+\.[0-9]+/{ count++; if(count>1) {print NR; exit;}}' CHANGELOG.md`
+        - DESCRIPTION=`awk 'NR > '$CHANGELOG_LINE_START' && NR < '$CHANGELOG_LINE_END'' CHANGELOG.md`
+        # Create Release (can't be done by release_step of gitlab image because it don't have access to env var defined in script_step)
+        - >
+            RELEASE_DATA=$(jq --null-input --arg version "$VERSION" --arg description "# Changelog (version $VERSION) $DESCRIPTION" --arg tag_name "$VERSION" --arg ref "$CI_COMMIT_SHORT_SHA" '{
+                "name": $version,
+                "description": $description,
+                "tag_name": $tag_name,
+                "ref": $ref
+            }')
+        - >
+            curl --data "${RELEASE_DATA}" \
+              --header "Content-Type: application/json" \
+              --header "JOB-TOKEN: $CI_JOB_TOKEN" \
+              --request POST "${GITLAB_API_PROJECT_URL}/releases"
+    rules:
+        - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH || $CI_COMMIT_BRANCH =~ /^v[0-9]+(\.[0-9]+)*$/'
\ No newline at end of file

CHANGELOG.md

+# Changelog
+
+<!--
+### ✨ Feature
+### 🤏 Minor change
+### 🎨 Interface
+### 🐛 Bugfix
+### 🔒 Security
+### 🚀‍️ CI / CD
+### 🔨 Internal / Developers
+### 📚 Documentation
+
+**💥 Breaking:**
+**⚠️ Deprecation:**
+-->
+
+## 2.0.0 (2023-09-15)
+
+### ✨ Feature
+- Added license: AGPLv3
+
+### 🎨 Interface
+- **💥 Breaking:** Renamed `enonce` to `assignment`
+- **💥 Breaking:** Renamed `exercice` to `exercise`
+
+### 🔨 Internal / Developers
+- Auto release by pipeline
+    - For vX.Y.Z branch create release and tag with `-dev` suffix
+    - For main branch create definitive release and remove `-dev` releases
+
+
+## 1.0.1 (2023-08-12)
+
+### ✨ Feature
+- 🎉 Initial release of the project
\ No newline at end of file