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 plugin deprecation info into registry index file #228

Merged
merged 1 commit into from
Sep 23, 2019
Merged

Conversation

mmorhun
Copy link
Contributor

@mmorhun mmorhun commented Sep 23, 2019

Signed-off-by: Mykola Morhun [email protected]

What does this PR do?

Adds deprecate section of plugin meta information into index.json file of the plugin registry.

If a plagin is not deprecated then nothing will be changed in current model.
If a plugin is deprecated then to its metadata in the registry index.json file will be added deprecate section, which is copy of deprecate section of the plugin meta.yaml file.
For example:

...
deprecate {
    "automigrate":  true,
    "migrateTo": "another_publisher/another_plugin_id:1.0.0"
},
...

This change is needed for dashboard to be able to display deprecation on a plugin and suggest auto migration. See eclipse-che/che#13021

@sleshchenko
Copy link
Member

It would be useful to see examples of script work in both cases - for non-deprecated and for deprecated plugins.

@sleshchenko
Copy link
Member

Also please consider changing index.json items model in README.md https://github.com/eclipse/che-plugin-registry#get-index-list-of-all-plugins

@mmorhun
Copy link
Contributor Author

mmorhun commented Sep 23, 2019

@sleshchenko I had described it in the description, but yes, an example would be even better.
Updated description.

@mmorhun
Copy link
Contributor Author

mmorhun commented Sep 23, 2019

As about readme, we have already described the deprecate section. It is just copied to index.json for such plugind, so no need in update.

@mmorhun mmorhun self-assigned this Sep 23, 2019
@sleshchenko
Copy link
Member

As about readme, we have already described the deprecate section. It is just copied to index.json for such plugind, so no need in update.

So, but README.md does not give any clue that deprecate is copied to index.json.
I still think that it would be better to paste example of deprecate section to index.json example.

@mmorhun
Copy link
Contributor Author

mmorhun commented Sep 23, 2019

@sleshchenko updated

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