Skip to content

Commit

Permalink
Disambiguating between Ruby and JavaScript components
Browse files Browse the repository at this point in the history
  • Loading branch information
jrgriffiniii committed Dec 13, 2022
1 parent ec17370 commit 3ec1335
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 10 deletions.
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
README.md
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,12 @@ Samvera Core Components are defined as the following:
_Please reference [A Guide for the Samvera Community](https://samvera.github.io/core_components.html) for further information._

Currently, there are eighteen Samvera Core Components maintained by the community:
Currently, there are twenty Samvera Core Components maintained by the community:

### Ruby Samvera Components

| Component | CircleCI Status | Ruby 3.1 Support | Ruby 3.0 Support | Ruby 2.7 Support | Ruby 2.6 Support | Rails 7.0 Support | Rails 6.1 Support | Rails 6.0 Support | Rails 5.2 Support |
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
| [active_fedora](https://github.com/samvera/active_fedora) | [![Build Status](https://circleci.com/gh/samvera/active_fedora.svg?style=svg)](https://circleci.com/gh/samvera/active_fedora) | | | 2.7.0 | 2.6.5 | | | 6.0.2 | 5.2.4 |
| [bixby](https://github.com/samvera/bixby) | [![Build Status](https://circleci.com/gh/samvera/bixby.svg?style=svg)](https://circleci.com/gh/samvera/bixby) | 3.1.1 | 3.0.3 | 2.7.5 | 2.6.9 | N/A | N/A | N/A | N/A |
| [browse-everything](https://github.com/samvera/browse-everything) | [![Build Status](https://circleci.com/gh/samvera/browse-everything.svg?style=svg)](https://circleci.com/gh/samvera/browse-everything) | | | 2.7.5 | 2.6.9 | | | 6.0.4.7 | 5.2.4 |
Expand All @@ -32,8 +34,13 @@ Currently, there are eighteen Samvera Core Components maintained by the communit
| [samvera.github.io](https://github.com/samvera/samvera.github.io) | [![Build Status](https://circleci.com/gh/samvera/samvera.github.io.svg?style=svg)](https://circleci.com/gh/samvera/samvera.github.io) | 3.1.1 | 3.0.3 | 2.7.5 | 2.6.9 | N/A | N/A | N/A | N/A |
| [samvera-circleci-orb](https://github.com/samvera/samvera-circleci-orb) | [![Build Status](https://circleci.com/gh/samvera/samvera-circleci-orb.svg?style=svg)](https://circleci.com/gh/samvera/samvera-circleci-orb) | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
| [valkyrie](https://github.com/samvera/valkyrie) | [![Build Status](https://circleci.com/gh/samvera/valkyrie.svg?style=svg)](https://circleci.com/gh/samvera/valkyrie) | | | 2.7.5 | 2.6.5 | | | 6.0.5 | 5.2.8 |
| [node-iiif](https://github.com/samvera/node-iiif) | [![Build Status](https://circleci.com/gh/samvera/node-iiif.svg?style=svg)](https://circleci.com/gh/samvera/node-iiif) | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
| [serverless-iiif](https://github.com/samvera/serverless-iiif) | [![Build Status](https://circleci.com/gh/samvera/serverless-iiif.svg?style=svg)](https://circleci.com/gh/samvera/serverless-iiif) | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |

### JavaScript Samvera Components

| Component | CircleCI Status | Node.js 18.x Support | Node.js 16.x Support | Node.js 14.x Support |
| ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -------------------- | -------------------- | -------------------- |
| [node-iiif](https://github.com/samvera/node-iiif) | [![Build Status](https://circleci.com/gh/samvera/node-iiif.svg?style=svg)](https://circleci.com/gh/samvera/node-iiif) | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
| [serverless-iiif](https://github.com/samvera/serverless-iiif) | [![Build Status](https://circleci.com/gh/samvera/serverless-iiif.svg?style=svg)](https://circleci.com/gh/samvera/serverless-iiif) | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |

## Maintenance Documentation

Expand Down
15 changes: 9 additions & 6 deletions ruby/RELEASES.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# Release Management for Ruby Core Components

## Semantic Versioning

Samvera Core Components follow the standards established by [the Semantic Versioning guidelines](https://semver.org/). As such, there are three possible types of releases supported:

- Patch (For example, 1.0.1 following 1.0.0)
- These releases do not introduce any changes which require an upgrade of any kind. These releases also do not include improvements or new features, but instead include security updates or software bug repairs.
- These releases do not introduce any changes which require an upgrade of any kind. These releases also do not include improvements or new features, but instead include security updates or software bug repairs.
- Minor (Example: 1.1.0 following 1.0.0)
- These releases do not introduce any changes which require an upgrade of any kind, and should never introduce any errors for applications or Gems which depend upon previous minor releases in latest major series (e. g. upgrading to 1.0.2 should never break Ruby applications and Gems which depend upon 1.0.1 or 1.0.0, however compatibility for releases prior to 1.0.0 is not guaranteed).
- These releases do not introduce any changes which require an upgrade of any kind, and should never introduce any errors for applications or Gems which depend upon previous minor releases in latest major series (e. g. upgrading to 1.0.2 should never break Ruby applications and Gems which depend upon 1.0.1 or 1.0.0, however compatibility for releases prior to 1.0.0 is not guaranteed).
- Major (Example: 2.0.0 following 1.0.0)
- These releases introduce changes which require an upgrade for Ruby applications and Gems which depend upon this Gem. As such, no support is strictly guaranteed for previous releases within the last major series of releases (e. g. 2.0.0 may not be compatible with releases 1.9.0 or 1.0.0).
- These releases introduce changes which require an upgrade for Ruby applications and Gems which depend upon this Gem. As such, no support is strictly guaranteed for previous releases within the last major series of releases (e. g. 2.0.0 may not be compatible with releases 1.9.0 or 1.0.0).

## Releasing a New Version (Patch, Minor, or Major)

Expand Down Expand Up @@ -82,10 +83,12 @@ Once this release is published, please ensure that this is **not** marked as a `

Once the previously mentioned tasks have been successfully completed, the final task is to inform the Samvera Community of the new Gem version release. This is achieved by submitting an e-mail message to the [samvera-tech Google Group](https://groups.google.com/g/samvera-tech). These is currenty no standardized format for these messages, however, one proposed format is the following:

*For the message subject:*
_For the message subject:_

> Announcing the Release of `$COMPONENT` 3.4.1
*For the message body:*
_For the message body:_

> Greetings Members of Samvera,
>
> The 3.4.1 release for `$COMPONENT` is now published and available for community adoption:
Expand All @@ -99,4 +102,4 @@ Once the previously mentioned tasks have been successfully completed, the final
One may provide any new features or updates within the message body which have substantial impact on the Gem, as well as any significant repairs for software bugs.

Following the submission of this message, the release process has been completed. Should there be any questions or requests for improvements to this document, please do not hesitate to [create an issue for this repository](https://github.com/samvera/maintenance/issues).
Following the submission of this message, the release process has been completed. Should there be any questions or requests for improvements to this document, please do not hesitate to [create an issue for this repository](https://github.com/samvera/maintenance/issues).

0 comments on commit 3ec1335

Please sign in to comment.