Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update versioning policy #1353

Merged
merged 1 commit into from
Nov 20, 2019
Merged

Update versioning policy #1353

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 35 additions & 16 deletions docs/technical-documentation/versioning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,51 @@
# Versioning Policy

Islandora 8 uses [semantic versioning](http://semver.org/), except for Drupal modules.
Islandora 8 uses semantic versioning, except for Drupal modules/themes.

## Components

### [Semantic Versioning](http://semver.org/)
## [Semantic Versioning](http://semver.org/)

**Major version** . **Minor version** . **Patch**

- **Major version**; Major changes, and breaks the API
- **Minor version**; New features, and does not break the API
- **Patch**; Bug fixes, and never breaks backward compatibility

Example: 1.2.3
Examples:

* `1.2.3 => 1.2.4` - Just a bug fix, should be a drop-in replacement.
* `1.2.3 => 1.3.0` - Adds in new features, should be a drop-in replacement to get new functionality.
* `1.2.3 => 2.0.0` - Major changes, may require a migration or changes to your set-up.

* [Alpaca](https://github.com/Islandora-CLAW/alpaca)
* [Chullo](https://islandora-claw.github.io/CLAW/chullo)
* [CLAW](https://github.com/Islandora-CLAW/CLAW)
* [Crayfish](https://islandora-claw.github.io/CLAW/Crayfish)
* [Crayfish Commons](https://islandora-claw.github.io/CLAW/Crayfish-Commons)
* [Syn](https://github.com/Islandora-CLAW/Syn)
The following Islandora 8 components use semantic versioning:

### [Drupal Contrib Versioning](https://www.drupal.org/docs/8/choosing-a-drupal-version/what-do-version-numbers-mean-on-contributed-modules-and-themes)
* [Alpaca](https://github.com/Islandora/Alpaca)
* [Chullo](https://github.com/Islandora/Chullo)
* [Crayfish](https://github.com/Islandora/Crayfish)
* [Crayfish Commons](https://github.com/Islandora/Crayfish-Commons)
* [Syn](https://github.com/Islandora/Syn)

## [Drupal Contrib Versioning](https://www.drupal.org/docs/8/choosing-a-drupal-version/what-do-version-numbers-mean-on-contributed-modules-and-themes)

**Core Compatibility** - **Major** . **PatchLevel[-Extra]**

Example: 8.x-1.1
Examples:

* `8.x-1.0 => 8.x-1.1` - Just a bug fix, should be a drop-in replacement.
* `8.x-1.0 => 8.x-2.0` - Major changes, could require a migration or changes to your set-up.

The `8.x-` part will not change to `9.x-` until Drupal 9.

The following Islandora 8 components use Drupal Contrib versioning:

* [carapace](https://github.com/Islandora/carapace)
* [controlled\_access\_terms](https://github.com/Islandora/controlled_access_terms)
* [drupal-project](https://github.com/Islandora/drupal-project)
* [islandora](https://github.com/Islandora/islandora/tree/8.x-1.x)
* [islandora_defaults](https://github.com/Islandora/islandora_defaults)
* [jsonld](https://github.com/Islandora/jsonld)
* [openseadragon](https://github.com/Islandora/openseadragon)

This list does *not* include sub-modules which share versions with their parents.

* [drupal-project](https://github.com/Islandora-CLAW/drupal-project)
* [islandora](https://github.com/Islandora-CLAW/islandora)
* [jsonld](https://github.com/Islandora-CLAW/jsonld)
ie.
[Islandora Audio](https://github.com/Islandora/islandora/tree/8.x-1.x/modules/islandora_audio), [Islandora IIIF](https://github.com/Islandora/islandora/tree/8.x-1.x/modules/islandora_iiif) and [Islandora Breadcrumbs](https://github.com/Islandora/islandora/tree/8.x-1.x/modules/islandora_breadcrumbs) are all sub-modules of Islandora and shares it's version.