feat: add --changelog flag to requires update command by teresaromero · Pull Request #3626 · elastic/elastic-package

teresaromero · 2026-06-01T13:28:48Z

Closes Automatically update package dependencies integrations#17404 (partially)

Summary

Extends requires update with two optional flags that automate changelog maintenance when bumping package dependencies:

elastic-package requires update [--changelog] [--changelog-type <type>]

--changelog — for each bumped dependency, appends one changelog entry to changelog.yml and bumps the package's own version in both changelog.yml and manifest.yml.
--changelog-type — overrides the inferred entry type for all generated entries (bugfix, enhancement, or breaking-change). Without this flag the type is inferred from the semver bump tier: major → breaking-change, minor/patch → enhancement.

When combined with --dry-run, nothing is written; the would-be new version and per-entry inferred types are printed instead.

How it works

Tier inference — each proposal's Current→Proposed semver delta determines its tier (TierMajor, TierMinor, TierPatch). Content-dependency constraints that can't be parsed as an exact version default to TierMinor.
Aggregate tier — the largest tier across all bumped proposals drives the package version bump (same major|minor|patch mode as changelog add --next <tier>).
Atomic write — all edits (manifest bytes + changelog bytes) are computed in memory and PatchYAML is validated before any file is written, so a failed patch leaves no partial state.
Placeholder link — every generated entry uses https://github.com/elastic/integrations/pull/REPLACE_ME as its link. The [automation] Add requires-update workflow integrations#19217 PR-opening workflow is expected to replace this token with the real PR URL. This is a contract — the literal value must be confirmed with that workflow before merge.
new_version in JSON output — Result.NewVersion is populated when --changelog bumps the version, making it available to automation via --format json.

Reviewer notes

Placeholder link contract — ChangelogPlaceholderLink (https://github.com/elastic/integrations/pull/REPLACE_ME) is a contract with the [automation] Add requires-update workflow integrations#19217 PR-opening workflow, which must search-and-replace this exact token with the real PR URL. The literal value is still proposed — needs confirmation with that workflow before merge.
Tier inference for content constraints — Current values that are semver constraints (e.g. ^0.3.0) cannot be diffed against Proposed; they default to TierMinor. This is a deliberate approximation since Masterminds/semver exposes no constraint floor.
Atomic write ordering — PatchYAML is validated in memory before either file is written. changelog.yml is written first, then manifest.yml. A failure after the first write but before the second would leave the files inconsistent; this was accepted as a low-probability edge case vs. the complexity of a two-phase commit.
Version divergence guard — the command errors if manifest.yml version differs from the changelog.yml top revision before applying changes. package-spec requires they agree; this protects against already-dirty packages.

Adds pure helpers to classify dependency bumps into semver tiers (patch/minor/major), aggregate tiers across proposals, map tiers to changelog entry types and --next mode strings, and a ChangelogPlaceholderLink constant. Adds Result.NewVersion for the command layer to populate. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Adds --changelog and --changelog-type flags to `elastic-package requires update`. When --changelog is set and there are bumps, the command runs two explicit steps: Apply (updates requires pins in manifest.yml) followed by ApplyChangelog (bumps the package version and adds one changelog entry per dependency in changelog.yml). The two steps remain separate so callers can invoke them independently. Domain logic (NextVersion, AssertManifestMatchesChangelogTop, BuildChangelogRevision, ApplyChangelog) lives in internal/requiresupdates; cmd/requires.go is a thin orchestration layer. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Documents the --changelog and --changelog-type flags for elastic-package requires update, including version bump tier logic, inferred vs overridden entry types, the placeholder link contract, dry-run and JSON output behaviour, and guard conditions. Also adds a godoc comment to changelogTypeChoices explaining that it mirrors the package-spec changelog entry type enum, with deprecation intentionally excluded for dependency-bump entries. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

NextVersionFromRevisions and NextVersion now live in the changelog package (the natural home for operations on Revision slices), removing the duplication between changelogCmdVersion and requiresupdates.NextVersion. cmd/changelog.go calls changelog.NextVersion directly; requiresupdates.NextVersion delegates via tier.NextMode(); ApplyChangelog reads changelog.yml once and calls changelog.NextVersionFromRevisions with the already-parsed revisions. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Table-driven TestApplyRequiresUpdate calls applyRequiresUpdate directly via t.TempDir() fixtures, covering inferred types, type override, major bump, multiple-dep aggregate tier, changelog-disabled path, and divergent-version error with no-file-write guarantee. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Updated the formatting of test cases in requires_test.go and changelog_test.go for improved readability. Adjusted spacing and alignment of struct fields to maintain consistency across the codebase. Minor adjustments made in changelog.go for clarity in the NextMode function. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

mrodm · 2026-06-05T10:11:25Z

+bumped the package version.
+
+**Guards.** The command refuses to proceed when the changelog top version and `manifest.yml`
+version disagree, or when the changelog top version is a pre-release. Proposals that are


According to this doc , the changelog is not added if the top version is a pre-release.

Just checked that there is this method in ApplyChangelog:

if err := assertManifestVersionMatchesChangelogTop(manifestBytes, revisions); err != nil { return nil, "", err }

Should this guard be added ? or is it managed already in another method?

i am being aware now that i was thinking on "prereleased" as "experimental" too.... and this might be an implementation gap. i think we should probably ignore changelog for prerelease (-suffix) but allow for experimental.

assertManifestVersionMatchesChangelogTop just checks the manifest is aligned with the changelog latest entry

mrodm · 2026-06-05T10:22:43Z

+	manifestBytes, err = changelog.SetManifestVersion(manifestBytes, next.String())
+	if err != nil {
+		return nil, "", err
+	}


Taking as a example elastic-package changelog command, changelog and manifest updates are separated.

elastic-package/cmd/changelog.go

Lines 98 to 106 in 6158fcd

err = patchChangelogFile(packageRoot, entry)

if err != nil {

return err

}

err = setManifestVersion(packageRoot, version)

if err != nil {

return err

}

What about moving the writing of the manifet out of the ApplyChangelog? So applyChangelog just updates changelog and not manifest ? That write could be done by requires.Apply.

mrodm · 2026-06-05T10:24:27Z

+			}
+		}
 	} else if applied {
 		cmd.Println("Updated manifest.yml")


If --changelog is set, this message should also indicate that changelog.yml has been updated.

mrodm · 2026-06-05T10:31:47Z

+	updateCmd.Flags().Bool(cobraext.RequiresChangelogFlagName, false, cobraext.RequiresChangelogFlagDescription)
+	updateCmd.Flags().String(cobraext.RequiresChangelogTypeFlagName, "", cobraext.RequiresChangelogTypeFlagDescription)


There is no documentation added for these 2 new flags here:

elastic-package/cmd/requires.go

Lines 35 to 40 in 6158fcd

requiresUpdateLongDescription = `Update requires.input and requires.content pins to the latest registry versions compatible with this package's Kibana constraint.

By default manifest.yml is updated. Use --dry-run to report available bumps without writing the manifest.

Version pins must be exact semver versions (constraints such as ^0.3.0 are not accepted).

When a newer dependency exists but requires a higher Kibana version than this package allows, a warning is printed suggesting to bump conditions.kibana.version on the integration package.`

mrodm · 2026-06-05T10:37:47Z

+// package is built and checked against the spec; this list enables early flag
+// validation. "deprecation" is intentionally excluded as it is not a valid type
+// for automated dependency-bump changelog entries.
+var changelogTypeChoices = []string{"bugfix", "enhancement", "breaking-change"}


Taking a look to this list, there is another place where these values are king of defined.

elastic-package/internal/cobraext/flags.go

Line 107 in 6158fcd

ChangelogAddTypeFlagDescription = "type of change (bugfix, enhancement or breaking-change) for the changelog entry"

I know that this is unrelated to tihs PR, but could you add deprecation there in the flag description?

I wonder if we could set the list in the description programmatically.

Added detailed descriptions for new flags in the `elastic-package requires update` command, including `--format`, `--prerelease`, `--changelog`, and `--changelog-type`. Clarified their usage and effects on output and version bumping behavior. Updated related documentation in `cmd/requires.go` and `docs/howto/dependency_management.md` for consistency and clarity.

Updated the changelog command to include a predefined list of changelog entry types for better validation. Adjusted the `--changelog-type` flag description in both `cmd/changelog.go` and `cmd/requires.go` to reflect the new choices. This change improves user guidance and ensures consistency across commands regarding changelog entry types.

Updated the `requiresUpdateCommandAction` function to print a message indicating when the `changelog.yml` file is updated, in addition to the existing manifest update message. This improvement provides clearer feedback to users regarding changes made during the update process.

Updated the `applyRequiresUpdate` function to improve the handling of changelog and manifest version updates. The `ApplyChangelog` function now only returns the new version string, while the manifest version is updated separately using `ApplyManifestVersion`. Additionally, introduced a new `ReadChangelogBytes` function to enhance the parsing of changelog data from raw bytes. This refactor enhances clarity and maintains atomicity in the update process.

elasticmachine · 2026-06-05T14:44:15Z

💚 Build Succeeded

Buildkite Build
Commit: aefb618

History

💛 Build #8107 was flaky f27a4ae
💔 Build #8106 failed bb45b33
💔 Build #8101 failed 494de88

teresaromero mentioned this pull request Jun 1, 2026

feat: add elastic-package requires update command to bump requires pins from the registry #3593

Merged

teresaromero and others added 5 commits June 2, 2026 11:12

teresaromero force-pushed the requires-update-command-changelog branch from 494de88 to bb45b33 Compare June 2, 2026 09:13

teresaromero marked this pull request as ready for review June 2, 2026 09:13

teresaromero requested a review from a team June 2, 2026 12:30

mrodm reviewed Jun 5, 2026

View reviewed changes

teresaromero added 4 commits June 5, 2026 14:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add --changelog flag to requires update command#3626

feat: add --changelog flag to requires update command#3626
teresaromero wants to merge 10 commits into
elastic:mainfrom
teresaromero:requires-update-command-changelog

teresaromero commented Jun 1, 2026 •

edited by mrodm

Loading

Uh oh!

mrodm Jun 5, 2026

Uh oh!

teresaromero Jun 5, 2026

Uh oh!

mrodm Jun 5, 2026

Uh oh!

mrodm Jun 5, 2026

Uh oh!

mrodm Jun 5, 2026

Uh oh!

mrodm Jun 5, 2026

Uh oh!

elasticmachine commented Jun 5, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	err = patchChangelogFile(packageRoot, entry)
	if err != nil {
	return err
	}

	err = setManifestVersion(packageRoot, version)
	if err != nil {
	return err
	}

		updateCmd.Flags().Bool(cobraext.RequiresChangelogFlagName, false, cobraext.RequiresChangelogFlagDescription)
		updateCmd.Flags().String(cobraext.RequiresChangelogTypeFlagName, "", cobraext.RequiresChangelogTypeFlagDescription)

	requiresUpdateLongDescription = `Update requires.input and requires.content pins to the latest registry versions compatible with this package's Kibana constraint.

	By default manifest.yml is updated. Use --dry-run to report available bumps without writing the manifest.
	Version pins must be exact semver versions (constraints such as ^0.3.0 are not accepted).

	When a newer dependency exists but requires a higher Kibana version than this package allows, a warning is printed suggesting to bump conditions.kibana.version on the integration package.`

Conversation

teresaromero commented Jun 1, 2026 • edited by mrodm Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

How it works

Reviewer notes

Uh oh!

mrodm Jun 5, 2026

Choose a reason for hiding this comment

Uh oh!

teresaromero Jun 5, 2026

Choose a reason for hiding this comment

Uh oh!

mrodm Jun 5, 2026

Choose a reason for hiding this comment

Uh oh!

mrodm Jun 5, 2026

Choose a reason for hiding this comment

Uh oh!

mrodm Jun 5, 2026

Choose a reason for hiding this comment

Uh oh!

mrodm Jun 5, 2026

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Jun 5, 2026

💚 Build Succeeded

History

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

teresaromero commented Jun 1, 2026 •

edited by mrodm

Loading