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

package spec validation of changelog changes.link field is ineffective #1804

Open
efd6 opened this issue Apr 29, 2024 · 0 comments
Open

package spec validation of changelog changes.link field is ineffective #1804

efd6 opened this issue Apr 29, 2024 · 0 comments

Comments

@efd6
Copy link
Contributor

efd6 commented Apr 29, 2024

The validation for the changelog changes.link field requires that the pull request link be a positive integer. This check is performed during an elastic-package build run, erroring and refusing to complete when this is not the case. The consequence of this is that during package development a spec-valid placeholder must be put in place to allow the build to complete. The social consequence of this is that this valid placeholder can be forgotten during development and review, resulting in the semantically invalid, but syntactically valid value in the field. Thus the check is ineffective.

The elastic-package check subcommand also checks this (as an implementation detail, the way this happens is by calling build where the check ultimately happens, so disentangling them is less simple than it could be). Since this command is not required to build a package, but is run in CI, putting the validation checks in this subcommand and not in the build subcommand would ensure that the validations are not missed during CI and are not intentionally circumvented by devs in order to get a build to work.

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

No branches or pull requests

1 participant