v1.0.2

v1.0.2 Release Notes

This is a patch release which updates the URI for the GitHub repository to https://github.com/samvera/samvera-circleci-orb following the transferral of the source code base from https://github.com/samvera-labs/samvera-circleci-orb

Contributors

Contributors for this release include @cjcolvar, @bess, and @rotated8. Thank you everyone for this new release.

Full Changeset

• Updating the README and specifying jrgriffiniii as the Product Owner (#58)
• Replacing samvera-labs with samvera after transferring the repository (#59)

v1.0.1

v1.0.1 Release Notes

This is a patch release which ensures that users have access to two new improvements introduced into the Orb.

Authentication for Apache Solr

The installation of Solr Collections (or Cores) now includes a default authentication credentials (which ensures that, for future releases of the solr in the SolrCloud configuration, the REST API can be used to create an initial Solr Collection for testing Samvera applications). Please see https://solr.apache.org/guide/8_11/basic-authentication-plugin.html and https://github.com/docker-solr/docker-solr for reference.

Updating the Docker Images to use next-gen CircleCI Docker convenience images

This is necessary in order to ensure that the latest images supported by CircleCI are used during continuous integration test suite executions (please see https://circleci.com/docs/2.0/next-gen-migration-guide/ for reference).

Contributors

Contributors for this release include @mlooney, @rotated8, and @cjcolvar. Many thanks to each of you for this new release!

Full Changeset

• Adds Solr Auth (#54)
• Switch to cimg namespaced circleci images (#52)

v1.0.0

v1.0.0 Release Notes

There are a plethora of updates in this release, and while some should be transparent to users of the orb, some may have a large impact. This section will attempt a summary- for the full changeset, see the last section of this release.

Documentation of how to use this version of the orb can be found on the orb's CircleCI page

Deprecations

Orb commands bundle_for_gem and install_solr_active_fedora_core are deprecated, and will be removed in the next major release. Instead, one should use bundle and install_solr_core respectively. These commands shared much of their logic with the similarly named commands that have outlived them. The functionality that they uniquely offered has been rolled into their successors.

New Parameters

Solr and Postgres versions are now parameterized. Postgres defaults to 9.6.2-alpine, and Solr defaults to slim (which is the latest Solr version). If one wishes to avoid unexpected upgrades to Solr, one should specify a version.

Fedora Docker Image

The orb now uses Samvera's Fedora Docker image, rather than the University of Alberta's. As a side effect, this means users can now specify the patch version of Fedora to use; by default the orb uses 4.7.5.

Bundle Caching

Bundle caching has been improved so that cache misses are less frequent. This involved an update to bundle cache key generation, meaning the first time this version of the orb is used, a new version will need to be cached. The orb also now emits a list of cached gems as a build artifact, to assist in debugging.

Rubocop Updates

Rubocop is now run in parallel, and the results are cached to speed up linting.

Orb Updates

The CircleCI orb tools and orb documentation have been updated as well.

Contributors

Contributors for this release include @rotated8, @cjcolvar, @jrgriffiniii, @tpendragon, and @jeremyf. Thank you all for your help.

Full Changeset

• Updates to latest orb-tools version
  Main difference for us is orb-tools no longer has executors, and the shellcheck command is gone.

• Updates the orb testing/publishing workflow
  Updates the orb-tools version
  Automatically push dev versions of the orb if they pass lint and pack
  With approval, creates prod versions for tagged releases
  Updates the README to explain the automatic behavior
  Adds a prototype integration testing section

• Changes the bundle cache key construction
  The cache key now is of the form v<cache_version>-ruby<ruby_version>-bundler<bundler_version>-bundle<bundle_checksum> to allow bundle checksum misses to hit a better, if less specific, cache. In general, I expect this order to be least-often-changed to most-often-changed.
  Also shows the BUNDLE_CACHE_KEY contents in a step rather than saving the file as an artifact.

• Makes bundle cache key creation more repeatable
  In CircleCI, different parallel runs could order the files found for the bundle cache key differently, resulting in cache misses, even though the files found and the MD5s were the same. Now, the checksums are sorted.
  The file that becomes part of the cache key is also added to the run's artifacts, so future debugging won't have to do so much guesswork.

• Speedup rubocop by running in parallel and with caching

• Use the solr:slim docker image
  The previous image, solr:7-alpine has not been updated in almost a year. If we believe our components that use Solr are not tied to Solr 7, we should allow the Solr version to advance. With the solr_version parameter, the orb's consumers can control which version they wish to use. The README has been updated to reflect this.

• Updates the Fedora port used in executors
  The Fedora docker image mounts the application at /, rather than /fcrepo/, so the port used by the executors with Fedora was wrong.

• Updates docs
  README gains a bunch of links to help people get started
  CONTRIBUTING no longer refers to master as the default branch, switching to main
  References to Travis have been replaced with Circle
  References to Ruby tools have been removed.
  Links to the Duraspace wiki now point to Lyrasis
  Updates orb metadata to align with README

• Allows control of the Postgres version via parameter

• Creates a list-of-bundled-gems artifact
  After the bundle is installed and cached, use bundler to create a list of the gems in use and their version. This list is saved to a file, which is uploaded into Circle's artifacts.
  As a reminder, artifacts remain available from a build for 30 days.

• Updates executor parameters
  Puts params in alphabetical order
  Adds a param for the Solr docker image version
  Adds consistent whitespace for parameters

• Adds some standard documentation files

• Updates the bundle command, and deprecates bundle_for_gem
  The two bundle commands are trying to accomplish the same thing, but slightly differently. After combining the best parts of both, we only need one. The other is marked for deprecation.

• Avoid hardcoding the working dir when caching bundler

• Switch Fedora to Samvera's docker images

• Unify install_solr_core and install_solr_active_fedora_core

v0.3.2

This is the last release of the orb before it started becoming a core component.

Because this tag was created long after the code was released, additional context about the release has been lost. However, having a tag will help as new tags are created in the future.