Update changelog template and introduce codeowners to notify when a P…

…R is created (#141)
bakdata · Sep 21, 2023 · 825cfce · 825cfce
1 parent f35abcd
commit 825cfce
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 45 deletions.
diff --git a/.github/changelog-config.json b/.github/changelog-config.json
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -0,0 +1 @@
+* @yannick-roeder @MichaelKora @yordanovsstoyan
diff --git a/actions/changelog-generate/README.md b/actions/changelog-generate/README.md
@@ -34,28 +34,11 @@ files. A simple configuration may look like this:
 
 ```json
 {
-  "categories": [
-    {
-      "title": "## 🚀 Features",
-      "labels": ["feature", "feat", "enhancement"]
-    },
-    { 
-      "title": "## 🐛 Fixes",
-      "labels": ["fix", "bug"] 
-    },
-    { 
-      "title": "## 🧪 Dependencies",
-      "labels": ["dependency"] 
-    },
-    { 
-      "title": "## 📦 Uncategorized",
-      "labels": [] 
-    }
-  ],
+  "categories": [{ "title": "### Merged pull requests:" }],
   "ignore_labels": ["ignore"],
   "sort": { "order": "ASC", "on_property": "mergedAt" },
-  "template": "# [${{TO_TAG}}](https://github.com/<myorganization>/<myrepository>/releases/tag/${{TO_TAG}}) - Release Date: ${{TO_TAG_DATE}}\n\n${{CHANGELOG}}",
-  "pr_template": "- ${{TITLE}}\n   - PR: ${{URL}}\n   - Assignees: ${{ASSIGNEES}}\n   - Reviewers: ${{REVIEWERS}}\n   - Approvers: ${{APPROVERS}}",
+  "template": "# [#{{TO_TAG}}](https://github.com/#{{OWNER}}/#{{REPO}}/releases/tag/#{{TO_TAG}}) - Release Date: #{{TO_TAG_DATE}}\n\n#{{CHANGELOG}}",
+  "pr_template": "- #{{TITLE}} [##{{NUMBER}}](#{{URL}}) ([@#{{AUTHOR}}](https://github.com/#{{AUTHOR}}))\n",
   "empty_template": "- no changes!"
 }
 ```
@@ -70,16 +53,16 @@ Additional configuration options can be explored
 
 ## Input Parameters
 
-| Name                      | Required |           Default Value           | Description                                                                                                                                                  |
-| ------------------------- | :------: | :-------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| github-token              |    ✅    |                 -                 | The GitHub token for committing the changes                                                                                                                  |
-| new-tag                   |    ✅    |                 -                 | Defines until which tag the changelog will consider merged pull requests (can be a tag or a valid git ref)                                                   |
-| changelog-file            |    ❌    |          "CHANGELOG.md"           | Path to the Changelog.md file                                                                                                                                |
-| commit-mode               |    ❌    |              "false"              | Special configuration for projects which work without PRs. Uses commit messages as changelog. This mode looses access to information only available for PRs. |
-| config                    |    ❌    | "./.github/changelog-config.json" | Path to the changelog config JSON file                                                                                                                       |
-| fetch-release-information |    ❌    |              "false"              | Will enable fetching additional release information from tags.                                                                                               |
-| fetch-reviewers           |    ❌    |              "false"              | Will enable fetching the users/reviewers who approved the PR.                                                                                                |
-| old-tag                   |    ❌    |                ""                 | Defines the 'start' from where the changelog will consider merged pull requests (can be a tag or a valid git ref)                                            |
+| Name                      | Required |                Default Value                | Description                                                                                                                                                  |
+| ------------------------- | :------: | :-----------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| github-token              |    ✅    |                      -                      | The GitHub token for committing the changes                                                                                                                  |
+| new-tag                   |    ✅    |                      -                      | Defines until which tag the changelog will consider merged pull requests (can be a tag or a valid git ref)                                                   |
+| changelog-file            |    ❌    |               "CHANGELOG.md"                | Path to the Changelog.md file                                                                                                                                |
+| commit-mode               |    ❌    |                   "false"                   | Special configuration for projects which work without PRs. Uses commit messages as changelog. This mode looses access to information only available for PRs. |
+| config                    |    ❌    | "$GITHUB_ACTION_PATH/changelog-config.json" | Path to the changelog config JSON file                                                                                                                       |
+| fetch-release-information |    ❌    |                   "false"                   | Will enable fetching additional release information from tags.                                                                                               |
+| fetch-reviewers           |    ❌    |                   "false"                   | Will enable fetching the users/reviewers who approved the PR.                                                                                                |
+| old-tag                   |    ❌    |                     ""                      | Defines the 'start' from where the changelog will consider merged pull requests (can be a tag or a valid git ref)                                            |
 
 ## Outputs
 
@@ -106,7 +89,6 @@ steps:
     uses: bakdata/ci-templates/actions/changelog-generate@main
     with:
       github-token: ${{ secrets.GH_TOKEN }}
-      config: "./.github/changelog-config.json"
       new-tag: "1.0.0"
       changelog-file: "CHANGELOG.md"
       fetch-reviewers: "true"

diff --git a/actions/changelog-generate/action.yaml b/actions/changelog-generate/action.yaml
@@ -21,7 +21,7 @@ inputs:
   config:
     description: Path to the changelog config JSON file
     required: false
-    default: "./.github/changelog-config.json"
+    default: "$GITHUB_ACTION_PATH/changelog-config.json"
   fetch-release-information:
     description: "Will enable fetching additional release information from tags."
     required: false
@@ -43,6 +43,7 @@ outputs:
     value: ${{ steps.output-generator.outputs.single-changelog }}
 runs:
   using: "composite"
+
   steps:
     - name: "Set tags"
       id: set-tags
@@ -73,14 +74,16 @@ runs:
           fi
         fi
         echo  "fromtag=$setfrom">> $GITHUB_OUTPUT
+        # when using inputs.config directly it does not work and remapping it makes it  work
+        echo "path=${{ inputs.config }}" >> "$GITHUB_OUTPUT"
       shell: bash
 
     - name: "Create changelog"
       id: build_changelog
       uses: mikepenz/release-changelog-builder-action@v4
       with:
         token: "${{ inputs.github-token }}"
-        configuration: "${{ inputs.config }}"
+        configuration: "${{ steps.set-tags.outputs.path }}"
         fromTag: "${{ steps.set-tags.outputs.fromtag }}"
         toTag: "${{ steps.set-tags.outputs.totag }}"
         outputFile: ${{ runner.temp }}/changes.md
@@ -111,7 +114,7 @@ runs:
         # Create changelog.md in case of a first Release
         if [ -n "${{ inputs.changelog-file }}" ]; then
           sed -i 's/# /## /g' ${{ runner.temp }}/changes.md
-          echo -e "\n" >> ${{ runner.temp }}/changes.md 
+          echo -e "\n" >> ${{ runner.temp }}/changes.md
           if [ ! -f "${{ inputs.changelog-file }}" ]; then
             echo $'# Changelog\n' >> ${{ inputs.changelog-file }}
           fi

diff --git a/actions/changelog-generate/changelog-config.json b/actions/changelog-generate/changelog-config.json
@@ -0,0 +1,8 @@
+{
+  "categories": [{ "title": "### Merged pull requests:" }],
+  "ignore_labels": ["ignore"],
+  "sort": { "order": "ASC", "on_property": "mergedAt" },
+  "template": "# [#{{TO_TAG}}](https://github.com/#{{OWNER}}/#{{REPO}}/releases/tag/#{{TO_TAG}}) - Release Date: #{{TO_TAG_DATE}}\n\n#{{CHANGELOG}}",
+  "pr_template": "- #{{TITLE}} [##{{NUMBER}}](#{{URL}}) ([@#{{AUTHOR}}](https://github.com/#{{AUTHOR}}))\n",
+  "empty_template": "- no changes!"
+}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		* @yannick-roeder @MichaelKora @yordanovsstoyan