fork-version 1.7.3 → 1.8.0

package/CHANGELOG.md

@@ -1,5 +1,61 @@
 # Fork Version
 
+## 1.8.0 (2025-08-11)
+
+
+### Features
+
+* added bicep file support ([#87](https://github.com/eglavin/fork-version/issues/87)) ([d6d44ac](https://github.com/eglavin/fork-version/commit/d6d44ac3b64a59d39555c2b886f320a348b80efa))
+
+
+## 1.7.9 (2024-11-26)
+
+
+### Refactor
+
+* dont sign if --sign not passed into cli arguments ([#84](https://github.com/eglavin/fork-version/issues/84)) ([8a9e6f4](https://github.com/eglavin/fork-version/commit/8a9e6f49ef1715fe0c2b0f5adaa5e9a032683727))
+
+
+## 1.7.8 (2024-11-13)
+
+
+### Refactor
+
+* split user-config to allow easier testing ([#82](https://github.com/eglavin/fork-version/issues/82)) ([dfe01e0](https://github.com/eglavin/fork-version/commit/dfe01e058df1006995c82743ddb0c55831477c87))
+
+
+## 1.7.7 (2024-11-10)
+
+
+### Refactor
+
+* clean up test setup functions ([#81](https://github.com/eglavin/fork-version/issues/81)) ([2525687](https://github.com/eglavin/fork-version/commit/252568781e8678a065063f8a1a02b6a1681078ad))
+
+
+## 1.7.6 (2024-11-09)
+
+
+### Refactor
+
+* remove git-semver-tags library in favour of vendoring it ([#80](https://github.com/eglavin/fork-version/issues/80)) ([5e1b9cb](https://github.com/eglavin/fork-version/commit/5e1b9cbe7c7d77479235fcdc6f1dbc182c10ecd3))
+
+
+## 1.7.5 (2024-11-09)
+
+
+### Refactor
+
+* rename strategies folder to files ([#79](https://github.com/eglavin/fork-version/issues/79)) ([9a06f63](https://github.com/eglavin/fork-version/commit/9a06f63c95d760fa0d729a839d2dc576c9c059e9))
+
+
+## 1.7.4 (2024-11-08)
+
+
+### Bug Fixes
+
+* match casing of logs between steps ([df88a60](https://github.com/eglavin/fork-version/commit/df88a60429b508dcbaa55aff34ff816e745b26f5))
+
+
 ## 1.7.3 (2024-11-03)
 
 

package/README.md

@@ -14,7 +14,7 @@ Fork-Version automates version control tasks such as determining, updating, and
 </p>
 
 <details>
-<summary>This project is essentially a complete re-write of standard-version following on from its deprecation in May 2022.</summary>
+<summary>This project is essentially a complete re-write of <a href=https://github.com/conventional-changelog/standard-version>standard-version</a> following on from its deprecation in May 2022.</summary>
 Although there are many alternatives such as <a href=https://github.com/googleapis/release-please>release-please</a>. This project aims to continue focusing on just the versioning and changelog generation aspect of the process for use in other Git hosts outside of Github.
 </details>
 
@@ -23,7 +23,7 @@ Although there are many alternatives such as <a href=https://github.com/googleap
 By following the [conventional commit](https://www.conventionalcommits.org) standard Fork-Version can automate the following tasks for you:
 
 1. Determine the current and next version
-1. Update the version in the selected files
+1. Update the version in the selected files [(View the supported files)](#supported-file-types)
 1. Update your changelog
 1. Commit the changed files
 1. Create a tag for the new version
@@ -77,6 +77,7 @@ To install the package locally to your project you can use one of the following
 You can then add the following entry to your package.json scripts section and use it like any other script you already use in your project.
 
 ```json
+// package.json
 {
   "scripts": {
     "release": "fork-version"
@@ -98,6 +99,8 @@ When ran as a cli tool Fork-Version will exit with one of the following exit cod
 
 ### Command Line Options
 
+The following help text can be viewed by running the following command: `npx fork-version --help`
+
 <!-- START COMMAND LINE OPTIONS -->
 
 ```text
@@ -188,6 +191,7 @@ You can configure Fork-Version using one of the following files:
 Configuring using a javascript file is the most flexible option. You can use any javascript file type you prefer including typescript. Both commonjs and esm exports styles are supported. The `defineConfig` function in the following snippet is optional, using it will give you intellisense information in your code editor of choice.
 
 ```js
+// fork.config.ts
 import { defineConfig } from 'fork-version';
 
 export default defineConfig({
@@ -199,6 +203,7 @@ export default defineConfig({
 Alternatively you can use typescript type annotations in a typescript file:
 
 ```ts
+// fork.config.ts
 import type { Config } from 'fork-version';
 
 const config: Config = {
@@ -212,6 +217,7 @@ export default config;
 Or jsdocs in a javascript file:
 
 ```js
+// fork.config.js
 /** @type {import("fork-version").Config} */
 export default {
   header: `# My Changelog`,
@@ -228,6 +234,7 @@ Another way you can configure Fork-Version is by using a json file called `fork.
 If you still want intellisense information you can use the following schema in your json file, otherwise `$schema` is an optional key.
 
 ```json
+// fork.config.json
 {
   "$schema": "https://raw.githubusercontent.com/eglavin/fork-version/main/schema/latest.json",
   "header": "# My Changelog",
@@ -243,6 +250,7 @@ Internally we're using [zod-to-json-schema](https://github.com/StefanTerdell/zod
 Alternatively you can define your config using a key in your `package.json` file called `fork-version`:
 
 ```json
+// package.json
 {
   "name": "my-js-project",
   "version": "1.2.3",
@@ -343,14 +351,14 @@ Marking a release as a pre-release allows you to define a change as a patch to a
 | Example Value | Version Created |
 |:--------------|:----------------|
 | `true`        | `1.2.3-0`       |
-| `alpha`       | `1.2.3-alpha-0` |
+| `alpha`       | `1.2.3-alpha.0` |
 
 Fork-Version uses [meow](https://github.com/sindresorhus/meow) to parse cli arguments which is unable to take a single argument and parse it as either a string and or a boolean. So to do the above through the cli interface you'll need to use two different arguments:
 
 | Example CLI Usage                      | Version Created |
 |:---------------------------------------|:----------------|
 | `fork-version --pre-release`           | `1.2.3-0`       |
-| `fork-version --pre-release-tag alpha` | `1.2.3-alpha-0` |
+| `fork-version --pre-release-tag alpha` | `1.2.3-alpha.0` |
 
 ##### config.releaseAs
 
@@ -389,7 +397,7 @@ Checkout the `fork.config.js` file [here](./fork.config.js) to see an example of
 | section  | string  | The name of the section in the `CHANGELOG` the commit should show up in. |
 | hidden   | boolean | Should show in the generated changelog message?                          |
 
-###### config.releaseMessageSuffix
+##### config.releaseMessageSuffix
 
 Adds a suffix to the end of the release message, useful to add a `[skip ci]` message to the end of the created commit.
 
@@ -402,6 +410,7 @@ Adds a suffix to the end of the release message, useful to add a `[skip ci]` mes
 - [Yaml Package](#yaml-package)
 - [Plain Text](#plain-text)
 - [MS Build](#ms-build)
+- [ARM Bicep](#arm-bicep)
 
 #### Json Package
 
@@ -431,7 +440,7 @@ version: 1.2.3
 
 #### Plain Text
 
-A plain text file will have just the version as the content.
+A plain text file is a file which contains just the version as the content. Files that end with `version.txt` will be treated as a plain text version file.
 
 ```text
 1.2.3
@@ -451,6 +460,15 @@ A MS build project is an xml file with with a `Version` property under the `Proj
 
 Fork-Version currently supports reading and updating the following file extensions: `.csproj` `.dbproj` `.esproj` `.fsproj` `.props` `.vbproj` `.vcxproj`
 
+#### ARM Bicep
+
+An ARM bicep file with metadata and variable called contentVersion.
+
+```bicep
+metadata contentVersion = '1.2.3.4'
+var contentVersion string = '1.2.3.4'
+```
+
 #### Custom File Updater's
 
 `TODO` [add support for custom file readers and writers through config #5](https://github.com/eglavin/fork-version/issues/5)