Release Notes

Transitive packed dependencies can now appear in the workspace (as links or unpack folders) in more than one location. Previously, if a transitive dependency was expected to appear in multiple locations (because it came from multiple packed dependencies which were configured to appear in different folders) it would only appear in one of those locations, and the location was not predictable.

No changes.

Major new feature: added support for "source overrides", which allow developers to replace the links for packed dependencies with links to a local checkout of corresponding source code. This allows you to modify the source, for example to help debug a problem. See sourceOverrides for more details.

No changes.

Improve support for choosing a Visual Studio version. See version for more details.

No changes.

Change credential-store.exe to compare usernames case-insensitively.

GR #6718 Add support for reading/writing files with a non-default charset, e.g., UTF-8 on Windows 7.

stamping {
    charsetName = "UTF-8" // New in 7.10.2

    def commas = nextVersionNumber.replaceAll("\\.", ",")
    files(".rc") {
        replaceRegex ~/(FILEVERSION )[\d,]+(.*)/, commas
        replaceRegex ~/(PRODUCTVERSION )[\d,]+(.*)/, commas
        replaceRegex ~/(VALUE \"FileVersion\", \")[\d\.]+(\\0\")/, nextVersionNumber
        replaceRegex ~/(VALUE \"ProductVersion\", \")[\d\.]+(\\0\")/, nextVersionNumber
    }
}

No changes.

GR #6716 Fix bugs in the changes to credential-store.exe in 7.10.0

Support Visual Studio 2017. (Instead of using environment variables, this version has a new mechanism for locating devenv.com, namely by running vswhere.exe. This allows installing multiple "flavours" of VS but needs changes to the Holy Gradle.)

No changes.

GR #6715 Allow source dependency credentials to be derived from a user-named "basis" credential. This supports having source dependencies on repos hosted at different sites, which need different credentials.

No changes.

GR #6714 Fix: ensure an exception is thrown to stop the build if Git/Hg/Svn processes have a non-zero exit value.

GR #6714 Various fixes related to Git (and Hg) source dependencies:

No changes.

GR #5985 Extend the auto-detection of the current domain (to set the default Artifactory plugin repo URL) so that it checks all network interfaces, not just the default one.

GR #6701 Upgrade the version of 7-zip used, to avoid security vulnerability https://web.nvd.nist.gov/view/vuln/detail?vulnId=CVE-2016-2335.

No changes.

GR #6692 Git support. Git repos can now be source dependencies, by using the git method instead of hg or svn. This includes recording the source URL, revision, and branch in the build_info folder in packaged artifacts.

No changes.

Fixed a bug in gw.bat which forced you to set the HOLY_GRADLE_REPOSITORY_BASE_URL environment variable even if the file .\gradle\base-url-lookup.txt existed. When that file exists, the base URL should be set from that file. This bug was introduced in 7.6.0. As well as upgrading the version of the plugins, you should upgrade the gradle wrapper (for example, from the wrapper-starter-kit).

No changes.

GR #6570 Create directory junctions instead of directory symbolic links by default. On Windows 7, if you have local Administrator rights, you need to turn UAC down or off to be able to create symlinks, which is somewhat annoying and unsafe. On Windows 8 and above you also need to run from an elevated (Administrator) Command Prompt, which is even more so. This release uses directory junctions instead, for symlinks to the unpack cache and for the links DSL (renamed from symlinks).

No changes.

GR #6588 Fix for upgrading from Artifactory 3.3.0 to 4.7.1. The checkPackedDependencies command was sending the wrong content type in the "Accept" header when checking for which module versions exist. The older Artifactory version ignored it but 4.7.1 complained with "406 Not Acceptable".

GR #6675 Bug fix and further improvements to the unit-test plugin. Deprecated the behaviour that test tasks would look for the executable relative to the root project’s projectDir. It now only looks in the current project’s projectDir or on the system PATH, similar to the default behaviour for Exec and project.exec.

GR #6588 Fix for upgrading from Artifactory 3.3.0 to 4.7.1. Fixes for the replicationVersionCheck Artifactory plugin; should still be compatible with 3.3.0 but that wasn’t tested.

No changes.

In gw.bat the JAVA_HOME and GRADLE_HOME environment variables are now copied from HOLY_GRADLE_JAVA_HOME and HOLY_GRADLE_GRADLE_HOME if they exist. This allows you to run other apps with a different version of Java, even though the Holy Gradle requires Java 1.7. As well as upgrading the version of the plugins, you should upgrade the gradle wrapper (for example, from the wrapper-starter-kit).

GR #6664 Move the "everything" configuration behind a property flag. Added an error message for the unlikely case of trying to explicitly put the same packed dependency at two different locations, which is not supported.

GR #6675 Bug fix and further improvements to the unit-test plugin:

No changes.

GR #6664 Move the "everything" configuration behind a property flag. Fixed a bug where, if the same module was both a direct and a transitive dependency, it could cause packed dependency resolution to fail, depending on the order in which they were found.

GR #4126 Bug fix for recording source version info for unpublished source dependencies. Info for transitive source dependencies was only included for the root project; for other projects (including all source dependencies reachable from the root project), only info on immediate source dependencies was included. Now each project’s build_info folder includes source version info for its complete set of transitive source dependecies.

GR #6585 Internal change to make sure that the configurations returned by a configuration set’s methods are always returned in the same order.

GR #6675 Convenience improvements to the unit-test plugin:

GR #5818, GR #4104 These Artifactory plugins need to make REST calls to the local server’s API. This release parameterises the URL for the local server, since it may not be on the default of "http://localhost:8081/".

No changes.

GR #6664 Move the "everything" configuration behind a property flag

GR #5818 New Artifactory plugin — fail replication if source server is different version (and send email notifications).

GR #4104 Add email notifications to existing checkCaseInsensitiveNameClash Artifactory plugin.

No changes.

GR #6585 Further bugfixes and improvements.

No changes.

GR #6585 Fixed mistake in overall design of configuration mapping. If module A is mapping to module B, and doesn’t want to export B’s "import" configurations in its own "import" configurations, it usually still needs to have a mapping to the import configurations of module B, otherwise headers/etc. will be missing (if the unpack cache is clean). The fix is to map from a private configuration "build" in A to the "import" configurations of B.

No changes.

GR #6585 Further bugfixes and improvements based on use in practice.

GR #2693 Deprecated the ".publishing" level of the sourceDependencies DSL, because the configuration inside it is relevant for dependency resolution when building, not only when publishing. The configuration mapping methods inside it are now available one level up, directly in the SourceDependencyHandler.

GR #4676 Removed the never-used option in SourceDependencyHandler to override the group or version of a published source dependency, because it never really made sense. Also removed the sourceDepdendency.usePublishedVersion property. What these were trying to achieve will be provided by the "GR #6279 source overrides" work when it’s merged to default.

A source dependency will no longer automatically have a mapping between the "everything" configurations of the originating module and the dependency. This mapping is only added when some other mapping is added. This means that you can now have a source dependency with no Gradle project and no published dependency, for example, to include source or documents from a different source repository in the current module. See configuration.

GR #5847 By default the "relativePath" attribute is no longer added to generated ivy.xml files. GR #5845 and GR #5846 changed the behaviour on read so that, by default, this value is ignored anyway. The Ivy files therefore now validate, which will allow us to upgrade to Gradle 1.8 or higher.

GR #5823 Changed DevEnvHandler so it no longer assumes (the now rather outdated) Visual Studio 2010 by default. Now you must specify the version.

No changes.

Fixed new bug introduced by previous bugfix (for deleting files with long paths), that read-only files could not be deleted.

No changes.

GR #6585 Bugfixes and improvements based on use in practice.

Internal bugfix for deleting test output files with paths longer than the Windows maximum.

No changes.

Bugfix for symlink creation: Symlinks were testing whether the link target existed before creating but for relative links this was being done relative to the working directory rather than the link itself (which is the behaviour Windows uses when creating the link).

Made gw.bat cope properly with paths with spaces in them (though other parts of the Holy Gradle may not).

GR #6585 Add support for creating and mapping sets of related configurations. Unlike JVM-based code, native applications often vary by platform, build setup (Debug or Release), etc., as reflected in the "model" in newer versions of Gradle, and it is natural to map these to separate Gradle configurations. This new DSL makes this easier. See configurationSetTypes and configurationSets.

No changes.

GR #6391. Added a zipDependencies task which is like collectDependencies but collects files straight to a UTC-time-stamped ZIP file.

GR #6355. Can’t republish with holygradle 7.5.0. The changes in 7.3.0 for GR #5759 (not entirely overwriting the settings.gradle file) clashed with the createSettingsFileForPackedDependencies task which is only used as part of the "republish" task. For now I’ve merged the logic, in a slightly hacky way, but the real fix is to replace the current republish mechanism with something much simpler.

GR #2297, GR #4677. Configurations with a naming starting with "private" used to be removed from the ivy.xml. They are now just marked as visible=false in Gradle terms (visibility="private" in the ivy.xml). This means it’s easier to find the version number of non-public dependencies: previously you had to look at the build scripts. It also means that, if you use a floating version number (which we don’t recommend) for a private dependency, the ivy.xml will record the version actually used.

GR #1962. (Shouldn’t affect anyone.) Removed the "_confict" mechanism, which was added in the very early days in an attempt to make the ivy.xml "look neater" when conflicting versions of dependencies were used in different configurations of one module. However, the resulting ivy.xml would be incorrect and unusable, so it was pointless.

Fixed minor bug where pacakgeArtifacts.includeBuildScript.addPackedDependency could be called more than once for the same dependency and would only use the last call. Now it fails if called more than once.

Fixed minor bug where a unit test would fail if the folder for the test output didn’t already exist. Now it’s created.

Fixed minor bug where a packedDependency could be declared more than once with a different dependency string, which doesn’t make sense, and would break symlink generation. Now it fails immediately with a sensible error message.

GR #5714. Replace TaskDependencies with Gradle’s built-in mechanism. Previous implementation of "build/test for this project only, ignoring dependencies" (in 7.3.0) didn’t actually work, and always ran dependencies as well.

No changes.

GR #6072. local_artifacts folder now contains build_info so that the person who receives it can tell which version of the source it matches.

No changes.

GR #5845, GR #5846. Bug fixes.

No changes.

Bug fix. Using resolutionStrategy.force with packed dependencies would cause intrepid to fail to find the ivy.xml files (needed for the relativePath and for collectDependencies) for those modules (if the forced version was lexicographically less than the original version), and so fail the build.

No changes.

A minor change to how collectDependencies works. Previously there was one such task per project, with no task dependencies between them. This made it tricky to have another task depending on collectDependencies. Now there is just one such task, in the root project, which collects the dependency artifacts and metadata for all projects.

No changes.

GR #5845, GR #5846. Make default relative path for transitive packed deps be "../name" instead of "./name". This is the first of several changes to simplify dependency symlinks. This change means that libraries which don’t have relativePath in their ivy.xml will all be symlinked next to each other, rather than some appearing inside others. Any projects which have worked around this lack of relativePath, by adding direct dependencies on things they really only indirectly depend on, can now remove those workaround dependencies.

No changes.

GR #5759 Bug fix. When a settings.gradle file was created by 7.3.2, 7.3.1, or 7.3.0, it would work for the developer who first created it and committed it to source control, but fail for another developer who checked it out. This is because it required the "settings-subprojects.txt" to exist. A workaround is to create an empty file of that name. This release fixes the bug properly: if the file does not exist, the code added to settings.gradle will assume there are no subprojects. If you already have a settings.gradle with this bug then, to upgrade, you must first either delete the section "holygradle source dependencies" from it, or create an empty "settings-subprojects.txt", Then upgrade your plugin versions and run "gw fAD".

No changes.

GR #5759, GR #5912 Fix two exceptions which could occur in error cases. These were introduced in the changes for not overwriting the settings file (#5759) and for removing the embedded Mercurial and Subversion code (#5912).

No changes.

GR #5759 Intrepid will now include the settings file (settings.gradle) in the "buildScript" artifact ZIP file when publishing, as well as the build script (build.gradle). Now that intrepid does not always overwrite the settings file, users may modify it, so it should be kept for traceability. This is particularly useful for simple packaging of third-party libraries, where the build file may not be committed to source control.

No changes.

GR #5714 Replace TaskDependencies with Gradle’s built-in mechanism. Tasks like buildDebugIndependently have been replaced with the standard Gradle way of saying "run just for this project, not for other source dependency projects": gw -a buildDebug.

GR #5912 Use installed Mercurial and/or Subversion to process source dependencies, instead of using an embedded version. Before this release, the intrepid plugin would use a pre-packed version of Mercurial pulled from Artifactory, and used a Java library svnkit for Subversion access. This was convenient in some ways but has caused problems (a) where user configuration of their installed tools was not shared with the "embedded" versions; and (b) that some users' installed version of Subversion now creates a working copy format which the embedded version can’t read. So from now on the plugin will rely on hg.exe and/or svn.exe being on the path, to access source dependencies.

GR #2618 Reduce the visibility of warnings about source dependencies, when they are still to be fetched. These warnings are usually false positives, so now they’re only shown at the info logging level.

GR #2394 Intrepid could previously record the wrong source version in the build_info folder, if the project dir was both an SVN and Hg working copy. This isn’t really a sensible thing to do, and it only every happened on one build machine a long time ago, but the plugins will now just fail if the project is under both kinds of source control.

GR #5759 Intrepid will no longer completely overwrite the settings file each time it runs. Previously it did this to add source dependency projects to the build. Now it injects a fixed code section and keeps the varying part (a list of source dependency folders) in a separate file. This means that you can use the settings.gradle file for its intended purposes, which includes setting the name of the a project, rather than inferring it from the name of the containing folder. See the Gradle Settings documentation for details. For example, you could write

rootProject.name = "MyModule"

No changes.

GR #5660 Fix for checkPackedDependencies task failing after checking an unavailable dependency.

No changes.

GR #5346 If a meta-package has a generated build script (using includeBuildScript), it will now also have a default settings.gradle added, unless (a) one is added explicitly with includeSettingsFile; or (b) createDefaultSettingsFile = false is called. This avoids the unpacked meta-package accidentally picking up a settings file from an ancestor directory when run, which almost certainly won’t be what its creator intended.

This release also includes a small breaking change to a method used only by one team, but it’s an internal, not-officially-supported method, so I still regard this as a micro version change.

No changes.

GR #4546 Added error-checking/-reporting to addPackedDependency and addPinnedSourceDependency, so they fail if the script tries to add a dependency which doesn’t exist.

No changes.

GR #4071 Using dependencySettings.defaultFailOnVersionConflict = false didn’t actually do anything; fixed.

GR #4125 Add always-visible logging of ZIP files extracted by extractPackedDependencies simlar to what Gradle normally does for downloading of artifacts.

GR #4546 Simplified the code behind packageArtifacts.config>.includeBuildScript.addPackedDependency, by making two changes. In theory these are breaking changes but in practice we know they won’t affect any of our users.

GR #3080 packageArtifacts.includeBuildScript used to work only if you included at least one packed or source dependency; now it always works.

GR #5099 Since the fix for GR #4126 in 7.2.1, the republish task would delete the build_info folder and re-create it with only versions.txt. This is now fixed, although running the packageFoo tasks will still re-create the build_info.

GR #4104 Added an Artifactory plugin to work around https://www.jfrog.com/jira/browse/RTFACT-6377.

GR #4570 Added an Artifactory plugin to provide a per-repo storage usage summary, showing details only for repos visible to the authenticated user (or anonymous).

No changes.

GR #4125 Using PackedDependenyHandler#noCreateSymlinkToCache() (unless the dependency has unpackToCache = false) will now prevent the containing module from publishing (because we can’t be sure which version of the dependency was used).

GR #4126 The build_info folder created during publishing now also records source information for the transitive set of source dependencies, in case some of them are not published.

No changes.

GR #2151, #4125 For large projects, the start-up time of intrepid was dominated by dependency resolution (for the project itself, rather than for the plugins), which was used to build the list of tasks (one extract and one symlink task per dependency), so it happened every time, even if you just ran gw tasks. Now, intrepid avoids doing anything which requires dependency resolution unless you run a task which requires it (fetching or collecting dependencies, rebuilding symlnks, etc.). For a multi-project build with around 10 sub-projects, with an average of 10 source or packed dependencies each, this reduced the start-up time from about 60s to about 20s.

GR #3719, #4559 Previously, if a symlink target did not already exist, the symlink would be created anyway and a warning printed. This seems to have been done because the dependencies between unpacking and symlink tasks were not strictly correct. However, it led to confusion in genuine error cases. Now it fails in such cases (or if there is a non-symlink at the link source location). Some teams had taken advantage of the previous behaviour to swap in a "built from source" version of a packed dependency on their development PC; I’ve added a new method noCreateSymlinkToCache() to allow this pattern in an intentional, rather than accidental, way.

GR #4125 To speed up builds, the beforeBuild task no longer depends on the rebuildSymlinks task. This means that building the solution doesn’t automatically force time-consuming dependency resolution. Projects can still add beforeBuild.dependsOn rebuildSymlinks if they prefer the previous arrangement.

No changes.

GR #4577 A previous bug-fix exposed a bug which was only observed by the one team: the createPublishNotes task needs hg.exe, but doesn’t depend on extractMercurial. If you try to publish when you have a clean cache and haven’t fetched any Mercurial source dependecies (e.g., as on an autobuild machine), this will fail. This release fixes that bug.

No changes.

GR #4546 Release 7.1.5 fixed addPackedDependency but broke addPinnedSourceDependency — the latter was supposed to use wildcard matching, but 7.1.5 changed it to exact matching. This release makes both work as documented.

No changes.

GR #4546 The DSL for adding packed dependencies to a generated build script (packageArtifacts.config.includeBuildScript.addPackedDependency) was broken. It was using wildcard matching instead of the intended exact matching, so it could add the wrong packed dependency, if the name of one were a substring of the other.

No changes.

GR #4088 Fix a bug in 7.1.3 which meant that collectDependencies would try to copy ZIP file artifacts and metadata files for source dependencies, which don’t exist (and aren’t needed anyway), because those dependencies are being built from source.

No changes.

GR #4088 Previously, if a dependency was referenced in terms of a configuration which had no artifacts, intrepid would silently fail to fetch or otherwise consider any dependencies from that empty configuration. 7.1.0 fixed this for all cases except the collectDependencies task; 7.1.3 fixes that as well.

No changes.

GR #3813, GR #4071 Fixed a further which could cause an error "Some dependencies had no ivy.xml file" when running gw fetchAllDependencies. This could happen if the same dependency appeared at multiple levels in the graph (e.g., boost), but only in some cases (depending on the order in which Gradle visited dependencies).

No changes.

GR #3813, GR #4071 Fixed a bug I introduced in 7.1.0, which could cause a crash, rather than useful information, if multiple versions of the same module were specified.

No changes.

GR #3813, GR #4071 Previously, if a dependency was referenced in terms of a configuration which had no artifacts, intrepid would silently fail to fetch or otherwise consider any dependencies from that empty configuration. This is now fixed, except for the collectDependencies task.

No changes.

GR #4116 Change gw.bat so it doesn’t require HOLY_GRADLE_REPOSITORY_BASE_URL (nor generate/overwrite gradle-wrapper.properties) if the local_artifacts folder exists.

GR #4116 Since the init script doesn’t have the server hard-coded into it, we don’t need to depend on the gradle.properties file (of the holy-gradle-plugins build itself).

Put source back-reference into gw.bat.

Fix bug: If on a new machine you run fetchFirstLevelSourceDependencies before fethAllDependencies, then hg.exe would not be downloaded and the command would fail.

No changes.

GR #3554 Allow more fine-grained deletion periods (i.e., days).

GR #2584 Work-around for occasional race condition creating "build_info" folder.

No changes.

GR #4116 The createWrapper task now generates a wrapper which doesn’t hard-code the server URL. Normally only the plugin developers will need to run this task, to publish a new wrapper-starter-kit.

GR #4106 As a workaround for a Gradle 1.4 bug (fixed in later versions), fail with a clear message if a dependency is given as something->*.

Make it easier to debug conflicting dependencies. By default, intrepid turns on failOnVersionConflict for all configurations. It now turns this off if:

No changes.