Summary

Released 7 March 2027

• Dropped support for push events - We've dropped support for push events. If you've enabled the processing of push eve, Acrolinx would post a comment on each commit. As of this release version 4.2.7, there’s no need to include “push“ in the :allowed-event-types configuration option. The integration only processes pull request events.

• Display of Analysis dashboard directly from check results - We've stopped to use a deprecated endpoint to retrieve the Content Analysis dashboard. The integration now retrieves the data directly from the check results.

• Dependency updates - We've included needed dependence updates to this release.

• Security vulnerability fixes - We've fixed some security vulnerabilities,

Summary

Released 11 November 2024

This service release comes with dependency updates and vulnerability fixes.

Summary

Released 29 August 2024

This service release gives you access to sample JSON configuration files via the Command Line Interface (CLI) options --sample-json-config and --sample-files. We've also made some dependency updates, fixed some security vulnerabilities, and improved the log messages.

For more information on how to configure the Git Hosting integration using JSON configuration files, visit Format Migration for Configuration Files and Repository Registry.

Summary

Released 22 April 2024

This release, we've made the :file-size-limit configuration option available for pull requests. We've also done some routine maintenance and security fixes.

Learn more about how to use :file-size-limit in Configurations Explained.

Summary

Released 3 November 2023

This service release fixes a bug that affected pull request status information. If an unsupported pull request activity came through, the pull request status would change to `succeeded`.

The GitHub pull request activities that we currently support are:

• opened

• reopened

• synchronize

We've also added more information to the log entries for better monitoring.

Summary

Released 6 July 2023

This service release fixes a bug that popped up when the first file in a pull request wasn't successfully checked. If this was the case, you couldn't see the link to the Content Analysis dashboard in your results. We've also made some security updates.

Summary

Released 12 June 2023

Improvements and fixes to log entries to make it easier to monitor the private beta feature flag within the Acrolinx for GitHub integration.

Summary

Released 15 May 2023

This release, we've added a feature flag that enables Batch Map Style Guides for Markdown files that have been annotated with metadata. As usual, we've also provided security vulnerability fixes as usual.

Platform Support

This release requires:

• Acrolinx Platform version 2022.02 or later (Private Cloud only)

Improvements

• Target Batch Mapping Feature Flag - We've added a private beta feature flag that enables Target Batch Mapping for Markdown files via document custom fields. Learn more about how it works.

Version 4.1.3

Released 28 April 2023

This version fixes a bug in parallel processing that could cause both the baseline and webhook workers to stop processing.

Version 4.1.2

Released 20 March 2023

This small service release fixes a bug that caused the baseline to enter an infinite loop.

Version 4.1.1

Released 6 March 2023

Small release for maintenance and code refactoring.

Version 4.1.0

Released 16 February 2023

This is an important release with two new features that reduce errors in checks and in configuring files. We also updated our libraries to resolve a couple of high CVEs.

Platform Support

This release requires the following:

• Acrolinx Platform version 2021.12 or later (Private Cloud only)

Improvements

Retry Mechanism for All HTTP Calls Made Towards Acrolinx, GitHub, and Azure DevOps Git

This release extends the implementation of retry mechanisms consistently for all HTTP calls. Previously, this was implemented only for those calls that often fail according to your observations.

The mechanism is used in all calls made to the Acrolinx API and the respective APIs of the Git Hosting providers that we support, namely GitHub and Azure DevOps Git. The mechanism performs retries upon receiving HTTP responses with status codes that indicate temporary unavailability of the servers and thus it increases the likelihood of successful responses. This results in reduced impact of the unavailability of the servers and increased reliability in the communication between the integration and the above mentioned platforms.

EDN to JSON Format Migration for Configuration Files and Repository Registry

The Acrolinx for Git Hosting integration is now able to read its configuration and remote repository registry from JSON files. All three types of configuration files: the user-specific local configuration file, the global configuration file, and the repository level configuration file and the repository registry can be specified in both EDN and JSON, with JSON being the format that takes precedence.

How the remote configuration files and the repository registry are read

If the integration detects a JSON file, it reads the remote configuration from that file and it ignores the EDN configuration file. The remote EDN configuration is read if and only if there’s no JSON file present in the repository.

The above reading rules and format precedence apply to the repository registry file as well. We have provided support for both reading and writing of the repo state from and to the JSON repository registry file.

Support for JSON comments

The JSON format doesn’t support comments, however, we have provided support for comments as objects and key value pairs where the comment object name or key name starts with two forward slashes (//).

For example:

{   "//comment001": "A comment",
        ":foo0": [{"//comment0001": "A comment inside an array"},
                "foo"],
        ":foo1": {
                "//comment001": "Yet another comment",
                ":foo2": "foo2"
        }
}

When the files are read, the comments are ignored. For future compatibility, we recommend the comment keys to be unique.

Naming convention for the configuration options

Note that the naming convention for the configuration options hasn’t changed, so when you specify the configuration options in your JSON files, make sure they start with a colon (:).

Naming convention for the configuration files

You need to make sure that the user-specific local configuration file ends in a .json extension. The file names are as follows:

• Global configuration file name: global-config.json

• Repository-level configuration file name: acrolinx-config.json

• Repository registry file name: repositories.json.

Bug Fixes

The Following Security Vulnerabilities Were Resolved

Dependency (version)	CVSS Rating	CVE	Found in
org.eclipse.jetty/jetty-client ( 9.4.44.v20210927)	LOW HIGH	CVE-2022-2047 CVE-2022-2048	o.github.atomisthq/jibbit > com.cognitect.aws/api > com.cognitect/http-client
com.github.jnr:jnr-posix (3.0.53)	HIGH	CVE-2014-4043	com.unbounce:clojure-dogstatsd-client@0.7.0 > com.datadoghq:java-dogstatsd-client@2.11.0 > com.github.jnr:jnr-unixsocket@0.27 > com.github.jnr:jnr-posix@3.0.53

Summary

Released 28 December 2022

This is a huge release jam packed with new features and bug fixes. Oh, and you might have noticed the new name! Read on to see all the exciting things we’ve added in this release.

Platform Support

This release requires the following:

• Acrolinx Platform version 2021.12 or later (Private Cloud only)

Dropped Support

We have dropped support for the following:

• GitHub 2.0.x, 3.1.1, 3.2.0, 3.3.0, 3.4.0, and 3.5.0.

Improvements

New Name, Same Functionality

The GitHub and the Azure DevOps Git integrations now have a common source code base. They’ll now be available as two different git service providers under one integration, the newly released Git Hosting 4.0 integration. Upon installing the integration, you can configure which integration you want installed.

Updated Configuration Option

The configuration option :secret is now called :gh-secret. Please change your main config file accordingly.

Full Support for Most Configuration Options (Azure DevOps Git)

Most configuration options are now supported for Azure DevOps Git pull request processing. See the end of the release notes for more details.

Decreased the Event Queue Delay from 10 Seconds to 0.1 Seconds

Because of significant improvements of the GitHub cloud system (the git service itself), we’ve been able to drastically decrease the event queue delay from 10 to 0.1 seconds! In practice, it means that the comments and status are now posted to the git hosting service (GitHub or Azure DevOps) up to 10 seconds faster.

ACROLINX_LOGGING_TARGET Option Removed

The environment variable ACROLINX_LOGGING_TARGET that was used to redirect the log output to the standard output has been removed due to a change in the logback library.

We recommend the following approach:

Inside the JAR, the file logback-stdout.xml can be used to redirect the log output. It is on the classpath and can be used as follows:

java -Dlogback.configurationFile=logback-stdout.xml -jar JARFILE ...

This will redirect the log output to standard output.

User Interface Has Been Removed

The user interface of the Git Hosting integration has been removed. The main reason is that all the information provided via the former user interface is now available via command line options and the log system. This means that we can spend more time on new features, rather than maintaining an old, unused one!

Bug Fixes

Sensitive Headers May Have Been Printed to the Logs

With Azure DevOps 1.1, the persistent session ID returned by the Azure DevOps system was printed in some log entries. This has been fixed at the level of the exception system (HTTP headers aren't anymore printed to the log output in those exceptional cases).

Acrolinx Ignored Files When Config Option :allowed-filename-matches Was a String

A bug has been fixed for the configuration option :allowed-filename-matches . Previously when the value of this configuration option was a string (not a vector of strings), the integration wouldn’t check any files. The configuration option now works as designed.

Important Information

Current differences between GitHub and Azure DevOps support:

• The Azure DevOps Git mode supports only pull request events processing.

• The configuration option :ignored-senders can mean different things based on differences in the APIs of those services:

  • GitHub: username

  • Azure DevOps: email address

• The configuration option :use-skip-label refers to the pull request label in GitHub and to the pull request tag in Azure DevOps (different terminology between the git service providers).

• The configuration option :allow-merges-from-default isn’t yet supported on Azure DevOps Git.

Summary

Released 19 October 2022

This release, we've improved the way that Acrolinx checks your files. We've also taken care of a couple of vulnerabilities in third-party libraries. That said, we recommend that you update to this version of Acrolinx for Git Hosting.

Platform Support

Acrolinx for Git Hosting version 3.6.0 requires the following:

• Acrolinx Platform version 2021.03 or later.

Improvements

Improved Processing of Pull Request Events

In the past, you could send pull requests to the Acrolinx Platform in parallel, but they were processed sequentially. This meant that the average number of files in each pull request affected the processing time. We've improved this!

Acrolinx now processes incoming pull requests as quickly as possible and in parallel. With this improvement, the Acrolinx can make full use of all active language servers. Acrolinx will send as many files to the Acrolinx Platform as possible, but no more than what you configure for :acrolinx-parallel-workers. Read more about this in Configurations.

Sending the JAR Log Output to stdout

You can now send the JAR log output to the standard output. To do this, set the environment variable ACROLINX_LOGGING_TARGET to the value stdout. Learn more in our article Logging and Monitoring.

Updated Third-Party Libraries

We found a couple of vulnerabilities in the third-party libraries that we use. That's why we've updated the library to a version where the vulnerabilities no longer exist. Time to do your part – go ahead and update your Acrolinx integration!

For more details, see the National Vulnerability Database.