{"id":2785,"date":"2020-03-14T13:21:21","date_gmt":"2020-03-14T12:21:21","guid":{"rendered":"https:\/\/www.aerian.fr\/?p=2785"},"modified":"2020-04-08T15:02:00","modified_gmt":"2020-04-08T13:02:00","slug":"english-gitlab-ci-automate-versions-releases","status":"publish","type":"post","link":"https:\/\/www.aerian.fr\/en\/english-gitlab-ci-automate-versions-releases\/","title":{"rendered":"Gitlab CI – Automate Versions & Releases"},"content":{"rendered":"
\n
\n\t

Introduction<\/h1>\n

Still continuing the series of Gitlab CIs & Automations,
\nThe current article will describe how to automate versions
\n& Releases publishing with semantic-release.<\/p>\n

The workflow I decided for my workflow is adapted from a basic Git
\nworkflow like:<\/p>\n

\"A
A git workflow model<\/figcaption><\/figure>\n

Summary<\/strong><\/p>\n

I create my Issue on my Gitlab project, open to branch from the issue, correct inside the branch,
\npush to dev, the CI\/CD deploy onto the dev platform, It fail because \"LIFE\", I correct inside the branch,
\npush to dev, version correctly functionnal on dev, merge from dev to master, deploy onto prod, THE END.<\/p>\n

So I wanted to be able to automatically publish version & release.
\nWhy ? Because I'm lazy. A computer guy is often lazy.<\/p>\n

I want to code and not have to trouble myself to search the last version
\nnumber, tag the commit on dev and \"et cetera\" on master.<\/p>\n

It's here that semantic-release software seemed like a good idea,
\nfor a description, here's their Github: https:\/\/github.com\/semantic-release\/semantic-release<\/a><\/p>\n

How it will works<\/h1>\n

I will use Angular syntax when publishing my commit,
\na CI\/CD to launch semantic release with will then detect the commit and create
\nthe tag & release with all the previous commits.<\/p>\n

In details<\/p>\n

.releaserc.json<\/h2>\n
{\n  \"plugins\": [\n    [\"@semantic-release\/commit-analyzer\", {\n      \"preset\": \"angular\",\n      \"releaseRules\": [\n        {\"type\": \"docs\", \"scope\":\"README\", \"release\": \"patch\"},\n        {\"type\": \"feat\", \"scope\":\"progress\", \"release\": \"patch\"},\n        {\"type\": \"feat\", \"scope\":\"validated\", \"release\": \"minor\"}\n      ],\n      \"parserOpts\": {\n        \"noteKeywords\": [\"BREAKING CHANGE\", \"BREAKING CHANGES\"]\n      }\n    }],\n    \"@semantic-release\/release-notes-generator\",\n    [\"@semantic-release\/changelog\", {\n      \"changelogFile\": \"CHANGELOG.md\"\n    }],\n    [\"@semantic-release\/git\", {\n      \"assets\": [\"CHANGELOG.md\"],\n      \"message\": \"chore(release): ${nextRelease.version}nn${nextRelease.notes}\"\n     }],\n    \"@semantic-release\/gitlab\"\n  ],\n  \"branches\": [\n      \"master\",\n          \"+([0-9])?(.{+([0-9]),x}).x\",\n      { \"name\": \"dev\", \"prerelease\": \"dev\"}\n  ]\n}\n<\/code><\/pre>\n
\/! Start Warning<\/strong><\/p>\n
The part with semantic-release\/changelog & semantic-release\/git allows me to update automatically the
\nCHANGELOG.md and push it to my git repo.<\/p>\n
I also noted it generate conflict due to using pre-release branch, so I do not advise to use the CHANGELOG at the same times
\nthat the pre-release option.<\/p>\n
Please note that I had to redefine the  \"message\" because semantic-release\/git use by default \"[skip-ci]\" in the message,
\nWhich, alas, blocked my deploy CI\/CD. I'm currently asking if there is a better way to do this in https:\/\/github.com\/semantic-release\/git\/issues\/201
\nlet's see if I can improve it again \ud83d\ude42<\/p>\n
\/! End Warning<\/strong><\/p>\n
I redefined the releaseRules because i'm still not fluent with Angular default rules.
\nI'll update it based on my daily needs, I advise you to start with standard (remove releaseRules)
\nand adapt to your needs.<\/p>\n
.release-ci.yml<\/h2>\n
release:\n  image: node:12\n  stage: release\n  only:\n    refs:\n    - master\n    - dev\n    # This matches maintenance branches\n    - \/^(([0-9]+).)?([0-9]+).x\/\n    # This matches pre-releases\n    - \/^([0-9]+).([0-9]+).([0-9]+)(?:-([0-9A-Za-z-]+(?:.[0-9A-Za-z-]+)*))?(?:+[0-9A-Za-z-]+)?$\/ \n  script:\n    - npm install @semantic-release\/gitlab\n    - npm install @semantic-release\/git\n    - npm install @semantic-release\/changelog\n    - npx semantic-release --debug\n<\/code><\/pre>\n
The CI\/CD will automatically install all the deps and work only on main branches.
\nI needed to fix the node version to node:12 due to it not working on node:12.<\/p>\n
.gitlab-ci.yml<\/h2>\n
And then the Gitlab CI.<\/p>\n
include:\n  - local: '.release-ci.yml'\n\nstages:\n  - release\n<\/code><\/pre>\n
Commit linting<\/h1>\n
In order to use correct commit syntax I also defined a commit linting hook like the following.<\/p>\n
.pre-commit-config.yaml<\/h2>\n
-   repo: https:\/\/github.com\/jorisroovers\/gitlint\n    rev:  v0.13.1\n    hooks:\n    -   id: gitlint\n        stages: [commit-msg]\n<\/code><\/pre>\n
It's installed to interact on commit, following the official documentation, you will need to install it like:
\npre-commit install --hook-type commit-msg<\/code><\/p>\n
Please note that I used specifically gitlint because it's in Python, so you can search for the
\nequivalent in your project language, maybe it exist, example: Node => commitlint.<\/p>\n
Don't forget to add the dependence in your requirements-dev.txt
\nand here you go.<\/p>\n
\"example_release\"
Example of release tagging<\/figcaption><\/figure>\n
\"commit
The example of commit done by semantic release<\/figcaption><\/figure>\n<\/div>\n<\/div><\/div><\/div>
<\/div><\/div><\/div><\/div><\/div><\/div>","protected":false},"excerpt":{"rendered":"
Introduction Still continuing the series of Gitlab CIs & Automations, The current article will describe how to automate versions & Releases publishing […]<\/p>\n","protected":false},"author":1,"featured_media":2791,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"ngg_post_thumbnail":0,"footnotes":""},"categories":[245],"tags":[252,241,254,240,242,246,251,250,253],"class_list":["post-2785","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-programming","tag-automation","tag-cd","tag-changelog","tag-ci","tag-gitlab","tag-python","tag-release","tag-semantic","tag-version"],"yoast_head":"\nGitlab CI - Automate Versions & Releases - Aerian.fr<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.aerian.fr\/en\/english-gitlab-ci-automate-versions-releases\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Gitlab CI - Automate Versions & Releases - Aerian.fr\" \/>\n<meta property=\"og:description\" content=\"Introduction Still continuing the series of Gitlab CIs & Automations, The current article will describe how to automate versions & Releases publishing […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.aerian.fr\/en\/english-gitlab-ci-automate-versions-releases\/\" \/>\n<meta property=\"og:site_name\" content=\"Aerian.fr\" \/>\n<meta property=\"article:published_time\" content=\"2020-03-14T12:21:21+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2020-04-08T13:02:00+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/www.aerian.fr\/wp-content\/uploads\/2020\/03\/12867925.png\" \/>\n\t<meta property=\"og:image:width\" content=\"400\" \/>\n\t<meta property=\"og:image:height\" content=\"400\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"author\" content=\"42\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@LinceAerian\" \/>\n<meta name=\"twitter:site\" content=\"@LinceAerian\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"42\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/www.aerian.fr\/english-gitlab-ci-automate-versions-releases\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/www.aerian.fr\/english-gitlab-ci-automate-versions-releases\/\"},\"author\":{\"name\":\"42\",\"@id\":\"https:\/\/www.aerian.fr\/#\/schema\/person\/622c3cefbea11a0be741137608b4bf8b\"},\"headline\":\"Gitlab CI – Automate Versions & Releases\",\"datePublished\":\"2020-03-14T12:21:21+00:00\",\"dateModified\":\"2020-04-08T13:02:00+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/www.aerian.fr\/english-gitlab-ci-automate-versions-releases\/\"},\"wordCount\":530,\"publisher\":{\"@id\":\"https:\/\/www.aerian.fr\/#organization\"},\"image\":{\"@id\":\"https:\/\/www.aerian.fr\/english-gitlab-ci-automate-versions-releases\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/www.aerian.fr\/wp-content\/uploads\/2020\/03\/12867925.png\",\"keywords\":[\"automation\",\"cd\",\"changelog\",\"ci\",\"gitlab\",\"python\",\"release\",\"semantic\",\"version\"],\"articleSection\":[\"Programming\"],\"inLanguage\":\"en-US\"},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.aerian.fr\/en\/english-gitlab-ci-automate-versions-releases\/\",\"url\":\"https:\/\/www.aerian.fr\/en\/english-gitlab-ci-automate-versions-releases\/\",\"name\":\"Gitlab CI - Automate Versions & Releases - Aerian.fr\",\"isPartOf\":{\"@id\":\"https:\/\/www.aerian.fr\/en\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/www.aerian.fr\/en\/english-gitlab-ci-automate-versions-releases\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/www.aerian.fr\/english-gitlab-ci-automate-versions-releases\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/www.aerian.fr\/wp-content\/uploads\/2020\/03\/12867925.png\",\"datePublished\":\"2020-03-14T12:21:21+00:00\",\"dateModified\":\"2020-04-08T13:02:00+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/www.aerian.fr\/en\/english-gitlab-ci-automate-versions-releases\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[[\"https:\/\/www.aerian.fr\/en\/english-gitlab-ci-automate-versions-releases\/\"]]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.aerian.fr\/en\/english-gitlab-ci-automate-versions-releases\/#primaryimage\",\"url\":\"https:\/\/www.aerian.fr\/wp-content\/uploads\/2020\/03\/12867925.png\",\"contentUrl\":\"https:\/\/www.aerian.fr\/wp-content\/uploads\/2020\/03\/12867925.png\",\"width\":400,\"height\":400,\"caption\":\"Logo of semantic release\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.aerian.fr\/en\/english-gitlab-ci-automate-versions-releases\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.aerian.fr\/en\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"(English) Gitlab CI – Automate Versions & Releases\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.aerian.fr\/en\/#website\",\"url\":\"https:\/\/www.aerian.fr\/en\/\",\"name\":\"Aerian.fr\",\"description\":\"Welcome to Aerian.fr\",\"publisher\":{\"@id\":\"https:\/\/www.aerian.fr\/en\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.aerian.fr\/en\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/www.aerian.fr\/en\/#organization\",\"name\":\"Aerian.fr\",\"url\":\"https:\/\/www.aerian.fr\/en\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.aerian.fr\/en\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/www.aerian.fr\/wp-content\/uploads\/2012\/01\/logo.png\",\"contentUrl\":\"https:\/\/www.aerian.fr\/wp-content\/uploads\/2012\/01\/logo.png\",\"width\":667,\"height\":522,\"caption\":\"Aerian.fr\"},\"image\":{\"@id\":\"https:\/\/www.aerian.fr\/en\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/x.com\/LinceAerian\",\"https:\/\/www.linkedin.com\/in\/marleixmathieu\"]},{\"@type\":\"Person\",\"@id\":\"https:\/\/www.aerian.fr\/#\/schema\/person\/622c3cefbea11a0be741137608b4bf8b\",\"name\":\"42\",\"sameAs\":[\"http:\/\/www.aerian.fr\"],\"url\":\"https:\/\/www.aerian.fr\/en\/author\/lince\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Gitlab CI - Automate Versions & Releases - Aerian.fr","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.aerian.fr\/en\/english-gitlab-ci-automate-versions-releases\/","og_locale":"en_US","og_type":"article","og_title":"Gitlab CI - Automate Versions & Releases - Aerian.fr","og_description":"Introduction Still continuing the series of Gitlab CIs & Automations, The current article will describe how to automate versions & Releases publishing […]","og_url":"https:\/\/www.aerian.fr\/en\/english-gitlab-ci-automate-versions-releases\/","og_site_name":"Aerian.fr","article_published_time":"2020-03-14T12:21:21+00:00","article_modified_time":"2020-04-08T13:02:00+00:00","og_image":[{"width":400,"height":400,"url":"https:\/\/www.aerian.fr\/wp-content\/uploads\/2020\/03\/12867925.png","type":"image\/png"}],"author":"42","twitter_card":"summary_large_image","twitter_creator":"@LinceAerian","twitter_site":"@LinceAerian","twitter_misc":{"Written by":"42","Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/www.aerian.fr\/english-gitlab-ci-automate-versions-releases\/#article","isPartOf":{"@id":"https:\/\/www.aerian.fr\/english-gitlab-ci-automate-versions-releases\/"},"author":{"name":"42","@id":"https:\/\/www.aerian.fr\/#\/schema\/person\/622c3cefbea11a0be741137608b4bf8b"},"headline":"Gitlab CI – Automate Versions & Releases","datePublished":"2020-03-14T12:21:21+00:00","dateModified":"2020-04-08T13:02:00+00:00","mainEntityOfPage":{"@id":"https:\/\/www.aerian.fr\/english-gitlab-ci-automate-versions-releases\/"},"wordCount":530,"publisher":{"@id":"https:\/\/www.aerian.fr\/#organization"},"image":{"@id":"https:\/\/www.aerian.fr\/english-gitlab-ci-automate-versions-releases\/#primaryimage"},"thumbnailUrl":"https:\/\/www.aerian.fr\/wp-content\/uploads\/2020\/03\/12867925.png","keywords":["automation","cd","changelog","ci","gitlab","python","release","semantic","version"],"articleSection":["Programming"],"inLanguage":"en-US"},{"@type":"WebPage","@id":"https:\/\/www.aerian.fr\/en\/english-gitlab-ci-automate-versions-releases\/","url":"https:\/\/www.aerian.fr\/en\/english-gitlab-ci-automate-versions-releases\/","name":"Gitlab CI - Automate Versions & Releases - Aerian.fr","isPartOf":{"@id":"https:\/\/www.aerian.fr\/en\/#website"},"primaryImageOfPage":{"@id":"https:\/\/www.aerian.fr\/en\/english-gitlab-ci-automate-versions-releases\/#primaryimage"},"image":{"@id":"https:\/\/www.aerian.fr\/english-gitlab-ci-automate-versions-releases\/#primaryimage"},"thumbnailUrl":"https:\/\/www.aerian.fr\/wp-content\/uploads\/2020\/03\/12867925.png","datePublished":"2020-03-14T12:21:21+00:00","dateModified":"2020-04-08T13:02:00+00:00","breadcrumb":{"@id":"https:\/\/www.aerian.fr\/en\/english-gitlab-ci-automate-versions-releases\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":[["https:\/\/www.aerian.fr\/en\/english-gitlab-ci-automate-versions-releases\/"]]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.aerian.fr\/en\/english-gitlab-ci-automate-versions-releases\/#primaryimage","url":"https:\/\/www.aerian.fr\/wp-content\/uploads\/2020\/03\/12867925.png","contentUrl":"https:\/\/www.aerian.fr\/wp-content\/uploads\/2020\/03\/12867925.png","width":400,"height":400,"caption":"Logo of semantic release"},{"@type":"BreadcrumbList","@id":"https:\/\/www.aerian.fr\/en\/english-gitlab-ci-automate-versions-releases\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.aerian.fr\/en\/"},{"@type":"ListItem","position":2,"name":"(English) Gitlab CI – Automate Versions & Releases"}]},{"@type":"WebSite","@id":"https:\/\/www.aerian.fr\/en\/#website","url":"https:\/\/www.aerian.fr\/en\/","name":"Aerian.fr","description":"Welcome to Aerian.fr","publisher":{"@id":"https:\/\/www.aerian.fr\/en\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.aerian.fr\/en\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/www.aerian.fr\/en\/#organization","name":"Aerian.fr","url":"https:\/\/www.aerian.fr\/en\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.aerian.fr\/en\/#\/schema\/logo\/image\/","url":"https:\/\/www.aerian.fr\/wp-content\/uploads\/2012\/01\/logo.png","contentUrl":"https:\/\/www.aerian.fr\/wp-content\/uploads\/2012\/01\/logo.png","width":667,"height":522,"caption":"Aerian.fr"},"image":{"@id":"https:\/\/www.aerian.fr\/en\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/x.com\/LinceAerian","https:\/\/www.linkedin.com\/in\/marleixmathieu"]},{"@type":"Person","@id":"https:\/\/www.aerian.fr\/#\/schema\/person\/622c3cefbea11a0be741137608b4bf8b","name":"42","sameAs":["http:\/\/www.aerian.fr"],"url":"https:\/\/www.aerian.fr\/en\/author\/lince\/"}]}},"_links":{"self":[{"href":"https:\/\/www.aerian.fr\/en\/wp-json\/wp\/v2\/posts\/2785","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.aerian.fr\/en\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.aerian.fr\/en\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.aerian.fr\/en\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.aerian.fr\/en\/wp-json\/wp\/v2\/comments?post=2785"}],"version-history":[{"count":21,"href":"https:\/\/www.aerian.fr\/en\/wp-json\/wp\/v2\/posts\/2785\/revisions"}],"predecessor-version":[{"id":2901,"href":"https:\/\/www.aerian.fr\/en\/wp-json\/wp\/v2\/posts\/2785\/revisions\/2901"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.aerian.fr\/en\/wp-json\/wp\/v2\/media\/2791"}],"wp:attachment":[{"href":"https:\/\/www.aerian.fr\/en\/wp-json\/wp\/v2\/media?parent=2785"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.aerian.fr\/en\/wp-json\/wp\/v2\/categories?post=2785"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.aerian.fr\/en\/wp-json\/wp\/v2\/tags?post=2785"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}