-
Notifications
You must be signed in to change notification settings - Fork 3
Document schemas versioning policy #60
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.
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
Open
vuillaut
wants to merge
3
commits into
main
Choose a base branch
from
versioning
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,66 @@ | ||
| # Everse metadata schemas | ||
| A repository to describe metadata schemas used in the EVERSE project. | ||
|
|
||
| Most of these schemas will reuse existing vocabularies. | ||
| Most of these schemas will reuse existing vocabularies. | ||
|
|
||
| ## Versioning & Release Policy | ||
|
|
||
| This repository uses **Independent Semantic Versioning** for each schema. This means the `software` schema and the `indicators` schema have their own version numbers and release cycles. | ||
|
|
||
| ### 1. Versioning logic | ||
|
|
||
| We follow [SemVer 2.0.0](https://semver.org/) convention. | ||
|
|
||
| ### 2. Directory structure | ||
|
|
||
| To ensure stable URLs, we maintain the following structure: | ||
|
|
||
| ```text | ||
| /schemas | ||
| /[schema-name] | ||
| /v1.0.0 <-- Immutable snapshot of version 1.0.0 | ||
| /v1.1.0 <-- Immutable snapshot of version 1.1.0 | ||
| /latest <-- A copy of the most recent stable version | ||
| ``` | ||
|
|
||
| > **Note on `latest`:** The `latest` directory is what our `w3id.org` persistent identifiers point to. It must always be kept in sync with the highest stable version. | ||
|
|
||
|
|
||
| ### 3. Developing and releasing a new schema version | ||
| (for maintainers) | ||
|
|
||
|
|
||
| Changes to the schemas are made in the `dev` directories. **NEVER** modify a previous version (e.g. `schemas/software/v0.1.0`) directory. | ||
|
|
||
| Follow these steps to release a a new version (e.g., updating the `software` schema from `v1.1.0` to `v1.2.0`). | ||
|
|
||
| 1. Copy the contents of `dev` into the `latest` folder and into `v1.2.0` folder: | ||
| ```bash | ||
| cp -r schemas/software/dev schemas/software/latest | ||
| cp -r schemas/software/dev schemas/software/v1.2.0 | ||
| ``` | ||
|
|
||
| > Note: the `latest` directory ensures that anyone pointing to `https://w3id.org/everse/rs` immediately gets the new (latest) version of the schema. | ||
|
|
||
|
|
||
| 2. Commit your changes: | ||
| ```bash | ||
| git add schemas/software/latest | ||
| git add schemas/software/v1.2.0 | ||
| git commit -m "software release v1.2.0"` | ||
| ``` | ||
|
|
||
| 3. Create a **prefixed git tag**. This is crucial for independent releases: | ||
| ```bash | ||
| git tag -a software/v1.2.0 -m "Release software schema v1.2.0" | ||
| git push origin software/v1.2.0 | ||
| ``` | ||
|
|
||
|
|
||
| 4. Create the GitHub Release | ||
|
|
||
| - Go to the **Releases** section of the repository. | ||
| - Draft a new release and select the tag `software/v1.2.0`. | ||
| - Title the release: `Software Schema v1.2.0`. | ||
| - Include a brief changelog of what was added or changed. | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This above is not technically true. I will update when I have a bit more time
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note that the
/latestdirectories are introduced in this PR.I will create them if you agree with the proposal.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would not create /latest, as it implies maintaining things in 2 places.
We have the dev version for changes that are untested/ongoing.
Latest is always redirected to the last version (e.g., 0.0.2 at the moment)
We do not add the "v" in the name.