Skip to content

Commit

Permalink
Update instructions for semantic versioning (#115)
Browse files Browse the repository at this point in the history
## Description

Closes #116 

Shared Crypto now follows [semantic versioning](https://semver.org/).
The version number is incremented based on the type of changes made to
the shared crypto binaries. The version number is not tied to the
version of the underlying crypto provider.

Prior to adopting semantic versioning in the `1.0.0` release, the
version number followed a form of `YYYY.MM.PATCH`. The `1.0.0` release
was the first to use semantic versioning and proceeds any of those
versions.

- [ ] Impacts functionality?
- [ ] Impacts security?
- [ ] Breaking change?
- [ ] Includes tests?
- [x] Includes documentation?

## How This Was Tested

- CI

## Integration Instructions

- Following the release with this change semantic versioning will be
used. This change will be present in version `1.0.0`.

Signed-off-by: Michael Kubacki <[email protected]>
  • Loading branch information
makubacki authored Dec 13, 2024
1 parent f0b21fb commit 97eb41d
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
4 changes: 2 additions & 2 deletions .azuredevops/pipelines/ReleaseBuild.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ parameters:
type: boolean
default: false
- name: version_major_minor
displayName: Major and Minor Version
displayName: Major and Minor Version (semantic versioning)
type: string
default: 2023.02
default: 1.0
- name: version_patch
displayName: Patch Version (0-65535)
type: number
Expand Down
11 changes: 8 additions & 3 deletions CryptoBinPkg/Driver/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ the process.
"type": "nuget",
"name": "edk2-basecrypto-driver-bin",
"source": "https://pkgs.dev.azure.com/projectmu/mu/_packaging/Mu-Public/nuget/v3/index.json",
"version": "2023.2.9",
"version": "1.0.0",
"flags": ["set_build_var"],
"var_name": "BLD_*_SHARED_CRYPTO_PATH"
}
Expand Down Expand Up @@ -277,7 +277,7 @@ file.
MODULE_UNI_FILE = Crypto.uni
FILE_GUID = bdee011f-87f2-4a7f-bc5e-44b6b61f2D20
MODULE_TYPE = DXE_DRIVER
VERSION_STRING = 18.2023.12.3
VERSION_STRING = 18.1.0.0
PI_SPECIFICATION_VERSION = 0x00010032
ENTRY_POINT = CryptoDxeEntry
```
Expand All @@ -299,4 +299,9 @@ An example:
Currently, this indicates:
- The "EDK2 Crypto Version" is `18`. This is the version of the crypto protocol interface.
- The Shared Crypto build version is `2023.12.3`
- The Shared Crypto build version is `1.0.0`
- Note: Shared Crypto follows [semantic versioning](https://semver.org/). The version number is incremented based on
the type of changes made to the shared crypto binaries. The version number is not tied to the version of the
underlying crypto provider.
- Note: Prior to adopting semantic versinoning in the `1.0.0` release, the version number followed a form of
`YYYY.MM.PATCH`. The `1.0.0` release was the first to use semantic versioning and proceeds any of those versions.

0 comments on commit 97eb41d

Please sign in to comment.