rsmp-nordic / rsmp_schema

JSON Schema for automatically validating RSMP messages
MIT License
1 stars 0 forks source link

Version 1.1.1? #66

Closed emiltin closed 1 year ago

emiltin commented 1 year ago

Recent PRs was merged to master, e.g https://github.com/rsmp-nordic/rsmp_schema/pull/57/files.

Theses changes where done in the schemas/tlc/1.1/ folder, i.e. we're changing the 1.1 version of the SXL.

Is this correct to amend 1.1? Or should we move these changes to a new version e.g. 1.1.1?

Note also that the corresponding json schema has not been regenerated. Usually, when making changes to the source sxl.yaml file, you run rake regenerate to regenerate all the json schema files, and make that part of the PR, so the yaml and the jsons schema are kept in sync.

emiltin commented 1 year ago

In this repo, each version of the SXL is kept in a separate folder, rather than just rely on git branches. The reason is that this repo is also a ruby gem that can be used to validate messages, and you need all the different versions loaded at the same time, so you can check messages, regardless of version.

otterdahl commented 1 year ago

Most changes in the PRs were minor, often involving the description. But in general, i think it is wise to submit any changes to a new version. We can create schemas/tlc/1.1.1 when it's time to make any future changes. Since 1.1.1 isn't officially released yet, we can continue updating it until release.

emiltin commented 1 year ago

we can name the folder 1.2-draft, and work in that? then when we want to release, we can rename it e.g. 1.1.1 or 1.2?

emiltin commented 1 year ago

do we want to make changes to previous version? e.g. fix typos? or do we just leave them, and work on the latest?

if in favour of only working on the latest :-)

emiltin commented 1 year ago

we can name the folder 1.2-draft, and work in that? then when we want to release, we can rename it e.g. 1.1.1 or 1.2?

if we work in a branch (as w should), i guess we don't even need to use draft in the folder name.

otterdahl commented 1 year ago

Sure. Lets work in a branch instead

emiltin commented 1 year ago

i added a 1.1.1 banch, based off the latest master. it has a new schemas/tlc/1.1.1 folder, created as a copy of schemas/tlc/1.1. PRs should be made against the files in this new 1.1.1 folder