Skip to content

Gitlab Release / Commit Footer References

User Manual

All commit messages must be in conventional commit format and have a footer with a gitlab reference. The reference must be either a merge request or a gitlab issue. (format i.e. !1 or #2 using the correct reference number).

fixing commit messages

If only the last commit is the commit with an error just use git commit --amend and edit your commit message to be in the correct format and save. now push your changes.

You will require the following information if the commit message with the error is further down the commit tree:

  • Commit message SHA1 of your first commit message to the branch {original_commit}

  • Commit message SHA1 prior to your first commit {source_commit}

Run these commands once you have the information above.

git format-patch {original_commit}..HEAD -o ../diff-patches

git reset {source_commit} --hard

Now, navigate to the diff-patches folder, open up the offending patch (commit) and edit the subject or message body as appropriate and save. Once all the edits have been done, re-apply the patches to your tree with:

git am ../diff-patches/*.patch

Now push your changes upstream.

:notebook_with_decorative_cover: Note
As you have changed the commit SHA1(s), when you next push your changes upstream, you must force push. git push --force
:octagonal_sign: WARNING
Ensure that all of your commits were exported prior to reseting the branch and when re-applying, that all of your commits were applied correctly

GitLab CI Template - Developer Manual

Job: gitlab_release

This job bumps the version, updates the changelog, creates a git tag and creates a gitlab release. The git tag and release title use semantic versioning. for this job to function correctly a .cz.yaml is required in the root of the repository. this file contains the commitizen config and the version details.

Alert

If prior to merging to the master branch you do a version increment, and there are no commits prior to merging. the job will not increment the version and the job will fail. it is recommended that you only do a version increment on the development branch if you are going to commit further changes to the development branch

Stage

release

Image

The job uses the registry.gitlab.com/gitlab-org/release-cli:latest image.

Variables

The job does not use any additional variables.

Explanation

The gitlab_release job is responsible for creating releases and tags for the GitLab repository. It follows a specific release workflow and utilizes the release-cli tool to automate the release process.

Steps

  1. Set ROOT_DIR variable: Sets the ROOT_DIR variable based on the value of JOB_ROOT_DIR.

  2. Create necessary directories: Creates necessary directories for storing artifacts and tests.

  3. Install dependencies: Updates the package manager and installs Git and Python 3. Sets up the Python environment by installing required packages.

  4. Clone repository: Clones the repository using the provided authentication token and checks out the development branch.

  5. Configure Git: Configures Git settings for the release process.

  6. Perform release steps: Executes release-related steps, such as running a custom command ($MY_COMMAND), generating the release changelog, and tagging the release.

  7. Push changes: Pushes the changes to the GitLab repository.

  8. Cleanup: Removes the cloned repository.

Rules

  • The job is never triggered when $JOB_STOP_GITLAB_RELEASE is true.

  • The job is never triggered when the commit author is nfc_bot <helpdesk@nofusscomputing.com>.

  • If the commit is pushed to the master branch, the job is only triggered on successful pipeline execution and failure is not allowed.

  • If the commit is pushed to the development branch, the job is triggered manually and failure is allowed.

your .gitlab-ci.yml changes

To use this job add the following to your .gitlab-ci.yml file

CI Job ci commit footer is automatically set to run on all branches except development and master. This job checks the commits on the users branch that they contain a footer with gitlab references. i.e. #1 for issue one or !1 for merge request one.

stages:
    - validate
    - release

include:
    - remote: https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/raw/development/gitlab_release/.gitlab-ci.yml

Gitlab Release:
    variables:
        MY_COMMAND: "{your command here}"
    extends:
        - .gitlab_release

if you wish to run any commands you can add them to variable MY_COMMAND. The custom command will run under shell /bin/sh. This command is set to run before the version bump commit is conducted so any changes you wish to add as part of the version bump, you can do here as long as you git add {changed file name}.

Stage

validation

Image

The job uses the python:3.6-slim image.

Variables

  • DEFAULT_ROOT_DIR: The default root directory path.

Explanation

The commit_footer_refs job validates the commit footer references in the GitLab repository. It checks if the commit messages adhere to the conventional commit format and generates a JUnit XML report.

Conventional Commits

Conventional commits follow a specific format for commit messages, consisting of a type, optional scope, and a message. The format is as follows:

<type>(<scope>): <message>

  • The <type> represents the nature of the changes, such as feat for a new feature, fix for a bug fix, docs for documentation changes, and so on.

  • The <scope> (optional) provides additional context for the commit, indicating the module, component, or area of code being modified.

  • The <message> contains a concise and descriptive summary of the changes.

The commit footer can contain additional information, such as references to issues, feature requests, or pull requests.

Steps

  1. Create necessary directories: Creates necessary directories for storing artifacts and test results.

  2. Set ROOT_DIR variable: Sets the ROOT_DIR variable based on the value of JOB_ROOT_DIR.

  3. Install dependencies: Updates the package manager and installs Git and the required Python packages for the commit footer validation.

  4. Clone repository: Clones the repository and checks out the specified branch.

  5. Run commit_footer script: Executes the commit_footer script to validate the commit footer references.

  6. Generate artifacts: Generates a JUnit XML report for the test results.

Rules

  • The job is never triggered when $JOB_STOP_CONVENTIONAL_COMMITS is true.

  • The job is never triggered when CHANGELOG_FOOTER_REFERENCES is false.

  • The job is always triggered when the commit is not pushed to the master or development branch, and a .cz.yaml file is present, indicating the usage of conventional commits.

  • The job is never triggered otherwise.

Gitlab job Definition

When you include this definition the following makes up the job definition

.gitlab-ci.yml
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
.gitlab_release:
    stage: release
    image: registry.gitlab.com/gitlab-org/release-cli:latest
    before_script:
        - if [ "0$JOB_ROOT_DIR" == "0" ]; then ROOT_DIR=gitlab-ci; else ROOT_DIR=$JOB_ROOT_DIR ; fi
        - echo "[DEBUG] ROOT_DIR[$ROOT_DIR]"
        - mkdir -p "$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/$CI_JOB_NAME"
        - mkdir -p "$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/tests"
        - apk update
        - apk add git
        - apk add --update --no-cache python3 && ln -sf python3 /usr/bin/python
        - python -m ensurepip  && ln -sf pip3 /usr/bin/pip
        - pip install --upgrade pip
        - pip install -r $ROOT_DIR/gitlab_release/requirements.txt
        - pip install $ROOT_DIR/gitlab_release/python-module/cz_nfc/.
        - 'CLONE_URL="https://gitlab-ci-token:$GIT_COMMIT_TOKEN@gitlab.com/$CI_PROJECT_PATH.git"'
        - echo "[DEBUG] CLONE_URL[$CLONE_URL]"
        - git clone -b development $CLONE_URL repo
        - cd repo
        - git branch
        - git config --global user.email "helpdesk@nofusscomputing.com"
        - git config --global user.name "nfc_bot"
        - git push --set-upstream origin development
        - RELEASE_VERSION_CURRENT=$(cz -n cz_nfc version --project)        
    script:
        - "$MY_COMMAND"
        - if [ "$CI_COMMIT_BRANCH" == "development" ] ; then RELEASE_CHANGELOG=$(cz -n cz_nfc bump --changelog --changelog-to-stdout --prerelease rc); else RELEASE_CHANGELOG=$(cz -n cz_nfc bump --changelog --changelog-to-stdout); fi
        - RELEASE_VERSION_NEW=$(cz -n cz_nfc version --project)
        - RELEASE_TAG=$RELEASE_VERSION_NEW
        - echo "[DEBUG] RELEASE_VERSION_CURRENT[$RELEASE_VERSION_CURRENT]"
        - echo "[DEBUG] RELEASE_CHANGELOG[$RELEASE_CHANGELOG]"
        - echo "[DEBUG] RELEASE_VERSION_NEW[$RELEASE_VERSION_NEW]"
        - echo "[DEBUG] RELEASE_TAG[$RELEASE_TAG]"
        - RELEASE_TAG_SHA1=$(git log -n1 --format=format:"%H")
        - echo "[DEBUG] RELEASE_TAG_SHA1[$RELEASE_TAG_SHA1]"
        - if [ "0$RELEASE_VERSION_CURRENT" == "0$RELEASE_VERSION_NEW" ]; then echo "[DEBUG] No tag to delete, version was not bumped"; else git tag -d $RELEASE_TAG; fi

        - if [ "0$RELEASE_VERSION_CURRENT" == "0$RELEASE_VERSION_NEW" ]; then echo "[DEBUG] No push will be conducted, version was not bumped"; else git push; fi
        - if [ "0$RELEASE_VERSION_CURRENT" == "0$RELEASE_VERSION_NEW" ]; then echo "[DEBUG] No release will be created, version was not bumped"; else release-cli create --name "Release $RELEASE_TAG" --tag-name "$RELEASE_TAG" --tag-message "$RELEASE_CHANGELOG" --ref "$RELEASE_TAG_SHA1" --description "$RELEASE_CHANGELOG"; fi
        - if [ "$CI_COMMIT_BRANCH" == "master" ] ; then git checkout master; fi
        - if [ "$CI_COMMIT_BRANCH" == "master" ] ; then git push --set-upstream origin master; fi
        - if [ "$CI_COMMIT_BRANCH" == "master" ] ; then git merge --no-ff development; fi
        - if [ "$CI_COMMIT_BRANCH" == "master" ] ; then git push origin master; fi
    after_script:
        - rm -Rf repo
    rules:
        - if: '$JOB_STOP_GITLAB_RELEASE'
          when: never

        - if: "$CI_COMMIT_AUTHOR =='nfc_bot <helpdesk@nofusscomputing.com>'"
          when: never

        - if: # condition_master_branch_push
            $CI_COMMIT_BRANCH == "master" && 
            $CI_PIPELINE_SOURCE == "push"
          allow_failure: false
          when: on_success

        - if: # condition_dev_branch_push
            $CI_COMMIT_BRANCH == "development" && 
            $CI_PIPELINE_SOURCE == "push"
          when: manual
          allow_failure: true

        # for testing
        # - if: '$CI_COMMIT_BRANCH != "master"'
        #   when: always
        #   allow_failure: true
        - when: never


commit footer refs:
    stage: validation
    image: python:3.6-slim
    variables:
        DEFAULT_ROOT_DIR: './gitlab-ci'
    before_script:
        - mkdir -p "$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/$CI_JOB_NAME"
        - mkdir -p "$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/tests"
        - if [ "0$JOB_ROOT_DIR" == "0" ]; then export ROOT_DIR=$DEFAULT_ROOT_DIR; else export ROOT_DIR=$JOB_ROOT_DIR ; fi
        - echo "[DEBUG] ROOT_DIR[$ROOT_DIR]"
        - apt update
        - apt install --no-install-recommends -y git
        - pip install -e $ROOT_DIR/gitlab_release/python-module/commit_footer/.
        - git clone --depth 150 -b development $CI_REPOSITORY_URL check
        - cd check
        - git remote rm origin
        - git remote add origin $CI_REPOSITORY_URL
        - git fetch --all
        - git checkout --track origin/$CI_COMMIT_BRANCH
    script:
        - commit_footer > "$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/tests/$CI_JOB_NAME.junit.xml"
    artifacts:
        expire_in: 1 days
        when: always
        paths:
            - "$CI_PROJECT_DIR/artifacts/*"
        reports:
            junit:
                - "$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/tests/*.junit.xml"
    rules:
        - if: '$JOB_STOP_CONVENTIONAL_COMMITS'
          when: never

        - if: $CHANGELOG_FOOTER_REFERENCES == "False"
          when: never

        # - if: '$CI_COMMIT_BRANCH == "development" || $CI_COMMIT_BRANCH == "master"'
        #   when: never

        - if: # condition_not_master_or_dev_push
            $CI_COMMIT_BRANCH != "master" && 
            $CI_COMMIT_BRANCH != "development" && 
            $CI_PIPELINE_SOURCE == "push" &&
            $CI_COMMIT_TAG == null
          exists:
          - .cz.yaml
          changes: 
            paths:
              - "**/**"
            compare_to: development
          when: always

        - when: never

About:

This page forms part of our Project Gitlab-CI.

Page Metadata
Version: ToDo: place files short git commit here
Date Created: 2021-08-03
Date Edited: 2023-06-10

Contribution:

Would You like to contribute to our Gitlab-CI project? You can assist in the following ways:

 

ToDo: Add the page list of contributors