Skip to content

Commit

Permalink
doc: grammar / spelling
Browse files Browse the repository at this point in the history
Signed-off-by: Paul Horton <[email protected]>

- Minor edits based on PR feedback

- adding reference to VERS
  • Loading branch information
madpah authored and oej committed Feb 11, 2025
1 parent 990d66e commit 17c219d
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions tea-leaf/tea-leaf.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# The TEA Leaf Object (TLO)

_Work in progress_

The TEA LEAF is the object that indicates a product version. The API should be
very agnostic as to how a "version" is indicated - semver, vers, name, hash or anything else.

Expand All @@ -20,14 +18,15 @@ a timestamp for a release is required.
- __Product name__: A text field
- __Product version__: A text field, no required syntax
- __Release date__: A unix timestamp
- __Pre-Release__: A boolean flag indicating a pre-release (beta, rc)
- __Pre-release__: A boolean flag indicating a pre-release (beta, rc)
- __Tco_uuid__: A reference to the TEA Collection objet for this release

## Handling the Pre-Release flag

The Pre-Release flag is used to indicate that this is not a final release. For a given Leaf with a UUID, the flag
can be set to indicate a "test", "beta", "alfa" or similar non-deployed release. It can only be set when
creating the LEAF. The TEA implementation may allow it to be unset (False) once. This is to support
The "Pre-release" flag is used to indicate that this is not a final release.
For a given Leaf with a UUID, the flag can be set to indicate a "test", "beta", "alpha"
or similar non-deployed release. It can only be set when creating the LEAF. The TEA implementation
may allow it to be unset (False) once. This is to support
situations where a object is promoted as is after testing to production version. The flag can not
be set after initial creation and publication of the leaf.

Expand All @@ -36,4 +35,5 @@ a new leaf with a new UUID and version needs to be created.

## References

- Semantic versioning (Semver): <https://semver.org>
- Semantic versioning (Semver): <https://semver.org>
- PURL VERS <https://github.com/package-url/purl-spec/blob/master/VERSION-RANGE-SPEC.rst>

0 comments on commit 17c219d

Please sign in to comment.