feat: add example .releaserc.yaml to README

voxpupuli · Sep 24, 2024 · d4cd771 · d4cd771
1 parent f90c029
commit d4cd771
Showing 1 changed file with 70 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -10,6 +10,76 @@ This container can be used to create project releases. It encapsulates [semantic
 
 ## Usage
 
+### Example `.releaserc.yaml` for a Gitlab project
+
+```yaml
+---
+branches:
+ - 'main'
+ - 'master'
+ - 'production'
+
+ci: true
+debug: true
+dryRun: false
+tagFormat: '${version}'
+preset: 'conventionalcommits'
+
+gitlabUrl: 'https://gitlab.example.com'
+gitlabApiPathPrefix: '/api/v4'
+
+plugins:
+  - path: '@semantic-release/commit-analyzer'
+    releaseRules:
+      - { breaking: true, release: major }
+      - { type: build,    release: patch }
+      - { type: chore,    release: false }
+      - { type: ci,       release: false }
+      - { type: dep,      release: patch }
+      - { type: docs,     release: patch }
+      - { type: feat,     release: minor }
+      - { type: fix,      release: patch }
+      - { type: perf,     release: patch }
+      - { type: refactor, release: false }
+      - { type: revert,   release: patch }
+      - { type: test,     release: false }
+
+  - path: '@semantic-release/release-notes-generator'
+    writerOpts:
+      groupBy: 'type'
+      commitGroupsSort: 'title'
+      commitsSort: 'header'
+    linkCompare: true
+    linkReferences: true
+    parserOpts:
+      # detect JIRA issues in merge commits
+      issuePrefixes: ['SUP', 'BUG', 'FEATURE']
+      mergePattern: "^Merge branch '(.*)' into (.*)$"
+      mergeCorrespondence: ['branch_src', 'branch_dst']
+      noteKeywords: ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING"]
+    presetConfig:
+      issueUrlFormat: "https://jira.example.com/browse/{{prefix}}{{id}}"
+      types:
+        - { type: 'build',    section: '👷 Build' }
+        - { type: 'chore',    section: '🧹 Chorses' }
+        - { type: 'ci',       section: '🚦 CI/CD' }
+        - { type: 'dep',      section: '👾 Dependencies' }
+        - { type: 'docs',     section: '📚 Docs' }
+        - { type: 'feat',     section: '🚀 Features' }
+        - { type: 'fix',      section: '🛠️ Fixes' }
+        - { type: 'perf',     section: '⏩ Performance' }
+        - { type: 'refactor', section: '🔨 Refactor' }
+        - { type: 'revert',   section: '🙅‍♂️ Reverts' }
+        - { type: 'test',     section: '🚥 Tests' }
+
+  - path: '@semantic-release/changelog'
+  - path: '@semantic-release/git'
+
+verifyConditions:
+  - '@semantic-release/changelog'
+  - '@semantic-release/git'
+```
+
 ### Gitlab
 
 This is a example to use this container in Gitlab.