Tag filter support (#11)

.gitignore

@@ -1,2 +1,3 @@
 node_modules
 lib
+test-files/*/actual-results

.vscode/launch.json

@@ -0,0 +1,20 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Run tests",
+            "program": "${workspaceFolder}/node_modules/ava/entrypoints/cli.mjs",
+            "args": [
+                "--serial",
+                "lib/test.js"
+            ],
+            "outputCapture": "std",
+            "console": "integratedTerminal",
+            "skipFiles": [
+                "<node_internals>/**/*.js"
+            ]
+        }
+    ]
+}

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 vers-one
+Copyright (c) 2022-2024 vers-one
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -84,6 +84,67 @@ Examples:
 |1.1        |`*.*.*.*`      |1.1.0.0    |Sets the missing build and revision parts to zero, leaves the major and the minor parts unchanged                |
 |1.1        |`?.?.?.?`      |1.1        |Leaves all parts unchanged                                                                                       |
 
+### `tags` (optional)
+
+Comma-separated list of version tags to process.
+
+Allows to refine the `file` / `files` filter to exclude the unwanted version declarations found in the matching files. The values in the list are not case-sensitive, extra spaces between the values are trimmed.
+
+**Default**: `*`
+
+Supported tags:
+
+|Tag                                   |Description                                                                   |
+|--------------------------------------|------------------------------------------------------------------------------|
+|`*`                                   |Process all supported version declarations in all supported file types        |
+|`csproj.*`                            |Process all supported version declarations in *.csproj* files                 |
+|`csproj.Version`                      |Process `<Version>...</Version>` item in *.csproj* files                      |
+|`csproj.VersionPrefix`                |Process `<VersionPrefix>...</VersionPrefix>` item in *.csproj* files          |
+|`csproj.AssemblyVersion`              |Process `<AssemblyVersion>...</AssemblyVersion>` item in *.csproj* files      |
+|`csproj.FileVersion`                  |Process `<FileVersion>...</FileVersion>` item in *.csproj* files              |
+|`vbproj.*`                            |Process all supported version declarations in *.vbproj* files                 |
+|`vbproj.Version`                      |Process `<Version>...</Version>` item in *.vbproj* files                      |
+|`vbproj.VersionPrefix`                |Process `<VersionPrefix>...</VersionPrefix>` item in *.vbproj* files          |
+|`vbproj.AssemblyVersion`              |Process `<AssemblyVersion>...</AssemblyVersion>` item in *.vbproj* files      |
+|`vbproj.FileVersion`                  |Process `<FileVersion>...</FileVersion>` item in *.vbproj* files              |
+|`fsproj.*`                            |Process all supported version declarations in *.fsproj* files                 |
+|`fsproj.Version`                      |Process `<Version>...</Version>` item in *.fsproj* files                      |
+|`fsproj.VersionPrefix`                |Process `<VersionPrefix>...</VersionPrefix>` item in *.fsproj* files          |
+|`fsproj.AssemblyVersion`              |Process `<AssemblyVersion>...</AssemblyVersion>` item in *.fsproj* files      |
+|`fsproj.FileVersion`                  |Process `<FileVersion>...</FileVersion>` item in *.fsproj* files              |
+|`props.*`                             |Process all supported version declarations in *.props* files                  |
+|`props.Version`                       |Process `<Version>...</Version>` item in *.props* files                       |
+|`props.VersionPrefix`                 |Process `<VersionPrefix>...</VersionPrefix>` item in *.props* files           |
+|`props.AssemblyVersion`               |Process `<AssemblyVersion>...</AssemblyVersion>` item in *.props* files       |
+|`props.FileVersion`                   |Process `<FileVersion>...</FileVersion>` item in *.props* files               |
+|`nuspec.*`                            |Process all supported version declarations in *.nuspec* files                 |
+|`nuspec.Version`                      |Process `<Version>...</Version>` item in *.nuspec* files                      |
+|`AssemblyInfo-cs.*`                   |Process all supported version declarations in *.cs* files                     |
+|`AssemblyInfo-cs.AssemblyVersion`     |Process `[assembly: AssemblyVersion("...")]` item in *.cs* files              |
+|`AssemblyInfo-cs.AssemblyFileVersion` |Process `[assembly: AssemblyFileVersion("...")]` item in *.cs* files          |
+|`AssemblyInfo-vb.*`                   |Process all supported version declarations in *.vb* files                     |
+|`AssemblyInfo-vb.AssemblyVersion`     |Process `<Assembly: AssemblyVersion("...")>` item in *.vb* files              |
+|`AssemblyInfo-vb.AssemblyFileVersion` |Process `<Assembly: AssemblyFileVersion("...")>` item in *.vb* files          |
+|`AssemblyInfo-fs.*`                   |Process all supported version declarations in *.fs* files                     |
+|`AssemblyInfo-fs.AssemblyVersion`     |Process `[<assembly: AssemblyVersion("...")>]` item in *.fs* files            |
+|`AssemblyInfo-fs.AssemblyFileVersion` |Process `[<assembly: AssemblyFileVersion("...")>]` item in *.fs* files        |
+|`AssemblyInfo-cpp.*`                  |Process all supported version declarations in *.cpp* files                    |
+|`AssemblyInfo-cpp.AssemblyVersion`    |Process `[assembly:AssemblyVersionAttribute(L"...")]` item in *.cpp* files    |
+|`AssemblyInfo-cpp.AssemblyFileVersion`|Process `[assembly:AssemblyFileVersionAttribute(L"...")]` item in *.cpp* files|
+|`rc.*`                                |Process all supported version declarations in *.rc* files                     |
+|`rc.FileVersion-param`                |Process `FILEVERSION x,x,x,x` item in *.rc* files                             |
+|`rc.ProductVersion-param`             |Process `PRODUCTVERSION x,x,x,x` item in *.rc* files                          |
+|`rc.FileVersion-string`               |Process `VALUE "FileVersion", "..."` item in *.rc* files                      |
+|`rc.ProductVersion-string`            |Process `VALUE "ProductVersion", "..."` item in *.rc* files                   |
+
+Examples:
+
+|`tags` input                                               |Explanation                                                                                                                                                                                                   |
+|-----------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+|`AssemblyInfo-cs.AssemblyVersion`                          |Process only *.cs* files and only `[assembly: AssemblyVersion("...")]` items in those files                                                                                                                   |
+|`csproj.Version, csproj.AssemblyVersion`                   |Process only *.csproj* files and only `<Version>...</Version>` and `<AssemblyVersion>...</AssemblyVersion>` items in those files                                                                              |
+|`csproj.Version, AssemblyInfo-cs.AssemblyVersion, nuspec.*`|Process only `<Version>...</Version>` items in *.csproj* files, `[assembly: AssemblyVersion("...")]` items in *.cs* files, and all supported version declarations in `.nuspec` files, and skip everything else|
+
 ## Outputs
 
 ### `oldVersion`
@@ -123,7 +184,7 @@ jobs:
 
       - name: Set MyProject.csproj version
         id: update
-        uses: vers-one/dotnet-project-version-updater@v1.5
+        uses: vers-one/dotnet-project-version-updater@v1.6
         with:
           file: "src/MyProject.csproj"
           version: ${{ github.event.inputs.version }}
@@ -159,7 +220,7 @@ jobs:
 
       - name: Set project versions
         id: update
-        uses: vers-one/dotnet-project-version-updater@v1.5
+        uses: vers-one/dotnet-project-version-updater@v1.6
         with:
           file: |
             "**/*.csproj", "**/*.nuspec", "**/AssemblyInfo.cs"
@@ -203,7 +264,7 @@ jobs:
 
       - name: Bump build version
         id: bump
-        uses: vers-one/dotnet-project-version-updater@v1.5
+        uses: vers-one/dotnet-project-version-updater@v1.6
         with:
           file: "src/MyProject.csproj"
           version: bump-build
@@ -218,31 +279,6 @@ jobs:
 
 ## Additional notes
 
-* This action searches for the following version declarations:
-  * for .csproj, .vbproj, .fsproj, and .props files:
-    * `<Version>...</Version>`;
-    * `<VersionPrefix>...</VersionPrefix>`;
-    * `<AssemblyVersion>...</AssemblyVersion>`;
-    * `<FileVersion>...</FileVersion>`;
-  * for .nuspec files:
-    * `<Version>...</Version>`;
-  * for .cs files:
-    * `[assembly: AssemblyVersion("...")]`;
-    * `[assembly: AssemblyFileVersion("...")]`;
-  * for .vb files:
-    * `<Assembly: AssemblyVersion("...")>`;
-    * `<Assembly: AssemblyFileVersion("...")>`;
-  * for .fs files:
-    * `[<assembly: AssemblyVersion("...")>]`;
-    * `[<assembly: AssemblyFileVersion("...")>]`;
-  * for .cpp files:
-    * `[assembly:AssemblyVersionAttribute(L"...")]`;
-    * `[assembly:AssemblyFileVersionAttribute(L"...")]`;
-  * for .rc files:
-    * `FILEVERSION x,x,x,x`;
-    * `PRODUCTVERSION x,x,x,x`;
-    * `VALUE "FileVersion", "..."`
-    * `VALUE "ProductVersion", "..."`.
-* If you set the new version explicitly, you can use any string as a version number (e.g. `1.2.3`, `1.0.0-beta5`, `Vista`, `blah-blah`, etc). However if you use one of the bump commands or a bump pattern, the existing version must by in the following format: *major[.minor[.build[.revision]]]*.
+* If you set the new version explicitly, you can use any string as a version number (e.g. `1.2.3`, `1.0.0-beta5`, `Vista`, `blah-blah`, etc). However, if you use one of the bump commands or a bump pattern, the existing version must by in the following format: *major[.minor[.build[.revision]]]*.
 * Keep in mind that .NET Framework assembly versions [must be](https://docs.microsoft.com/en-us/dotnet/api/system.version#remarks) in the following format: *major.minor[.build[.revision]]*. Any other versions formats like `1.0.0-beta5` will cause a compilation failure.
 * C++ resource files [require](https://learn.microsoft.com/en-us/windows/win32/menurc/versioninfo-resource#parameters) `FILEVERSION` and `PRODUCTVERSION` resource parameters to have all four version components (*major.minor.build.revision*).

package.json

@@ -1,6 +1,6 @@
 {
   "name": "dotnet-project-version-updater",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "A GitHub action to update or bump project versions. Supports .csproj, .props, .nuspec, and many other .NET file types.",
   "main": "lib/index.js",
   "scripts": {

src/index.ts

@@ -11,9 +11,14 @@ async function run(): Promise<void>
             filePathPattern = Core.getInput("files");
         }
         const newVersion: string = Core.getInput("version");
+        const pluginTagFilter: string = Core.getInput("tags");
         console.log(`File path pattern: ${filePathPattern}`);
         console.log(`New version: ${newVersion}`);
-        const updaterResults: UpdaterResult[] = await Updater.update(filePathPattern, newVersion);
+        if (pluginTagFilter !== "")
+        {
+            console.log(`Tag filter: ${pluginTagFilter}`);
+        }
+        const updaterResults: UpdaterResult[] = await Updater.update(filePathPattern, newVersion, pluginTagFilter);
         let oldVersionString: string = "";
         let newVersionString: string = "";
         for (const updaterResult of updaterResults)

src/plugins/assemblyinfo-cpp-plugin.ts

@@ -1,26 +1,33 @@
-import Plugin, { PluginVersionRegex, VersionPartDelimiter } from "./plugin";
+import Plugin, { PluginTag, VersionPartDelimiter } from "./plugin";
 
-const ASSEMBLY_VERSION_ATTRIBUTE_REGEX: RegExp = /\[assembly:\s*AssemblyVersionAttribute\(\s*L"(.*)"\s*\)]/i;
-const ASSEMBLY_FILE_VERSION_ATTRIBUTE_REGEX: RegExp = /\[assembly:\s*AssemblyFileVersionAttribute\(\s*L"(.*)"\s*\)]/i;
+const ASSEMBLY_VERSION_ATTRIBUTE_REGEX: RegExp = /^\s*\[assembly:\s*AssemblyVersionAttribute\(\s*L"(.*)"\s*\)]/;
+const ASSEMBLY_FILE_VERSION_ATTRIBUTE_REGEX: RegExp = /^\s*\[assembly:\s*AssemblyFileVersionAttribute\(\s*L"(.*)"\s*\)]/;
 
 export default class AssemblyInfoCppPlugin extends Plugin
 {
     constructor()
     {
-        const versionRegexes: PluginVersionRegex[] =
+        const tags: PluginTag[] =
         [
             {
+                tagName: "assemblyversion",
                 regex: ASSEMBLY_VERSION_ATTRIBUTE_REGEX,
                 versionPartDelimiter: VersionPartDelimiter.DOT,
                 versionType: "AssemblyVersion attribute"
             },
             {
+                tagName: "assemblyfileversion",
                 regex: ASSEMBLY_FILE_VERSION_ATTRIBUTE_REGEX,
                 versionPartDelimiter: VersionPartDelimiter.DOT,
                 versionType: "AssemblyFileVersion attribute"
             }
         ];
-        super(versionRegexes);
+        super(tags);
+    }
+
+    get pluginName(): string
+    {
+        return "assemblyinfo-cpp";
     }
 
     get fileTypeName(): string

src/plugins/assemblyinfo-cs-plugin.ts

@@ -1,26 +1,33 @@
-import Plugin, { PluginVersionRegex, VersionPartDelimiter } from "./plugin";
+import Plugin, { PluginTag, VersionPartDelimiter } from "./plugin";
 
-const ASSEMBLY_VERSION_ATTRIBUTE_REGEX: RegExp = /\[assembly:\s*AssemblyVersion\(\s*"(.*)"\s*\)]/i;
-const ASSEMBLY_FILE_VERSION_ATTRIBUTE_REGEX: RegExp = /\[assembly:\s*AssemblyFileVersion\(\s*"(.*)"\s*\)]/i;
+const ASSEMBLY_VERSION_ATTRIBUTE_REGEX: RegExp = /^\s*\[assembly:\s*AssemblyVersion\(\s*"(.*)"\s*\)]/;
+const ASSEMBLY_FILE_VERSION_ATTRIBUTE_REGEX: RegExp = /^\s*\[assembly:\s*AssemblyFileVersion\(\s*"(.*)"\s*\)]/;
 
 export default class AssemblyInfoCsPlugin extends Plugin
 {
     constructor()
     {
-        const versionRegexes: PluginVersionRegex[] =
+        const tags: PluginTag[] =
         [
             {
+                tagName: "assemblyversion",
                 regex: ASSEMBLY_VERSION_ATTRIBUTE_REGEX,
                 versionPartDelimiter: VersionPartDelimiter.DOT,
                 versionType: "AssemblyVersion attribute"
             },
             {
+                tagName: "assemblyfileversion",
                 regex: ASSEMBLY_FILE_VERSION_ATTRIBUTE_REGEX,
                 versionPartDelimiter: VersionPartDelimiter.DOT,
                 versionType: "AssemblyFileVersion attribute"
             }
         ];
-        super(versionRegexes);
+        super(tags);
+    }
+
+    get pluginName(): string
+    {
+        return "assemblyinfo-cs";
     }
 
     get fileTypeName(): string

src/plugins/assemblyinfo-fs-plugin.ts

@@ -1,26 +1,33 @@
-import Plugin, { PluginVersionRegex, VersionPartDelimiter } from "./plugin";
+import Plugin, { PluginTag, VersionPartDelimiter } from "./plugin";
 
-const ASSEMBLY_VERSION_ATTRIBUTE_REGEX: RegExp = /\[<assembly:\s*AssemblyVersion\(\s*"(.*)"\s*\)>]/i;
-const ASSEMBLY_FILE_VERSION_ATTRIBUTE_REGEX: RegExp = /\[<assembly:\s*AssemblyFileVersion\(\s*"(.*)"\s*\)>]/i;
+const ASSEMBLY_VERSION_ATTRIBUTE_REGEX: RegExp = /^\s*\[<assembly:\s*AssemblyVersion\(\s*"(.*)"\s*\)>]/;
+const ASSEMBLY_FILE_VERSION_ATTRIBUTE_REGEX: RegExp = /^\s*\[<assembly:\s*AssemblyFileVersion\(\s*"(.*)"\s*\)>]/;
 
 export default class AssemblyInfoFsPlugin extends Plugin
 {
     constructor()
     {
-        const versionRegexes: PluginVersionRegex[] =
+        const tags: PluginTag[] =
         [
             {
+                tagName: "assemblyversion",
                 regex: ASSEMBLY_VERSION_ATTRIBUTE_REGEX,
                 versionPartDelimiter: VersionPartDelimiter.DOT,
                 versionType: "AssemblyVersion attribute"
             },
             {
+                tagName: "assemblyfileversion",
                 regex: ASSEMBLY_FILE_VERSION_ATTRIBUTE_REGEX,
                 versionPartDelimiter: VersionPartDelimiter.DOT,
                 versionType: "AssemblyFileVersion attribute"
             }
         ];
-        super(versionRegexes);
+        super(tags);
+    }
+
+    get pluginName(): string
+    {
+        return "assemblyinfo-fs";
     }
 
     get fileTypeName(): string

src/plugins/assemblyinfo-vb-plugin.ts

@@ -1,26 +1,33 @@
-import Plugin, { PluginVersionRegex, VersionPartDelimiter } from "./plugin";
+import Plugin, { PluginTag, VersionPartDelimiter } from "./plugin";
 
-const ASSEMBLY_VERSION_ATTRIBUTE_REGEX: RegExp = /<assembly:\s*AssemblyVersion\(\s*"(.*)"\s*\)>/i;
-const ASSEMBLY_FILE_VERSION_ATTRIBUTE_REGEX: RegExp = /<assembly:\s*AssemblyFileVersion\(\s*"(.*)"\s*\)>/i;
+const ASSEMBLY_VERSION_ATTRIBUTE_REGEX: RegExp = /^\s*<assembly:\s*AssemblyVersion\(\s*"(.*)"\s*\)>/;
+const ASSEMBLY_FILE_VERSION_ATTRIBUTE_REGEX: RegExp = /^\s*<assembly:\s*AssemblyFileVersion\(\s*"(.*)"\s*\)>/;
 
 export default class AssemblyInfoVbPlugin extends Plugin
 {
     constructor()
     {
-        const versionRegexes: PluginVersionRegex[] =
+        const tags: PluginTag[] =
         [
             {
+                tagName: "assemblyversion",
                 regex: ASSEMBLY_VERSION_ATTRIBUTE_REGEX,
                 versionPartDelimiter: VersionPartDelimiter.DOT,
                 versionType: "AssemblyVersion attribute"
             },
             {
+                tagName: "assemblyfileversion",
                 regex: ASSEMBLY_FILE_VERSION_ATTRIBUTE_REGEX,
                 versionPartDelimiter: VersionPartDelimiter.DOT,
                 versionType: "AssemblyFileVersion attribute"
             }
         ];
-        super(versionRegexes);
+        super(tags);
+    }
+
+    get pluginName(): string
+    {
+        return "assemblyinfo-vb";
     }
 
     get fileTypeName(): string

src/plugins/csproj-plugin.ts

@@ -1,38 +1,47 @@
-import Plugin, { PluginVersionRegex, VersionPartDelimiter } from "./plugin";
+import Plugin, { PluginTag, VersionPartDelimiter } from "./plugin";
 
-const VERSION_TAG_REGEX: RegExp = /<Version>(.*)<\/Version>/i;
-const VERSION_PREFIX_TAG_REGEX: RegExp = /<VersionPrefix>(.*)<\/VersionPrefix>/i;
-const ASSEMBLY_VERSION_TAG_REGEX: RegExp = /<AssemblyVersion>(.*)<\/AssemblyVersion>/i;
-const FILE_VERSION_TAG_REGEX: RegExp = /<FileVersion>(.*)<\/FileVersion>/i;
+const VERSION_TAG_REGEX: RegExp = /<Version>(.*)<\/Version>/;
+const VERSION_PREFIX_TAG_REGEX: RegExp = /<VersionPrefix>(.*)<\/VersionPrefix>/;
+const ASSEMBLY_VERSION_TAG_REGEX: RegExp = /<AssemblyVersion>(.*)<\/AssemblyVersion>/;
+const FILE_VERSION_TAG_REGEX: RegExp = /<FileVersion>(.*)<\/FileVersion>/;
 
 export default class CsProjPlugin extends Plugin
 {
     constructor()
     {
-        const versionRegexes: PluginVersionRegex[] =
+        const tags: PluginTag[] =
         [
             {
+                tagName: "version",
                 regex: VERSION_TAG_REGEX,
                 versionPartDelimiter: VersionPartDelimiter.DOT,
                 versionType: "<Version> tag"
             },
             {
+                tagName: "versionprefix",
                 regex: VERSION_PREFIX_TAG_REGEX,
                 versionPartDelimiter: VersionPartDelimiter.DOT,
                 versionType: "<VersionPrefix> tag"
             },
             {
+                tagName: "assemblyversion",
                 regex: ASSEMBLY_VERSION_TAG_REGEX,
                 versionPartDelimiter: VersionPartDelimiter.DOT,
                 versionType: "<AssemblyVersion> tag"
             },
             {
+                tagName: "fileversion",
                 regex: FILE_VERSION_TAG_REGEX,
                 versionPartDelimiter: VersionPartDelimiter.DOT,
                 versionType: "<FileVersion> tag"
             }
         ];
-        super(versionRegexes);
+        super(tags);
+    }
+
+    get pluginName(): string
+    {
+        return "csproj";
     }
 
     get fileTypeName(): string