Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Regarding the templates for these, there is no existing, separate GitHub repository which provides the updated text for many of these files. It is recommended that one contact the current chair for assistance in meeting the documentation requirements.


Releasing Gems

Releasing new versions of Core Components is a duty required of the Product Owner, and this does involve some work with the code base itself. The Samvera Community strongly urges that versioning for Core Components follow semantic versioning guidelines (https://semver.org/). This ensures that patch, minor, and major releases clearly indicate to community members and adopters of the potential updates which might be required when updating a specific Gem dependency in a downstream project.

Gem versions themselves are released to RubyGems (https://rubygems.org/), and in order to successfully publish (or “cut”) a new Gem release, one will need certain additional administrative privileges for this. Please freely contact the current chair of this Working Group in order to request these privileges.

While there is not a single, consistent Gem release process for every Core Component, there are a number of common patterns used to simplify the tasks involved. The most common includes the usage of a Rake command `rake release`, which automates the process of generating a new `git` tag for the release, as well as building and publishing the new release to RubyGems. One case is very well documented on https://github.com/samvera/active_fedora/wiki/Release-management-process.