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.

Sign up for GitHub

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

Jump to bottom

[ModuleCatalog] Add .spec.info to ModuleTemplate #1841

Open
3 tasks done
c-pius opened this issue Sep 6, 2024 · 0 comments
Open
3 tasks done

[ModuleCatalog] Add .spec.info to ModuleTemplate #1841

c-pius opened this issue Sep 6, 2024 · 0 comments
Assignees
@ruanxin
Labels
API Denotes that an issue is tied to the potential change of the API kind/feature Categorizes issue or PR as related to a new feature.

Comments

@c-pius
Copy link
Contributor

c-pius commented Sep 6, 2024 •
edited by ruanxin
Loading

Description

In #1681 it has been decided to add information about the module to the ModuleTemplate. We need to update the ModuleTemplate to include this information.

The information shall look as follows:

spec:
  info:
    repository: <link>
    documentation: <link>
    icons:
    - name: <string>
      link: <link>

.spec.info is OPTIONAL (for compatibility reasons), but the individual entries are REQUIRED.

Reasons

Enables CLI and dashboard to show additional info about the module

Acceptance Criteria

  • .spec.info added to ModuleTemplate
  • Added an entry to Modularization API upgrade #776 that .spec.info must be added as required in a future major API version
  • Update documentation

Feature Testing

No response

Testing approach

No response

Attachments

No response
@c-pius c-pius added kind/feature Categorizes issue or PR as related to a new feature. API Denotes that an issue is tied to the potential change of the API labels Sep 6, 2024
@ruanxin ruanxin self-assigned this Sep 30, 2024
@ruanxin ruanxin mentioned this issue Sep 30, 2024
Closed
This was referenced Oct 1, 2024
Open
Open
@ruanxin ruanxin removed their assignment Oct 1, 2024
@ruanxin ruanxin mentioned this issue Oct 1, 2024
Open
11 tasks
@c-pius c-pius linked a pull request Oct 2, 2024 that will close this issue
feat: Add ModuleInfo as optional to ModuleTemplate #1906
Closed
@c-pius c-pius self-assigned this Oct 2, 2024
@lindnerby lindnerby assigned ruanxin and unassigned c-pius Oct 4, 2024
@ruanxin ruanxin mentioned this issue Oct 4, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ruanxin ruanxin

Labels
API Denotes that an issue is tied to the potential change of the API kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: Add ModuleInfo as optional to ModuleTemplate ruanxin/kyma-operator
2 participants
@ruanxin @c-pius