Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Merge branch 'versionning_info' into 'master'
DEPENB-1270 - Add version and changelog files.

See merge request sassoftware/viya-ark!30
  • Loading branch information
kevinlinglesas committed Apr 17, 2019
2 parents 4b652fb + 14572c7 commit 75a1401
Show file tree
Hide file tree
Showing 2 changed files with 98 additions and 0 deletions.
53 changes: 53 additions & 0 deletions CHANGELOG.md
@@ -0,0 +1,53 @@
# Changelog for SAS Viya-ARK

<!-- LATEST RELEASE START -->
## Viya34-ark-1.1 - April 18, 2019

- **Summary**:
Adding descriptions of numbering scheme and changelog. Legacy branches replicated to this repo. Bug fixes.
- Issues addressed:
- DEPENB-1270 - Addition of the files [VERSIONS](VERSIONS.md) and [CHANGELOG](CHANGELOG.md)
- DEPENB-1633 - [README](README.md) updates. Replicated [viya-3.2](../../viya-3.2) & [viya-3.3](../../viya-3.3) legacy branches to this repo.
- DEPENB-1566 - Add package update available notifications to deployment report
- DEPENB-1637 - Pre-install playbook local check rejected LOCALE en_US.
- DEPENB-1664 - Deployment report playbook filename change and not creating report as root user.

<!-- LATEST RELEASE END -->

## Viya34-ark-1.0 - April 10, 2019

- **Summary**:
Minor fixes, and first release using the new numbering scheme.
- Issues addressed:
- DEPENB-1367 - Convert fail tasks to assert tasks for better user experience (https://github.com/sassoftware/virk/issues/57)

## v0.3 - April 10, 2019

- **Summary**:
Simple [fix](https://github.com/sassoftware/viya-ark/commit/c44bcf824aa3307fbc20594bda76739adb46b622) for an issue that shows up when using `--check` mode
- Issues addressed:
- [Issue with the LOCALE verification when run in --check mode](https://github.com/sassoftware/viya-ark/issues/2)

## v0.2 - March 29, 2019

- **Summary**:
Small improvements to the pre-requisite playbooks, addition of the Deployment Reporting tool, and multi-tenant support addition for the Viya Multi-Machine Services Utilities
- Issues addressed:
- DEPENB-1370 - Added locale checking to the pre-req playbook.
- DEPENB-1551 - yum_repo check now checks for correct return value
- New Functionality/Products
- DEPENB-842 - Deployment reporting tool playbook added.
- DEPENB-1132 - MMSU now has multi-tenant support.

## v0.1 - March 8, 2019

- **Summary**:
Initial code push, from older "virk" project
- Issues addressed:
- DEPENB-1362 - Version Check of systemd was not reflective of documentation.
- DEPENB-1366 - CAS Resource Mgmt needed additional packages.
- DEPENB-1373 - Remove vi / va specific pre-install playbooks.
- DEPENB-1552 - Name of disable SELinux task was incorrect.
- DEPENB-1557 - Maximum Number of OS Tasks changes when running pre-install playbook with --check option
- DEPENB-1561 - Inconsistency between hostname length checking and actual hostname length.
- DEPENB-1392 - Validate hostname meets RFC952 criteria & SAS limitations
45 changes: 45 additions & 0 deletions VERSIONS.md
@@ -0,0 +1,45 @@
# Versions in SAS Viya-ARK

## Rationale for numbering

* Over time, SAS Viya-ARK will evolve
* possibly, some bugs need to be corrected
* maybe some new features are added
* a new version of SAS Viya is available, and SAS Viya-ARK needs to be updated
* For all these reasons, SAS Viya-ARK needs its own numbering scheme, distinct, and yet related to the Versions of SAS Viya itself
* Whenever you use SAS Viya-ARK, make sure that you know which version you are using
* If you are unsure, check what the version at the top of the [ChangeLog](CHANGELOG.md) is
* If you contact SAS or Open an [issue](https://github.com/sassoftware/viya-ark/issues), make sure to mention the exact version of SAS Viya-ARK you are using.

## Numbering scheme

* Example version
* the first "modern" version of Viya-ARK was called **Viya34-ark-1.0**
* `<viya_version>-ark-<first-digit>-<second-digit>`
* let's decompose that into its consituing parts:

| Viya34 | - | ark | - | 1 | . | 0 |
|-----------------------|----|---------|----|-------------------|---|----------------------|
| SAS Viya Version |dash| |dash| Major Version |dot| Minor Version |

* SAS Viya Version is an indicator of the **highest** version of SAS Viya that this has been tested with.
* Using Viya34-ark-X.X with a SAS Viya 3.5 deployment would likely **not** work.
* Using Viya35.ark-X.X with a SAS Viya 3.4 Deployment would likely **not** work.
* SAS Viya-ARK will not be backwards-compatible across SAS Viya Releases
* In other words, you should aim to use the latest realease of SAS Viya-ARK, as long as the ViyaXX portion matches the target software
* It will be impossible to have a version of SAS Viya-ARK that is backwards compatible with much older versions of SAS Viya, and attempting it would prevent a healthy development of SAS Viya-ARK
* `ark` is used as a starting marker to show that this is the actual version number of SAS Viya-ARK, not of SAS Viya
* The Major Version number will be incremented when:
* There are some major changes in SAS Viya itself, such as an Upgrade within a SAS Viya Version (e.g. SAS Viya 3.4 "May 2019 Upgrade" )
* There are major changes in SAS Viya-ARK itself, such as an important new feature
* The Minor Version number will be incremented when:
* a bug is fixed
* some code is replaced with equivalent code that does not really change the behavior
* small improvements are made, such as adding tags, spacing, etc..
* When the next release of SAS Viya is available, the digits are "reset":
* we might go from **Viya34-ark-5.2** to **Viya35-ark-1.0**
* Changes to the documentation (in the markdown files) will not necessarily trigger an incremnent in the version, as the documentation does not impact the way the softare runs.




0 comments on commit 75a1401

Please sign in to comment.