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

Polywrap project manifest schema refactor #1091

Merged
merged 22 commits into from
Aug 20, 2022

Conversation

pileks
Copy link
Contributor

@pileks pileks commented Aug 2, 2022

Partially closes #1057

This PR performs the 1st steps of the refactor of the Polywrap project manifest files (wasm, interface, plugin, app).

Things to note:

  • The loading of polywrap.app.yaml, polywrap.plugin.yaml etc. have been left as such for backwards compatibility.
    • We might want to consider a CLI command to migrate the YAML files to the latest format version, instead of just reading them and migrating them upwards. Opening an issue seems like a good idea - any thoughts/concerns?
    • Create an issue for a polywrap manifest CLI command, with option for migrating the manifest to the latest version
  • It has been decided to use major.minor.patch versioning (as per semver) instead of just major.minor for now - this allows us to circumvent the yaml parser from reading format: 0.2 as a number and forcing us to use format: “0.2”
  • Important: All manifest files within the project have been left on version 0.1 for the time being in order to keep builds working with the existing polywrap CLI pulled from npm. I advise we leave them as such until we publish a version of the CLI wich supports the 0.2.0 project manifest format.
    • Explicitly test migrations
    • Move test manifests to 0.2.0

@pileks pileks changed the title Polywrap manifest schema refactor Polywrap project manifest schema refactor Aug 2, 2022
@pileks pileks linked an issue Aug 17, 2022 that may be closed by this pull request
@pileks
Copy link
Contributor Author

pileks commented Aug 18, 2022

Seems like we've got a conflict as there's a new version of the polywrap manifest (0.2).

I'll move the manifests in this PR to version 0.3 (or maybe even 1.0 as there are breaking changes?) and include anything I missed from 0.2

@cbrzn
Copy link
Contributor

cbrzn commented Aug 18, 2022

I would suggest bumping to 0.3

@dOrgJelli dOrgJelli requested a review from ramilexe as a code owner August 20, 2022 00:03
@dOrgJelli
Copy link
Contributor

Hey @pileks, we actually want to use version 0.2.0 instead of creating another format version (0.3.0). The 0.2.0 you were getting conflicts with was still unreleased (only in origin-dev), so if we did 0.3.0 we would have bumped by 2 versions in one release.

@dOrgJelli dOrgJelli merged commit 37522a3 into origin-dev Aug 20, 2022
@dOrgJelli dOrgJelli deleted the pileks-polywrap-manifest-schema-refactor branch April 10, 2023 17:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refactor: Project + Extension Manifests
3 participants