Rename the getChangelog CLI option from --version=.. to `--projec…

…t-version=..` #188

.github/workflows/build.yml

@@ -1,17 +1,20 @@
 name: Build
 on:
-  # Trigger the workflow on pushes to only the 'main' branch (this avoids duplicate checks being run e.g. for dependabot pull requests)
+  # Trigger the workflow on pushes to only the 'main' branch (this avoids duplicate checks being run, e.g. for dependabot pull requests)
   push:
-    branches: [main]
-    paths-ignore: ['**.md']
+    branches: [ main ]
+    paths-ignore: [ '**.md' ]
   pull_request:
-    paths-ignore: ['**.md']
+    paths-ignore: [ '**.md' ]
 
+
+# This allows a subsequently queued workflow run to interrupt previous runs
 concurrency:
   group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
   cancel-in-progress: true
 
 jobs:
+
   gradleValidation:
     name: Gradle Wrapper
     runs-on: ubuntu-latest
@@ -32,8 +35,9 @@ jobs:
       - name: Fetch Sources
         uses: actions/checkout@v3
 
-#      - name: Qodana - Code Inspection
-#        uses: JetBrains/[email protected]
+      - name: Qodana - Code Inspection
+        uses: JetBrains/[email protected]
+
 
   test:
     name: Gradle ${{ matrix.gradleVersion }} @ ${{ matrix.os }}
@@ -45,8 +49,8 @@ jobs:
         gradleVersion:
           - 6.8
           - 6.9.2
-          - 7.6.1
-          - 8.1.1
+          - 7.6.2
+          - 8.3
         os:
           - windows-latest
           - ubuntu-latest
@@ -75,6 +79,8 @@ jobs:
 
       - name: Setup Gradle
         uses: gradle/gradle-build-action@v2
+        with:
+          gradle-home-cache-cleanup: true
 
       - name: Run Linters and Test
         run: ./gradlew check -PtestGradleVersion="${{ matrix.gradleVersion }}"
@@ -109,7 +115,10 @@ jobs:
 
       - name: Setup Gradle
         uses: gradle/gradle-build-action@v2
+        with:
+          gradle-home-cache-cleanup: true
 
+      # Set environment variables
       - name: Export Properties
         id: properties
         shell: bash
@@ -151,7 +160,7 @@ jobs:
       - name: Fetch Sources
         uses: actions/checkout@v3
 
-      # Remove old release drafts by using the curl request for the available releases with draft flag
+      # Remove old release drafts by using the curl request for the available releases with a draft flag
       - name: Remove Old Release Drafts
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -160,7 +169,7 @@ jobs:
             --jq '.[] | select(.draft == true) | .id' \
             | xargs -I '{}' gh api -X DELETE repos/{owner}/{repo}/releases/{}
 
-      # Create new release draft - which is not publicly visible and requires manual acceptance
+      # Create a new release draft which is not publicly visible and requires manual acceptance
       - name: Create Release Draft
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -26,6 +26,8 @@ jobs:
 
       - name: Setup Gradle
         uses: gradle/gradle-build-action@v2
+        with:
+          gradle-home-cache-cleanup: true
 
       # Set environment variables
       - name: Export Properties

CHANGELOG.md

@@ -2,13 +2,16 @@
 
 ## [Unreleased]
 
+### Changed
+- Rename the `getChangelog` CLI option from `--version=..` to `--project-version=..` [#188](../../issues/188)
+
 ## [2.1.2] - 2023-07-10
 
 ### Fixed
-- Changelog render is inconsistent between different line separators [#182](../../issues/182)
+- Changelog render is inconsistent between different line separators [#182](../../issues/182)
 
 ### Changed
-- Use `GITHUB_OUTPUT` environment file instead of deprecated `::set-output` command in GitHub Actions
+- Use `GITHUB_OUTPUT` environment file instead of deprecated `::set-output` command in GitHub Actions
 - Deprecate `itemPrefix` and `lineSeparator` properties in the `org.jetbrains.changelog.Changelog.Item` constructor [#181](../../issues/181)
 
 ## [2.1.1] - 2023-07-07