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

Updates in anticipation of cnab-core-1.1.0 #388

Merged
merged 1 commit into from
Sep 28, 2020

Conversation

vdice
Copy link
Member

@vdice vdice commented Sep 17, 2020

Docs and other updates in anticipation of the forthcoming/proposed cnab-core-1.1.0 release.

The main spec change prompting this minor release is the following clarification: #287

Ref #387

@vdice vdice changed the title updates in anticipation of cnab-core-1.1.0 Updates in anticipation of cnab-core-1.1.0 Sep 17, 2020
@@ -5,7 +5,7 @@ weight: 001

# CNAB Specifications

1. [Cloud Native Application Bundle Core 1.0.0 (CNAB1)](100-CNAB.md)
1. [Cloud Native Application Bundle Core 1.1.0 (CNAB1)](100-CNAB.md)
Copy link
Member Author

Choose a reason for hiding this comment

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

Q: Does CNAB1 need to change?

Copy link
Contributor

Choose a reason for hiding this comment

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

I would prefer if we have CNAB mean the latest CNAB release of the version (i.e.: In this case, CNAB1 means CNAB 1.1.0) as I think that usually this is what people mean when they say version . If one wants to be more specific, they can do so by specifying the minor and patch versions as well.

If we choose to do this, we may need to clarify our process versioning.

@@ -13,7 +13,7 @@ The `bundle.json` file is a representation of bundle metadata. It MUST be repres

A `bundle.json` is broken down into the following categories of information:

- The schema version of the bundle, as a string with a `v` prefix. This schema is to be referenced as `v1` or `v1.0.0`
- The schema version of the bundle, as a string with a `v` prefix. This schema is to be referenced as `v1` or `v1.1.0`
Copy link
Member Author

Choose a reason for hiding this comment

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

I wasn't sure if all of these v1.0.0 references should be updated to v1.1.0 or not?

Copy link
Contributor

Choose a reason for hiding this comment

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

While the schema has not changed, it is versioned with the core of the spec so I think it should match that (i.e.: 1.1.0).


The CNAB Working Group with the joint approval of the Executive Directors has approved the CNAB Core 1.0 specification for publication. CNAB Core 1.0 is complete.
The CNAB Working Group with the joint approval of the Executive Directors has approved the CNAB Core 1.1.0 specification for publication. CNAB Core 1.1.0 is complete.
Copy link
Member Author

Choose a reason for hiding this comment

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

Should I have added an additional section rather than amending this one?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think amending here makes sense. We don't want to pollute the README over time with a release history.

Copy link
Member

Choose a reason for hiding this comment

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

Agree


### Branch/Tag Structure

- [master](https://github.com/cnabio/cnab-spec) is the current working draft of all specs
- [cnab-core-1.1.0](https://github.com/cnabio/cnab-spec/tree/cnab-core-1.1.0) is the CNAB Core 1.1.0 final draft
Copy link
Member Author

Choose a reason for hiding this comment

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

This tag is yet to be created; the intention is to cut the tag after this PR is approved, merged and included in the forthcoming cnab-core-1.1.0-ga branch. Ref ordering in #387

@vdice vdice mentioned this pull request Sep 17, 2020
4 tasks
Copy link
Contributor

@chris-crone chris-crone left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@technosophos technosophos left a comment

Choose a reason for hiding this comment

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

Sorry that it took me so long to review this, but it looks good as-is.

@vdice vdice merged commit 7cea2c2 into cnabio:master Sep 28, 2020
@vdice vdice deleted the cnab-core-1.1.0-updates branch September 28, 2020 21:47
@vdice
Copy link
Member Author

vdice commented Sep 30, 2020

@carolynvs @radu-matei @jlegrone Can we get your approval on this PR/CNAB Core 1.1.0 release?

The changelog prompting this minor release is:

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

Successfully merging this pull request may close these issues.

3 participants