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

Make Policy Template version mandatory #393

Open
bcpmihail opened this issue Aug 23, 2024 · 0 comments
Open

Make Policy Template version mandatory #393

bcpmihail opened this issue Aug 23, 2024 · 0 comments
Labels
area/vrotsc Relates to `vrotsc` module effort/low kind/enhancement Enhancement or improvement of existing features lang/typescript Related to typescript code triage/accepted The issue was accepted and will be done version/major Introduces a breaking change
Milestone

Comments

@bcpmihail
Copy link
Contributor

Description

Full support for the Policy Feature was introduced 2 via adding new attributes to the Policy Template:

  • templateVersion
  • elements
  • variables
    and makes the 'type' attribute obsolete.

To take advantage of these improvements, 'templateVersion': 'v2' is required.
However this can be easily missed as the attribute is optional and its value defaults to 'v1' (for backward compatibility).
To avoid missing on the new functionality or confusion with the available versions, the 'templateVersion' attribute needs to be made mandatory.

As the Policy Template attributes are validated, this will be a breaking change (affecting all Policies built), requiring Major version release for BTVA and for https://github.com/vmware-samples/build-tools-for-vmware-aria-samples, where the sample and base-package version need to be updated.

Additional Context

The issue is opened after discussion in:
#385

Introduction of full support for the Policy Feature:
#20

@bcpmihail bcpmihail added lang/typescript Related to typescript code area/vrotsc Relates to `vrotsc` module version/major Introduces a breaking change triage/needed Needs to be discussed by project maintainers kind/feature New Feature to the project labels Aug 23, 2024
@bcpmihail bcpmihail added this to the 3.0.0 milestone Aug 23, 2024
@VenelinBakalov VenelinBakalov added triage/accepted The issue was accepted and will be done kind/enhancement Enhancement or improvement of existing features effort/low and removed triage/needed Needs to be discussed by project maintainers kind/feature New Feature to the project labels Aug 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/vrotsc Relates to `vrotsc` module effort/low kind/enhancement Enhancement or improvement of existing features lang/typescript Related to typescript code triage/accepted The issue was accepted and will be done version/major Introduces a breaking change
Projects
None yet
Development

No branches or pull requests

2 participants