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

Should the metadata schema be versioned? #3

Open
dhimmel opened this issue Jan 29, 2020 · 2 comments
Open

Should the metadata schema be versioned? #3

dhimmel opened this issue Jan 29, 2020 · 2 comments

Comments

@dhimmel
Copy link
Collaborator

dhimmel commented Jan 29, 2020

It would probably be good to have a way of versioning the metadata schema. This way, metadata could specify which version of the metadata schema it corresponds to. Programs could use this to issue warnings for unsupported versions. It also would more easily allow backwards incompatible changes.

I know Pandoc has semantic versioning for its executables as well as its AST format, right? @tarleb did you have anything in mind for versioning?

@tarleb
Copy link
Member

tarleb commented Jan 29, 2020

I know Pandoc has semantic versioning for its executables as well as its AST format, right?

Yes, pandoc and pandoc-types are versioned using Package Versioning Policy for Haskell libraries. People accustomed to semver find this irritating at times.

I haven't put much thought into versioning yet. Since I expect the project to be mostly independent from pandoc, my first instinct is to use semver. But I don't have strong feelings either way.

@dhimmel
Copy link
Collaborator Author

dhimmel commented Jan 31, 2020

Yes, pandoc and pandoc-types are versioned using Package Versioning Policy for Haskell libraries. People accustomed to semver find this irritating at times.

According to this page, the main superficial difference is:

  • PVP: MAJOR.MAJOR.MINOR.PATCH
  • SemVer: MAJOR.MINOR.PATCH

Since I expect the project to be mostly independent from pandoc, my first instinct is to use semver.

Sounds good to me. Fewer components is probably better. No strong opinion besides that we think about versioning early on such that we can provide a safe way for us to make changes in the future without inconveniencing users or breaking software.

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

No branches or pull requests

2 participants