Skip to content

Latest commit

 

History

History
780 lines (409 loc) · 30 KB

RELEASE_NOTES.md

File metadata and controls

780 lines (409 loc) · 30 KB
Raw

Nyx Release Notes

3.0.11

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

This release:

  • fixes the mismatch between Go and Java on the Git entity serialization (#332)

3.0.10

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

This release:

  • fixes the mismatch between Go and Java on the Git entity serialization (#332)

3.0.9

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

This release:

  • fixes the mismatch between Go and Java on the Git entity serialization (#332)

3.0.8

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

This release:

  • fixes the representation of commit dates in Java (#330)

3.0.7

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

This release:

  • adds support for Gradle 8.10.1.

3.0.6

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

This release:

  • upgrades all Go libraries to the latest version

3.0.5

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

This release:

  • adds support for Gradle 8.9.

3.0.4

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

This release:

  • upgrades Go to version 1.22.4
  • upgrades all Go libraries to the latest version

3.0.3

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

This release:

  • adds support for Gradle 7.6.4, 8.7 and 8.8.

3.0.2

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

This release:

  • applies security fixed in Go binaries and upgrades dependencies

3.0.1

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

This release:

  • fixes a bug that allowed to publish a new release without tagging and pushing, resulting in a remote error (#300)
  • fixes the Java source and compatibility version to Java 17 (#302)
  • upgrades the Jackson Java library to version 2.16.0
  • upgrades Go packages and fixes the following dependabot alerts: 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
  • adds the description of the --summary and --summary-file arguments in the --help output (#292)
  • fixes a misleading attribute in the configuration examples (#301)

Fixed issues

There are no fixes in this release.

3.0.0

This release is available at this link.

Upgrade instructions

If using Gradle you need to upgrade to Java version 17 or later. Java versions older than 17 are no longer supported.

New features and improvements

This release:

  • drops support for Java versions older than 17.
  • adds support for Gradle 7.6.3, 8.4, 8.5 and 8.6.

Fixed issues

There are no fixes in this release.

2.5.1

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

This release:

  • adds support for commit message conventions matching multiple portions of commit messages (yielding to multiple bump identifiers per commit), useful for merge commits (#125)
  • improves regular expressions used for the Conventional Commits convention
  • adds the unofficial conventionalCommitsForMerge convention (disabled by default) to the extended preset, useful for merge commits (#125)

Fixed issues

This release:

  • fixes a bug in changelog templates where commit SHA was not rendered properly (#243)

2.5.0

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

This release:

  • adds support for arbitrary substitutions in text files within the project using dynamic values from the State (#182) (#223)
  • adds support for multiple Git tag names that can be used to change the default git tag or add some tag aliases (#243)
  • adds support for the new gitPushForce, gitTagForce flags to control whether Git push and tag operations need to use the --force flag, useful when using tag aliases in the Git tag names (#243)
  • adds support for the new versionMajorNumber, versionMinorNumber, versionPatchNumber, versionPreReleaseIdentifier, versionBuildMetadata state attributes
  • adds support for the new releaseName configuration option to control the name of releases published to remote services (#238)
  • adds support for the new publishDraft and publishPreRelease configuration options to control extra flags of releases published to remote services (as of now only supported by GitHub) (#238)
  • adds support for the new append configuration option to control whether the changelog file is overwritten or appended and, if appended, in which order (#183)
  • adds support for Git tag updates so existing tags can be replaced and overwritten (#243)
  • adds support for Gradle 8.2.1 and 8.3.

Fixed issues

There are no fixes in this release.

2.4.7

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

There are no new features or improvements in this release.

Fixed issues

This release:

  • fixes a typo Java Gradle interfaces (#240)

2.4.6

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

There are no new features or improvements in this release.

Fixed issues

This release:

  • fixes a bug in the Java version (#236) due to a misalignment of Gradle logger API

2.4.5

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

There are no new features or improvements in this release.

Fixed issues

This release:

  • fixes a bug in the Java version (#236) due to a misalignment of Gradle logger API
  • updates Java dependencies and adds support for Gradle 8.2.

2.4.4

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

There are no new features or improvements in this release.

Fixed issues

This release:

  • fixes a bug in the command line version that does not comply with .gitignore (#219). The issue is inherited by go-git (see here for an example). The issue is worked around by programmatically adding each pattern from the .gitignore to the Git worktree excludes. Only the .gitignore file in the repo root directory is read
  • fixes a bug in the command line version that does not allow to disable the generation of the state file (#230)

2.4.3

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

There are no new features or improvements in this release.

Fixed issues

This release:

  • fixes a bug in the command line version that caused a segment violation error when running the infer matching a release type that doesn't define the collapsedVersioning attribute (#225)

2.4.1

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

There are no new features or improvements in this release.

Fixed issues

This release:

  • fixes a bug in the command line version that caused a segment violation error when running the infer command when the collapsedVersioning attribute is not defined in the configuration (#221)

2.4.0

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

The Docker image is now published (again) to Docker Hub after Docker Hub decided not to sunset support for free organizations (#184).

Fixed issues

There are no fixes in this release.

2.3.5

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

There are no new features or improvements in this release.

Fixed issues

This release:

  • fixes a bug in the command line version that caused a segment violation error when running the clean command when no previous state is found and so the current version hasn't been initialized yet (#217)

2.3.4

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

There are no new features or improvements in this release.

Fixed issues

This release:

  • fixes a bug in the Java version prevents SSH authentication to complete with private keys passed as strings due to the SSH-agent misuse (#201)

2.3.3

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

There are no new features or improvements in this release.

Fixed issues

This release:

  • fixes a bug in the command line version that caused a an exit code 1 to be returned when pushing changes to a Git remote that is already up to date (#194)

2.3.2

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

There are no new features or improvements in this release.

Fixed issues

This release:

  • fixes a bug in the command line version that caused a segment violation error when the collapsedVersioning configuration attribute is not set (#196)

2.3.1

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

There are no new features or improvements in this release.

Fixed issues

This release:

  • fixes a bug in the command line version that prevented Git remote services to use template variables in their configuration (#186)

2.3.0

This release is available at this link.

Upgrade instructions

  • existing State files must be generated again due to the change of the format of timestamp offsets for Git commits

New features and improvements

This release:

Fixed issues

This release:

  • fixes a bug that prevented State files serialized with one version of the tool (Go or Java) to be deserialized with another version, due to the format used to serialize the Git author action or commit action timestamp offets (#170). Now offsets are stored as simple signed integers. With more details, Git author actions and commot actions had their timestamps with a string representing the offset to UTC. That format was not portable so now they are stored as positive or negative integers, representing the offset in minutes from UTC. The field name within the timeStamp structure has changed from timeZone to offset.

2.2.0

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

This release:

  • this release adds support for the summary and summaryFile configuration options, for an easily parseable output from Nyx (#156)

Fixed issues

There are no fixes in this release.

2.1.0

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

This release:

  • this release extends backward compatibility for the Java version (the command line version is not affected) (#153), in details:
    • the recommended JVM version is 15 or newer and the recommended Gradle version is 7.0 or newer
    • older Java versions starting from 11 and older Gradle versions starting from 6.0 are supported with the exception of Gradle versions between 6.5 and 6.9.3 (see #153)
    • JVM versions older than 11 and Gradle versions older than 6.0 are not supported

Fixed issues

There are no fixes in this release.

2.0.0

  • when using the Java (Gradle) version, the minimum Java version is now 15 and the minimum Gradle version is 7.0 (see here and here); Gradle versions from 6.7 on should still work but they are no longer tested
  • the public key (SSH) authentication method is now supported for Git (#94)
  • the Git internal library (github.com/mooltiverse/nyx/modules/go/nyx/git package for Go, com.mooltiverse.oss.nyx.git package for Java) has been refactored in order to support multiple authentication mechanisms (with the new SSH method) and some methods have been replaced while others have been added
  • support for deprecated template functions environment.user, environment.variable, file.content, file.exists has been removed, replaced by environmentUser, environmentVariable, fileContent, fileExists
  • new parametric template functions are now available: capture, cutLeft, cutRight, replace, timeFormat (#104, (#119))
  • Java template functions in com.mooltiverse.oss.nyx.template.Functions.java no longer implement the java.util.function.Function interface which was provided for backward compatibility; from now on they only implement the com.github.jknack.handlebars.Helper interface provided by Handlebars
  • release assets published to GitLab now show their Description instead of the File Name (#128)
  • the state now has two additional boolean attributes: coreVersion and latestVersion, telling if the current version is a core version (using only core identifiers) and if it is the latest version (compared to all tags in the repository) (#105)

This release is available at this link.

Upgrade instructions

  • if you are using the Java (Gradle) version make sure you run Java 15 and Gradle 7.0 or newer
  • if you embedded Nyx in your code and used the github.com/mooltiverse/nyx/modules/go/nyx/git Go package or the com.mooltiverse.oss.nyx.git package, fix your code reflecting the changes made to the API
  • if you plan to use Git SSH authentication please refer to the configuration reference for the required configuration options
  • replace usage of deprecated template functions environment.user, environment.variable, file.content, file.exists (with dots) with environmentUser, environmentVariable, fileContent, fileExists (camel case names) in the configuration

New features and improvements

  • the public key (SSH) authentication method is now supported for Git (#94)
  • new parametric template functions are now available: capture, cutLeft, cutRight, replace, timeFormat

Fixed issues

There are no fixes in this release.

Known issues

There are no known issues in this release.

1.3.4

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

There are no new features or improvements in this release.

Fixed issues

This release:

  • fixes bug #141 about confured templates not being rendered correctly when they use transient objects from the State like, for example, the configuration tree (Go)

1.3.3

This release is available at this link.

Upgrade instructions

Make sure the git executable must be available in the local PATH for the workaround to woork. If git is not available Nyx doesn't break but the workaround is not effective.

New features and improvements

There are no new features or improvements in this release.

Fixed issues

This release:

  • fixes bug #130 about Git repository status being wrongly detected in some circumstances; a workaround has been applied using the local git executable (if available in the local PATH) (Go)

Known issues

There are no known issues in this release.

1.3.2

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

There are no new features or improvements in this release.

Fixed issues

This release:

  • fixes bug #132 about the preset configuration layer not being loaded unless configuration files are provided (Go)

Known issues

There are no known issues in this release.

1.3.1

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

There are no new features or improvements in this release.

Fixed issues

This release:

  • fixes bug #131 about wrong dates and timestamps in generated changelogs and versions (Go)

Known issues

There are no known issues in this release.

1.3.0

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

The command line version is now available #120. Binaries can be downloaded from the release page.

Fixed issues

There are no fixes in this release.

Known issues

  • GitHub release assets are only displayed by their file names, while the description is ignored (due to a limitation in the underlying library)

1.2.3

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

There are no new features or improvements in this release.

Fixed issues

This release:

  • fixes bug #122 about extracting the commit type using Gitmoji and rendering the changelog

Known issues

There are no known issues in this release.

1.2.2

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

There are no new features or improvements in this release.

Fixed issues

This release:

  • fixes the issue with up-to-date checks causing duplicate tags to be applied when runnin in dirty repositories #116
  • bug #116 also fixes bug #115 although it was originally about a different issue

Known issues

There are no known issues in this release.

1.2.1

This release is available at this link.

Upgrade instructions

If you use Gradle and configure Nyx through the Gradle Extension with some release assets and also filter release assets within release types using the assets filter you need to update the assets filter configuration to use a simple string (defining a comma separated list of asset names to enable for the release type) instead of a native list. For example you need to replace assets = [ "asset1", "asset2" ] with assets = [ "asset1,asset2" ] within each release type.

New features and improvements

There are no new features or improvements in this release.

Fixed issues

This release:

  • fixes the issue with release type assets filter configured through the Gradle plugin #110
  • fixes the issue with the resume flag causing NullPointerException #81

Known issues

There are no known issues in this release.

1.2.0

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

This release:

  • adds support for release assets so that published releases can also contain artifacts. You can configure release assets following these instructions

Fixed issues

There are no fixes in this release.

Known issues

There are no known issues in this release.

1.1.0

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

This release:

  • replaces the internal Mustache template engine with Handlebars for extended feature support

Fixed issues

There are no fixes in this release.

Known issues

There are no known issues in this release.

1.0.1

This release is available at this link.

Upgrade instructions

There are no actions to take for backward compatibility.

New features and improvements

There are no new features or improvements in this release.

Fixed issues

This release:

  • fixes the Extended preset to also support the Fix release type #89
  • fixes the Make command to comply with the dryRun flag #81

Known issues

There are no known issues in this release.