New changelog versions validation check by mrodm · Pull Request #808 · elastic/package-spec

mrodm · 2024-10-01T17:31:48Z

What does this PR do?

Add a new validation check to ensure that the first (newer) changelog entry defined in the changelog file is not lower than the other versions.

Example of PR releasing an old version: elastic/integrations#10800

Why is it important?

Ensure that it is not released a older version. Releasing an older version should be performed through another mechanism.

Checklist

I have added test packages to test/packages that prove my change is effective.
I have added an entry in spec/changelog.yml.

Related issues

mrodm · 2024-10-01T17:38:08Z

test integrations

elastic-vault-github-plugin-prod · 2024-10-01T17:43:59Z

Created or updated PR in integrations repository to test this version. Check elastic/integrations#11304

mrodm · 2024-10-02T07:21:25Z

code/go/internal/validator/semantic/validate_version_integrity_test.go

+			"changelog next version manifest older version",
+			"1.0.0",
+			[]string{
+				"1.1.0-next",
+				"1.0.1",
+				"1.0.0",
+			},
+			false,


This test case shows the current behaviour when using next versions in changelog (but not in manifest).
Here, the manifest version 1.0.0 is not the latest stable 1.0.1.
Should this be allowed? Or, should it be revisited this code? @jsoriano

I think this would be a different change, and not sure if we want to be strict on that. We can keep it as is now.

Ok, let's keep it as is 👍

jsoriano

LGTM, only a couple of nits

jsoriano · 2024-10-02T17:01:01Z

code/go/internal/validator/semantic/validate_version_integrity_test.go

+			"changelog next version manifest older version",
+			"1.0.0",
+			[]string{
+				"1.1.0-next",
+				"1.0.1",
+				"1.0.0",
+			},
+			false,


I think this would be a different change, and not sure if we want to be strict on that. We can keep it as is now.

code/go/internal/validator/semantic/validate_version_integrity.go

mrodm · 2024-10-03T08:24:07Z

Just as a note, this new validation rule will affect all packages independently of their
package spec version or package type @jsoriano

With the latest execution of "test integrations" , there were two packages that would fail "aws" and "network_traffic".

I'll check which packages running "test integrations" once more.

mrodm · 2024-10-03T08:25:38Z

test integrations

elastic-vault-github-plugin-prod · 2024-10-03T08:31:04Z

Created or updated PR in integrations repository to test this version. Check elastic/integrations#11304

elasticmachine · 2024-10-03T08:35:49Z

💚 Build Succeeded

Buildkite Build
Commit: 02800e4

History

💚 Build #836 succeeded e83f94f
💚 Build #835 succeeded 7650b1d
💔 Build #834 failed 40766d1

cc @mrodm

mrodm · 2024-10-03T09:18:02Z

Currently these are the packages failing due to package-spec related errors:

aws: new version check
network_traffic: new version check
elastic_connectors: missing new fields

Build: https://buildkite.com/elastic/integrations/builds/16755

jsoriano · 2024-10-03T10:16:55Z

aws: new version check

network_traffic: new version check

I guess these can be solved by fixing the order in the changelog? I think it would be fine to do that when we update elastic-package in integrations.

elastic_connectors: missing new fields

Not related to this PR (but to #801), and this is known by the package owners, to be fixed when updating elastic-package.

I think we can go on with this change.

jsoriano · 2024-10-03T10:18:07Z

There is already a PR open to fix AWS changelog elastic/integrations#11307

mrodm · 2024-10-03T11:08:53Z

aws: new version check

network_traffic: new version check

I guess these can be solved by fixing the order in the changelog? I think it would be fine to do that when we update elastic-package in integrations.

In case for instance of network_traffic, it has this version as the least 1.31.1, and the second one is 1.32.0. If it is re-ordered, 1.32.0 would have less changes/"code" than 1.31.1 version.

Another option would be to release a new version 1.32.1 with the same contents as 1.31.1. Not sure what it could be set in the changelog entry for this. Probably the same data as in 1.31.1?

jsoriano · 2024-10-03T12:15:37Z

Another option would be to release a new version 1.32.1 with the same contents as 1.31.1. Not sure what it could be set in the changelog entry for this. Probably the same data as in 1.31.1?

Yes, actually 1.32.0 will be "reverting" the change in 1.31.1.
This was actually asked after merging. elastic/integrations#10800 (comment)

The changelog could be fixed to something like this:

- version: "1.32.1"
  changes:
    - description: Add `event.module` to datastreams
      type: bugfix
      link: https://github.com/elastic/integrations/pull/10800
- version: "1.32.0"
  changes:
    - description: `event.module` is not included in datastreams, this is an unexpected regression.
      type: breaking-change
      link: https://github.com/elastic/integrations/pull/10800
- version: "1.31.1"
  changes:
    - description: Add `event.module` to datastreams
      type: bugfix
      link: https://github.com/elastic/integrations/pull/10800
    - description: Set `map_to_ecs` to enabled by default
      type: enhancement
      link: https://github.com/elastic/integrations/pull/10785

jsoriano · 2024-10-03T12:26:21Z

PR open with the change I am propossing for network traffic: elastic/integrations#11322

mrodm added 4 commits October 1, 2024 19:23

Add new validation check for changelog versions

9373de2

Add changelog entry

e6d2b17

Create new test file

41771eb

Add more tests

e3e1f1e

mrodm self-assigned this Oct 1, 2024

mrodm added 2 commits October 1, 2024 19:32

Add changelog entry

dd1fb1d

Move changelog link tests to another file

563f691

elastic-vault-github-plugin-prod bot mentioned this pull request Oct 1, 2024

Test branch package-spec#808 - DO NOT MERGE elastic/integrations#11304

Closed

Add another test

7650b1d

mrodm force-pushed the new-changelog-validation-check branch from 40766d1 to 7650b1d Compare October 1, 2024 17:44

mrodm commented Oct 2, 2024

View reviewed changes

Add test with changelog and manifest next version

e83f94f

mrodm marked this pull request as ready for review October 2, 2024 10:17

mrodm requested a review from a team as a code owner October 2, 2024 10:17

mrodm changed the title ~~New changelog validation check~~ New changelog versions validation check Oct 2, 2024

jsoriano previously approved these changes Oct 2, 2024

View reviewed changes

Apply review suggestions

02800e4

mrodm dismissed jsoriano’s stale review via 02800e4 October 3, 2024 08:22

jsoriano mentioned this pull request Oct 3, 2024

Fix changelog in network traffic elastic/integrations#11322

Merged

jsoriano approved these changes Oct 3, 2024

View reviewed changes

mrodm merged commit 75d27d8 into elastic:main Oct 3, 2024

mrodm deleted the new-changelog-validation-check branch October 3, 2024 15:37

Conversation

mrodm commented Oct 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Why is it important?

Checklist

Related issues

Uh oh!

mrodm commented Oct 1, 2024

Uh oh!

elastic-vault-github-plugin-prod bot commented Oct 1, 2024

Uh oh!

mrodm Oct 2, 2024

Choose a reason for hiding this comment

Uh oh!

jsoriano Oct 2, 2024

Choose a reason for hiding this comment

Uh oh!

mrodm Oct 3, 2024

Choose a reason for hiding this comment

Uh oh!

jsoriano left a comment

Choose a reason for hiding this comment

Uh oh!

jsoriano Oct 2, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mrodm commented Oct 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mrodm commented Oct 3, 2024

Uh oh!

elastic-vault-github-plugin-prod bot commented Oct 3, 2024

Uh oh!

elasticmachine commented Oct 3, 2024

💚 Build Succeeded

History

Uh oh!

mrodm commented Oct 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jsoriano commented Oct 3, 2024

Uh oh!

jsoriano commented Oct 3, 2024

Uh oh!

mrodm commented Oct 3, 2024

Uh oh!

jsoriano commented Oct 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jsoriano commented Oct 3, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mrodm commented Oct 1, 2024 •

edited

Loading

mrodm commented Oct 3, 2024 •

edited

Loading

mrodm commented Oct 3, 2024 •

edited

Loading

jsoriano commented Oct 3, 2024 •

edited

Loading