Skip to content
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

docs: update readme with new release strategy #458

Merged
merged 1 commit into from
Nov 30, 2023

Conversation

derberg
Copy link
Member

@derberg derberg commented Nov 30, 2023

adding one missing thing to #421

so yeah, I noticed @jonaslagoni already prepared migration guide that describes new strategy -> https://github.com/asyncapi/spec-json-schemas/pull/421/files#diff-f56fedd975b2d5e7e325bfbf9d75a3a1b6483a143e59ac341e9f1d1d9144a2f1

this PR just makes sure we have proper info in readme.

for reviewers:
in readme it looks like a lot of changes but only because I refactored to get rid of too many bullet points, so the only new section is really

### Releases and pre-releases

This repository contains JSON Schema files for official AsyncAPI releases and also for release candidates. Before you decide to use a specific JSON Schema file in production, make sure a corresponding [official release of AsyncAPI specification](https://github.com/asyncapi/spec/releases) is produced, not a release candidate.

JSON Schema which describes a version of AsyncAPI specification that is not yet officially released is considered an unstable pre-release that can change anytime and is not considered to be a breaking-change.

If you want to make sure you only use stable schemas, you have to make sure that you use only certain schema versions, not all by default.

Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

Copy link
Member

@fmvilas fmvilas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@derberg
Copy link
Member Author

derberg commented Nov 30, 2023

/rtm

@asyncapi-bot asyncapi-bot merged commit f9fc80f into asyncapi:next-major-spec Nov 30, 2023
20 checks passed
@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 6.0.0-next-major-spec.17 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants