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

Cut over to aspire-9.0 schema. #6596

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

mitchdenny
Copy link
Member

@mitchdenny mitchdenny commented Nov 3, 2024

Description

Updating the schema to aspire-9.0. Just a rename of everything.

Fixes #6581

Checklist

  • Is this feature complete?
    • Yes. Ready to ship.
    • No. Follow-up changes expected.
  • Are you including unit tests for the changes and scenario tests if relevant?
    • Yes
    • No
  • Did you add public API?
    • Yes
      • If yes, did you have an API Review for it?
        • Yes
        • No
      • Did you add <remarks /> and <code /> elements on your triple slash comments?
        • Yes
        • No
    • No
  • Does the change make any security assumptions or guarantees?
    • Yes
      • If yes, have you done a threat model and had a security review?
        • Yes
        • No
    • No
  • Does the change require an update in our Aspire docs?

@@ -5,5 +5,5 @@ namespace Aspire.Hosting.Utils;

internal static class SchemaUtils
{
public const string SchemaVersion = "https://json.schemastore.org/aspire-8.0.json";
public const string SchemaVersion = "https://json.schemastore.org/aspire-9.0.json";
Copy link
Member

@eerhardt eerhardt Nov 4, 2024

Choose a reason for hiding this comment

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

Should this go into the release/9.0 branch for our first servicing?

Copy link
Member Author

Choose a reason for hiding this comment

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

Need to discuss strategy here with @davidfowl, @vhvb1989, and @ellismg

Copy link
Member

Choose a reason for hiding this comment

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

It's unfortunate that using the 9.0.0 bits today, can produce a manifest that doesn't conform to the schema it says it conforms to. For example:

  1. Call the PublishAsAzureContainerApp method
  2. This will produce a manifest that points to https://json.schemastore.org/aspire-8.0.json and also has project.v1, which isn't valid for that schema version.

Our playground app does this today:

"$schema": "https://json.schemastore.org/aspire-8.0.json",

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah so there are two approaches we can take here. We can update the -8.0 schema on schema store with the one we have in our repo and just not bump the version, or we can ship a -9.0 schema and make sure it works everywhere.

Copy link
Member

Choose a reason for hiding this comment

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

I'd assume bumping the version is the "right" thing to do. It doesn't really make sense to add things and not change the version. Because what's the point of versioning it then?

Copy link
Member

Choose a reason for hiding this comment

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

It can be done dynamically

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.

Publish 9.0 Aspire schema to schema store
3 participants