[ODATA-1467] Keep a CHANGELOG.md, use Semantic Versioning for each vocabulary - OASIS Technical Committees Issue Tracker

XML

Word

Printable

Proposal:
Hide

Use Semantic Versioning for each of our vocabulary files and add a version number using annotation Core.SchemaVersion to the schema of each vocabulary

We may want to adapt the description of Core.SchemaVersion and also mention vocabularies in addition to services, or "abstract" to talk about schemas

Keep a Changelog in the repository root as a file CHANGELOG.md and mention all (interesting) changes there.

"Interesting" are all major changes (rename/remove stuff), and most of the minor changes (add new stuff), but probably not patches.
Show
Use Semantic Versioning for each of our vocabulary files and add a version number using annotation Core.SchemaVersion to the schema of each vocabulary We may want to adapt the description of Core.SchemaVersion and also mention vocabularies in addition to services, or "abstract" to talk about schemas Keep a Changelog in the repository root as a file CHANGELOG.md and mention all (interesting) changes there. "Interesting" are all major changes (rename/remove stuff), and most of the minor changes (add new stuff), but probably not patches.

We recently published a "breaking" change with https://github.com/oasis-tcs/odata-vocabularies/pull/127 - removing EntityContainer from the AppliesTo list of a term.

We claim that AppliesTo is only a recommendation, but some tools actually take this literally and do not apply terms to model elements not listed.

Independent of whether this was really a breaking change we should:

Use Semantic Versioning for each of our vocabulary files and add a version number using annotation Core.SchemaVersion to the schema of each vocabulary
- We may want to adapt the description of Core.SchemaVersion and also mention vocabularies in addition to services, or "abstract" to talk about schemas
Keep a Changelog in the repository root as a file CHANGELOG.md and mention all (interesting) changes there.
- "Interesting" are all major changes (rename/remove stuff), and most of the minor changes (add new stuff), but probably not patches.