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

Support versioning of Meshery designs #10889

Open
Yashsharma1911 opened this issue May 7, 2024 · 3 comments
Open

Support versioning of Meshery designs #10889

Yashsharma1911 opened this issue May 7, 2024 · 3 comments
Labels
component/server component/ui User Interface go Pull requests that update Go code issue/design required Functional architecture issue/willfix This issue will be worked on kind/epic An issue that describes a set of concerns (issues) kubernetes
Milestone

Comments

@Yashsharma1911
Copy link
Contributor

Yashsharma1911 commented May 7, 2024

Current Behavior

Meshery designs are not automatically versioned by Meshery Server.

Desired Behavior

General Description

  • Update Meshery server and pattern engine to support Meshery design versioning.
  • Update UI to allow users to perform actions related to design versioning.
  • Document changes made in pattern engine and server.

Specific Requirements

  1. The minimum viable feature here is simply a semver-compliant version number.
  2. The version number should be auto-incremented each time the design is saved (updated).
  3. The version number should not be incremented upon import, but a version, e.g. v0.0.1, assigned if none is present.
  4. The version number should not be incremented upon export.
  5. The version number should be displayed, but not editable (should be read-only).

Implementation

  1. [Server] ....
  2. [UI] ...

Recommended Skills:

Golang, Kubernetes, Meshery, Familiarity with Helm charts and Artifact Hub, familiarity with React, Nextjs would be helpful

Future enhancement:

  1. The version number may not be edited, in Meshery UI so long as the number supplied is validated semver-compliant and does not regress in numbering.

Acceptance Tests

  1. Upon export with existing version...
  2. Upon export with no existing version...
  3. Upon import with existing version...
  4. Upon import with no existing version...
  5. ....

Mockups


Contributor Guides and Handbook

@Yashsharma1911 Yashsharma1911 added kind/enhancement Improvement in current feature issue/willfix This issue will be worked on kubernetes go Pull requests that update Go code labels May 7, 2024
@leecalcote leecalcote added component/ui User Interface kind/epic An issue that describes a set of concerns (issues) component/server and removed kind/enhancement Improvement in current feature labels May 7, 2024
Copy link

github-actions bot commented May 7, 2024

This issue has been labeled with 'component/ui'. 🧰 Here are docs on Contributing to Meshery UI. 🎨 Here is the Meshery UI Figma File File. Lastly, here are docs on Contributing to Meshery's End-to-End Tests Using Cypress.


        Be sure to join the community, if you haven't yet and please leave a ⭐ star on the project 😄

@leecalcote
Copy link
Member

leecalcote commented May 7, 2024

I marked this as an epic. Depending upon who works on this, it'll need child issues created. It'll also need a design spec to include the following along with other considerations:

  1. The minimum viable feature here is simply a semver-compliant version number.
  2. The version number should be auto-incremented each time the design is saved (updated).
  3. The version number should not be incremented upon import, but a version, e.g. v0.0.1, assigned if none is present.
  4. The version number should not be incremented upon export.
  5. The version number should be displayed, but not editable (should be read-only).

Future enhancement:

  1. The version number may not be edited, in Meshery UI so long as the number supplied is validated semver-compliant and does not regress in numbering.

Edit: I updated the description to include this information.

@leecalcote leecalcote added the issue/design required Functional architecture label May 7, 2024
@leecalcote leecalcote added this to the v0.9.0 milestone May 7, 2024
Copy link

github-actions bot commented May 7, 2024

This issue has been labeled with 'design-required'. Note that prior to commencing on implementation, a design specification needs to be created and reviewed for approval. See Creating a Functional Specification to create a design spec.


        Be sure to join the community, if you haven't yet and please leave a ⭐ star on the project 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component/server component/ui User Interface go Pull requests that update Go code issue/design required Functional architecture issue/willfix This issue will be worked on kind/epic An issue that describes a set of concerns (issues) kubernetes
Projects
None yet
Development

No branches or pull requests

2 participants