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

Add missing documentation on merging #771

Closed
7 tasks done
jpmckinney opened this issue Nov 27, 2018 · 1 comment · Fixed by #810
Closed
7 tasks done

Add missing documentation on merging #771

jpmckinney opened this issue Nov 27, 2018 · 1 comment · Fixed by #810
Assignees
Labels
Focus - Merging Relating to the creating of compiled releases and versioned releases
Milestone

Comments

@jpmckinney
Copy link
Member

jpmckinney commented Nov 27, 2018

I don't see where in the documentation the following OCDS Merge behaviors are prescribed:

@kindly Did I miss these somewhere?

  • As part of this we can clarify precedence, i.e. that omitWhenMerged precedes all other rules.
@jpmckinney jpmckinney added the Focus - Merging Relating to the creating of compiled releases and versioned releases label Nov 27, 2018
@jpmckinney jpmckinney modified the milestones: 1.1.x Clarifications, 1.1.4 Nov 27, 2018
@kindly
Copy link
Contributor

kindly commented Dec 6, 2018

@jpmckinney

I don't see where in the documentation the following OCDS Merge behaviors are prescribed:

* The `id` of the compiledRelease is the `id` of the latest release
* The `date` of the compiledRelease is the `date` of the latest release

There was never a rule for these and has been undefined behaviour. The docs say it should be removed but they can not be removed as compiledRelease used the same schema as release. #330 will help with this.

* The `tag` of the compiledRelease is `["compiled"]` #770
* The `ocid` of the versionedRelease is not versioned (only specified in schema)

This looks like the behaviour we want but was not aware it was not documented

* The `tag` of the versionedRelease is omitted #770

This is true of omitWhenMerged

* If a value in a release is the same as in its preceding release, don't add a versioned object

Yes that should be documented

@kindly Did I miss these somewhere?

I do not think you have.

As part of this we can clarify precedence, i.e. that omitWhenMerged precedes all other rules.

Yes sounds good to me but I think we need #330

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Focus - Merging Relating to the creating of compiled releases and versioned releases
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants