feat: add version file support for java .properties file format

Author: Elenterius

.github/workflows/test.yml

@@ -753,6 +753,125 @@ jobs:
           EXPECTED_VERSION: "6.5.0"
           EXPECTED_VERSION_PATH: "package.version"
 
+  test-properties:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v5
+        with:
+          path: "./"
+
+      - run: npm ci --prod
+      - run: npm run build
+
+      - run: "git config --global user.email 'changelog@github.com'"
+      - run: "git config --global user.name 'Awesome Github action'"
+      - run: "git add . && git commit --allow-empty -m 'feat: Added fake file so version will be bumped'"
+
+      - name: Generate changelog
+        id: changelog
+        uses: ./
+        env:
+          ENV: "dont-use-git"
+          EXPECTED_TAG: "v2.1.0"
+        with:
+          github-token: ${{ secrets.github_token }}
+          version-file: "test-file.properties"
+
+      - name: Generate changelog
+        id: changelog
+        uses: ./
+        env:
+          ENV: "dont-use-git"
+          EXPECTED_TAG: "v3.1.0"
+        with:
+          github-token: ${{ secrets.github_token }}
+          version-file: "test-file.properties"
+          version-path: "colon_version"
+
+      - name: Show file
+        run: |
+          echo "$(<test-file.properties)"
+
+      - name: Test output
+        run: node ./test-output.js
+        env:
+          FILES: "test-file.properties"
+          EXPECTED_VERSION: "2.1.0,3.1.0,#version = 0.4.2,!version = 0.4.3,# colon_version:0.4.4,! colon_version:0.4.5"
+
+  test-properties-new:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v5
+        with:
+          path: "./"
+
+      - run: npm ci --prod
+      - run: npm run build
+
+      - run: "git config --global user.email 'changelog@github.com'"
+      - run: "git config --global user.name 'Awesome Github action'"
+      - run: "git add . && git commit --allow-empty -m 'feat: Added fake file so version will be bumped'"
+
+      - name: Generate changelog
+        id: changelog
+        uses: ./
+        env:
+          ENV: "dont-use-git"
+          EXPECTED_TAG: "v0.1.0"
+        with:
+          github-token: ${{ secrets.github_token }}
+          version-file: "test-file-new.properties"
+
+      - name: Show file
+        run: |
+          echo "$(<test-file-new.properties)"
+
+      - name: Test output
+        run: node ./test-output.js
+        env:
+          FILES: "test-file-new.properties"
+          EXPECTED_VERSION: "0.1.0"
+
+  test-properties-empty:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v5
+        with:
+          path: "./"
+
+      - run: npm ci --prod
+      - run: npm run build
+
+      - run: "git config --global user.email 'changelog@github.com'"
+      - run: "git config --global user.name 'Awesome Github action'"
+      - run: "git add . && git commit --allow-empty -m 'feat: Added fake file so version will be bumped'"
+
+      - run: touch ./test-file-empty.properties
+
+      - name: Generate changelog
+        id: changelog
+        uses: ./
+        env:
+          ENV: "dont-use-git"
+          EXPECTED_TAG: "v6.5.0"
+        with:
+          github-token: ${{ secrets.github_token }}
+          version-file: "test-file-empty.properties"
+          fallback-version: "6.5.0"
+
+      - name: Show file
+        run: |
+          echo "$(<test-file-empty.properties)"
+
+      - name: Test output
+        run: node ./test-output.js
+        env:
+          FILES: "test-file-empty.properties"
+          EXPECTED_VERSION: "6.5.0"
+
   test-pre-commit:
     runs-on: ubuntu-latest
     steps:
@@ -844,7 +963,7 @@ jobs:
           EXPECTED_TAG: "v1.5.0"
         with:
           github-token: ${{ secrets.github_token }}
-          version-file: "test-file.json, test-file-2.json, test-file.toml, test-file.yaml"
+          version-file: "test-file.json, test-file-2.json, test-file.toml, test-file.yaml, test-file.properties"
 
       - name: Show files
         run: |
@@ -856,12 +975,14 @@ jobs:
           echo "$(<test-file.toml)\n\n"
           echo "Test yaml file"
           echo "$(<test-file.yaml)\n\n"
+          echo "Test properties file"
+          echo "$(<test-file.properties)\n\n"
 
       - name: Test output
         run: node ./test-output.js
         env:
-          FILES: "test-file.json, test-file-2.json, test-file.toml, test-file.yaml"
-          EXPECTED_VERSION: "1.5.0, 1.5.0, 1.5.0, 1.11.0"
+          FILES: "test-file.json, test-file-2.json, test-file.toml, test-file.yaml, test-file.properties"
+          EXPECTED_VERSION: "1.5.0, 1.5.0, 1.5.0, 1.11.0, 2.1.0"
 
   test-config-file-path:
     runs-on: ubuntu-latest

README.md

@@ -18,7 +18,7 @@ This action will bump version, tag commit and generate a changelog with conventi
 - **Optional** `input-file`: Read the changelog from this file. This will prepend the newly generated changelogs to the file's content.
 - **Optional** `output-file`: File to output the changelog to. Default `CHANGELOG.md`, when providing `'false'` no file will be generated / updated.
 - **Optional** `release-count`: Number of releases to preserve in changelog. Default `5`, use `0` to regenerate all. This input has no effect if `input-file` is used.
-- **Optional** `version-file`: The path to the file that contains the version to bump (supports comma-separated list of file paths). Default `./package.json`. Other supported formats are `mix.exs`, `.toml`, `.yml`, `.yaml`, and `.json`.
+- **Optional** `version-file`: The path to the file that contains the version to bump (supports comma-separated list of file paths). Default `./package.json`. Other supported formats are `mix.exs`, `.toml`, `.yml`, `.yaml`, `.json` and `.properties`.
 - **Optional** `version-path`: The place inside the version file to bump. Default `version`.
 - **Optional** `skip-git-pull`: Do not pull the repo before tagging. Ensure you full cloned the repo in the first place to get tags. Default `'false'`.
 - **Optional** `skip-on-empty`: Boolean to specify if you want to skip empty release (no-changelog generated). This case occurred when you push `chore` commit with `angular` for example. Default `'true'`.
@@ -146,7 +146,7 @@ Overwrite everything
     tag-prefix: 'v'
     output-file: 'MY_CUSTOM_CHANGELOG.md'
     release-count: '10'
-    version-file: './my_custom_version_file.json' // or .yml, .yaml, .toml, mix.exs
+    version-file: './my_custom_version_file.json' // or .yml, .yaml, .toml, mix.exs, .properties
     version-path: 'path.to.version'
     skip-on-empty: 'false'
     skip-version-file: 'false'

package-lock.json

@@ -3,6 +3,7 @@ const Git = require('./git')
 const Yaml = require('./yaml')
 const Toml = require('./toml')
 const Mix = require('./mix')
+const Properties = require('./properties')
 
 module.exports = (fileExtension, filePath) => {
   switch (fileExtension.toLowerCase()) {
@@ -22,6 +23,9 @@ module.exports = (fileExtension, filePath) => {
     case 'exs':
       return new Mix()
 
+    case 'properties':
+      return new Properties()
+
     default:
       throw new Error(`File extension "${fileExtension}" from file "${filePath}" is not supported`)
   }

src/version/index.js

@@ -0,0 +1,51 @@
+const BaseVersioning = require('./base')
+const bumpVersion = require('../helpers/bumpVersion')
+
+module.exports = class Properties extends BaseVersioning {
+
+  fileContent = null
+
+  #getProperty(content, key) {
+    const regex = new RegExp(`^\\s*${key}\\s*[:=]\\s*(.*)$`, "m")
+    const match = content.match(regex)
+    return match ? match[1].trim() : null
+  }
+
+  #setProperty(content, key, value) {
+    // https://regexr.com/8gtpa
+    const regex = new RegExp(`^(\\s*${key}\\s*)([:=])(.*)$`, "m")
+
+    if (regex.test(content)) {
+      return content.replace(regex, (_, _key, sep) => `${key.trim()}${sep.trim()}${value}`)
+    }
+    else {
+      if (content.length > 0 && !content.endsWith("\n")) {
+        return content + `\n${key}=${value}`
+      }
+      return content + `${key}=${value}`
+    }
+  }
+
+  /**
+   * Reads and parses .properties file
+   */
+  parseFile = () => {
+    this.fileContent = this.readFile()
+    this.oldVersion = this.#getProperty(this.fileContent, this.versionPath)
+  }
+
+  /**
+   * Bumps the version in .properties file
+   *
+   * @param {!string} releaseType - The type of release
+   * @return {*}
+   */
+  bump = async(releaseType) => {
+    this.newVersion = await bumpVersion(releaseType, this.oldVersion)
+
+    this.update(
+      this.#setProperty(this.fileContent, this.versionPath, this.newVersion)
+    )
+  }
+
+}

src/version/properties.js

@@ -0,0 +1,9 @@
+name=test file for version parsing/replacing
+
+#version = 0.4.2
+!version = 0.4.3
+version = 2.0.0
+
+# colon_version:0.4.4
+! colon_version:0.4.5
+colon_version:3.0.0

test-file.properties

@@ -45,6 +45,10 @@ FILES.split(',').map((file, index) => {
       parsedContent = fileContent
       break
 
+    case 'properties':
+      parsedContent = fileContent
+      break
+
     default:
       assert.fail(`File extension "${fileExtension}" is not supported!`)
   }
@@ -57,18 +61,24 @@ FILES.split(',').map((file, index) => {
 
   const expectedVersions = EXPECTED_VERSION.split(',')
   const expectedVersion = expectedVersions.length > 0
-    ? expectedVersions[index]
+    ? expectedVersions[index].trim()
     : expectedVersions
 
   if (fileExtension.toLowerCase() === 'exs') {
     assert.strictEqual(parsedContent.includes(expectedVersion), true, 'Version does not match what is expected')
     return
   }
 
+  if (fileExtension.toLowerCase() === 'properties') {
+    console.log(`"${file}" check if version matches what is expected "${expectedVersion}"`)
+    assert.strictEqual(parsedContent.includes(expectedVersion), true, 'Version does not match what is expected')
+    return
+  }
+
   const newVersionInFile = objectPath.get(parsedContent, EXPECTED_VERSION_PATH, null)
 
-  console.log(`"${file}" check if "${newVersionInFile}" matches what is expected "${expectedVersion.trim()}"`)
+  console.log(`"${file}" check if "${newVersionInFile}" matches what is expected "${expectedVersion}"`)
 
-  assert.strictEqual(newVersionInFile, expectedVersion.trim(), 'Version does not match what is expected')
+  assert.strictEqual(newVersionInFile, expectedVersion, 'Version does not match what is expected')
 })