.cz-config.js

-module.exports = {
-  types: [
-    { value: 'PATCH', name: 'PATCH:     Small addition to or revision of the TR\'s Markdown files' },
-    { value: 'MINOR', name: 'MINOR:     Medium addition to or revision of the TR\'s Markdown files' },
-    { value: 'MAJOR', name: 'MAJOR:     Huge contribution to or revision of the TR\'s Markdown files' },
-    { value: 'feat', name: 'feat:     A new feature' },
-    { value: 'fix', name: 'fix:      A bug fix' },
-    { value: 'docs', name: 'docs:     General documentation-only changes' },
-    {
-      value: 'style',
-      name:
-        'style:    Changes that do not affect the meaning of the code\n            (white-space, formatting, missing semicolons, etc)',
-    },
-    { value: 'test', name: 'test:     Adding missing tests' },
-    {
-      value: 'build',
-      name:
-        'build:    Changes that affect the build system or dependencies\n            (example scopes: npm, docker, pip, ant)',
-    },
-    {
-      value: 'ci',
-      name:
-        'ci:       Changes to the CI configuration\n            (example scopes: gitlab, travis)',
-    },
-    {
-      value: 'chore',
-      name:
-        'chore:    Other changes that modify files other than source or test files'
-    },
-    { value: 'revert', name: 'revert:   Revert to a commit' },
-  ],
-
-  // it needs to match the value for field type. Eg.: 'fix'
-  /*
-  scopeOverrides: {
-    fix: [
-
-      {name: 'merge'},
-      {name: 'style'},
-      {name: 'e2eTest'},
-      {name: 'unitTest'}
-    ]
-  },
-  */
-  // override the messages, defaults are as follows
-  messages: {
-    type: "Select the type of change that you're committing:",
-    scope: '\nDenote the SCOPE of this change (optional):',
-    // used if allowCustomScopes is true
-    customScope: 'Denote the SCOPE of this change:',
-    subject: 'Write a SHORT, IMPERATIVE mood description of the change:\n',
-    body: 'Provide a LONGER description of the change (optional). Use "|" to break new line:\n',
-    breaking: 'List any BREAKING CHANGES (optional):\n',
-    footer: 'Reference ISSUES touched by this change (optional). E.g.: closes #31, see #34:\n',
-    confirmCommit: 'Are you sure you want to proceed with the commit above?',
-  },
-
-  allowCustomScopes: true,
-  allowBreakingChanges: ['feat', 'fix'],
-  // skip any questions you want
-  skipQuestions: ['body'],
-
-  // limit subject length
-  subjectLimit: 100,
-  // breaklineChar: '|', // It is supported for fields body and footer.
-  footerPrefix : ''
-  // askForBreakingChangeFirst : true, // default is false
-};

.gitlab-ci.yml

@@ -12,19 +12,19 @@ create_overall_md:
   stage: build
   image: alpine:3.7
   script:
-    - cat technical-reference-main.txt | while read LINE; do cat $LINE >> rdd-technical-reference.md ; done
+    - cat technical-reference-main.txt | while read LINE; do cat $LINE >> technical-reference.md ; done
   artifacts:
     expose_as: 'full markdown document'
     paths:
-      - rdd-technical-reference.md
+      - technical-reference.md
 
 tests:
   stage: test
   image: node:10
   before_script:
-    - npm install
+    - npm ci
   script:
-    - npx markdownlint -o markdownlint-report.txt rdd-technical-reference.md
+    - npx markdownlint -o markdownlint-report.txt technical-reference.md
   allow_failure: true
   artifacts:
     expose_as: 'markdownlint report'
@@ -40,9 +40,19 @@ create_pdf:
   before_script:
     - pandoc --version
   script:
-    - pandoc --template=rdd.latex rdd-technical-reference.md -o rdd-technical-reference.pdf
+    - pandoc --template=rdd.latex technical-reference.md -o technical-reference.pdf
   artifacts:
     paths:
-      - rdd-technical-reference.pdf
+      - technical-reference.pdf
+  only:
+    - master
+
+release:
+  stage: release
+  image: node:10
+  before_script:
+    - npm ci
+  script:
+    - npx semantic-release
   only:
     - master

CHANGELOG.md

+# 1.0.0 (2020-06-22)
+
+
+### Features
+
+* **commitizen:** provide a customized commitizen adapter configuration ([b2645c6](https://gitlab.gwdg.de/fe/technical-reference/commit/b2645c6474eb12f4130f80d2336a3daced7e9895)), closes [#20](https://gitlab.gwdg.de/fe/technical-reference/issues/20)
+* add first draft for new document structure ([d2acdbf](https://gitlab.gwdg.de/fe/technical-reference/commit/d2acdbf1f4457a672256ea2d7d8bfa91f26f7c87)), closes [#27](https://gitlab.gwdg.de/fe/technical-reference/issues/27)
+* make the repo commitizen friendly ([fcb002c](https://gitlab.gwdg.de/fe/technical-reference/commit/fcb002c92a52a21958d07c775055b2d2a9aac09a)), closes [#20](https://gitlab.gwdg.de/fe/technical-reference/issues/20)

README.md

@@ -8,14 +8,14 @@ To compile in markdown, use
 pandoc --template=rdd.latex rdd-technical-reference.md -o rdd-technical-reference.pdf
 ```
 
-Originally based on the [EURISE Network Technical Reference](https://github.com/eurise-network/technical-reference).
+Inspired by the [EURISE Network Technical Reference](https://github.com/eurise-network/technical-reference).
 
 ## Contributing
 
 Commits have to be made following a certain convention that is defined by the
 [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) standard.
-This repo is designed to be used with [Commitizen](https://github.com/commitizen/cz-cli) for which we provide a
-configuration in `package.json`.
+This repo is configured to be used with [Commitizen](https://github.com/commitizen/cz-cli) for your convenience
+and uses the [angular preset](https://github.com/conventional-changelog/conventional-changelog).
 
 Install it with
 
@@ -33,9 +33,11 @@ following code:
 exec < /dev/tty && node_modules/.bin/git-cz --hook || true
 ```
 
-We have configured three types of commits for the work on the technical reference that should reflect the extent of your
-contribution:
+We have chosen the following two types of commits to be used for the work on the technical reference
+that should reflect the extent of your contribution:
 
-- PATCH:     Small addition to or revision of the Technical Reference's Markdown files.
-- MINOR:     Medium addition to or revision of the Technical Reference's Markdown files.
-- MAJOR:     Huge contribution to or revision of the Technical Reference's Markdown files.
+- `fix`: Small addition to or revision of the Technical Reference's Markdown files.
+- `feat`: Medium addition to or revision of the Technical Reference's Markdown files.
+
+These commit types trigger a `patch` or `minor` release when merged into the `master` branch.
+To trigger a `major` release, please consult your fellow contributors and mark one of your commits with a `BREAKING CHANGE`.

package.json

@@ -8,13 +8,57 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "markdownlint-cli": "^0.23.1",
+    "@semantic-release/changelog": "^5.0.1",
+    "@semantic-release/git": "^9.0.0",
+    "@semantic-release/gitlab-config": "^8.0.0",
     "commitizen": "^4.1.2",
-    "cz-customizable": "^6.2.0"
+    "cz-conventional-changelog": "^3.2.0",
+    "markdownlint-cli": "^0.23.1",
+    "semantic-release": "^17.0.8"
   },
   "config": {
     "commitizen": {
-      "path": "./node_modules/cz-customizable"
+      "path": "./node_modules/cz-conventional-changelog"
     }
+  },
+  "release": {
+    "plugins": [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      [
+        "@semantic-release/changelog",
+        {
+          "changelogFile": "CHANGELOG.md"
+        }
+      ],
+      [
+        "@semantic-release/gitlab",
+        {
+          "gitlabUrl": "https://gitlab.gwdg.de",
+          "assets": [
+            {
+              "path": "technical-reference.pdf",
+              "label": "Technical Reference (PDF)"
+            },
+            {
+              "path": "technical-reference.md",
+              "label": "Technical Reference (MD)"
+            },
+            {
+              "path": "CHANGELOG.md",
+              "label": "Changelog"
+            }
+          ]
+        }
+      ],
+      [
+        "@semantic-release/git",
+        {
+          "assets": [
+            "CHANGELOG.md"
+          ]
+        }
+      ]
+    ]
   }
 }