merge upstream

.github/pull_request_template.md

@@ -19,7 +19,7 @@ feat(scope): change to scope
 ```
 
 ```
-More details bout the change.
+More details about the change.
 
 BREAKING CHANGE:
 Refs: #{issue}

.github/workflows/style.yml

@@ -5,10 +5,10 @@ on:
     branches:
       # Push will only build on branches that match this name
       # Pull requests will override this, so pushes to pull requests will still build
-      - tescovalue
+      - master
   pull_request:
     branches:
-      - main
+      - master
 
 jobs:
   check-style:
@@ -17,10 +17,10 @@ jobs:
 
     steps:
     - uses: actions/checkout@v1
-    - name: Set up Python 3.8
+    - name: Set up Python 3.9
       uses: actions/setup-python@v1
       with:
-        python-version: 3.8
+        python-version: 3.9
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip poetry

.github/workflows/tests.yml

@@ -5,7 +5,7 @@ on:
     branches:
       # Push will only build on branches that match this name
       # Pull requests will override this, so pushes to pull requests will still build
-      - tescovalue
+      - master
   pull_request:
     branches:
       - master
@@ -38,7 +38,7 @@ jobs:
         flags: unittests
         name: codecov-umbrella
         yml: ./codecov.yml
-        fail_ci_if_error: true
+        fail_ci_if_error: false
 
   test-python-versions:
 

README.md

@@ -130,6 +130,21 @@ release = true
 allow_dirty = false
 ```
 
+Example `pyproject.toml`:
+
+```tonl
+[tool.changelog_gen]
+commit = true
+release = true
+allow_dirty = false
+
+[changelog_gen.post_process]
+  url = https://your-domain.atlassian.net/rest/api/2/issue/ISSUE-::issue_ref::/comment
+  verb = POST
+  body = {"body": "Released on v::version::"}
+  auth_env = JIRA_AUTH
+```
+
 ### Configuration file -- Global configuration
 
 General configuration is grouped in a `[changelog_gen]` section.
@@ -171,7 +186,7 @@ General configuration is grouped in a `[changelog_gen]` section.
   **default**: None
 
   Create links in the CHANGELOG to the originating issue. A url that contains
-  an `$ISSUE_REF` placeholder for replacement.
+  an `issue_ref` placeholder for replacement.
 
   Example:
 
@@ -395,8 +410,7 @@ url = https://your-domain.atlassian.net/rest/api/2/issue/ISSUE-::issue_ref::/com
 verb = "POST"
 body = '{"body": "Released on ::version::"}'
 auth_env = "JIRA_AUTH"
-[tool.changelog_gen.post_process.headers]
-content-type = "application/json"
+headers."content-type" = "application/json"
 ```
   This assumes an environment variable `JIRA_AUTH` with the content `[email protected]:{api_key}`.
   See

changelog_gen/version.py

@@ -24,7 +24,7 @@ def get_version_info(cls: type[T], semver: str) -> dict[str, str]:
             msg = "Unable to get version data from bumpversion."
             raise errors.VersionDetectionError(msg) from e
 
-        bumpversion_data = {v.split("=")[0]: v.split("=")[1] for v in describe_out}
+        bumpversion_data = {v.split("=")[0].strip(): v.split("=")[1].strip() for v in describe_out}
 
         return {
             "current": bumpversion_data["current_version"],