|
| 1 | +// Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one |
| 2 | +// or more contributor license agreements. Licensed under the Elastic License; |
| 3 | +// you may not use this file except in compliance with the Elastic License. |
| 4 | + |
| 5 | +package main |
| 6 | + |
| 7 | +import ( |
| 8 | + "context" |
| 9 | + "errors" |
| 10 | + "fmt" |
| 11 | + "io" |
| 12 | + "os" |
| 13 | + "path/filepath" |
| 14 | + |
| 15 | + "github.com/Masterminds/semver/v3" |
| 16 | + "github.com/spf13/pflag" |
| 17 | + |
| 18 | + "github.com/elastic/elastic-package/internal/cobraext" |
| 19 | + "github.com/elastic/elastic-package/internal/packages" |
| 20 | + "github.com/elastic/elastic-package/internal/packages/changelog" |
| 21 | + "github.com/elastic/elastic-package/pkg/shell" |
| 22 | +) |
| 23 | + |
| 24 | +var _ shell.Command = changelogCmd{} |
| 25 | + |
| 26 | +type changelogCmd struct{} |
| 27 | + |
| 28 | +func (changelogCmd) Usage() string { |
| 29 | + return "changelog --next {major|minor|patch} --description desc --type {bugfix|enhancement|breaking-change} --link link" |
| 30 | +} |
| 31 | + |
| 32 | +func (changelogCmd) Desc() string { |
| 33 | + return "Add an entry to the changelog file in each of the packages in context 'Shell.Packages'." |
| 34 | +} |
| 35 | + |
| 36 | +func (changelogCmd) Flags() *pflag.FlagSet { |
| 37 | + flags := pflag.NewFlagSet("changelog", pflag.ContinueOnError) |
| 38 | + flags.String(cobraext.ChangelogAddNextFlagName, "", cobraext.ChangelogAddNextFlagDescription) |
| 39 | + flags.String(cobraext.ChangelogAddDescriptionFlagName, "", cobraext.ChangelogAddDescriptionFlagDescription) |
| 40 | + flags.String(cobraext.ChangelogAddTypeFlagName, "", cobraext.ChangelogAddTypeFlagDescription) |
| 41 | + flags.String(cobraext.ChangelogAddLinkFlagName, "", cobraext.ChangelogAddLinkFlagDescription) |
| 42 | + return flags |
| 43 | +} |
| 44 | + |
| 45 | +func (changelogCmd) Exec(ctx context.Context, flags *pflag.FlagSet, args []string, _, stderr io.Writer) (context.Context, error) { |
| 46 | + packages, ok := ctx.Value(ctxKeyPackages).([]string) |
| 47 | + if !ok { |
| 48 | + fmt.Fprintln(stderr, "no packages found in the context") |
| 49 | + return ctx, nil |
| 50 | + } |
| 51 | + for _, pkg := range packages { |
| 52 | + packageRoot := pkg |
| 53 | + // check if we are in packages folder |
| 54 | + if _, err := os.Stat(filepath.Join(".", pkg)); err != nil { |
| 55 | + // check if we are in integrations root folder |
| 56 | + packageRoot = filepath.Join(".", "packages", pkg) |
| 57 | + if _, err := os.Stat(packageRoot); err != nil { |
| 58 | + return ctx, errors.New("you need to be in intgerations root folder or in the packages folder") |
| 59 | + } |
| 60 | + } |
| 61 | + if err := changelogAddCmdForRoot(packageRoot, flags, args); err != nil { |
| 62 | + return ctx, err |
| 63 | + } |
| 64 | + } |
| 65 | + return ctx, nil |
| 66 | +} |
| 67 | + |
| 68 | +func changelogAddCmdForRoot(packageRoot string, flags *pflag.FlagSet, args []string) error { |
| 69 | + nextMode, _ := flags.GetString(cobraext.ChangelogAddNextFlagName) |
| 70 | + v, err := changelogCmdVersion(nextMode, packageRoot) |
| 71 | + if err != nil { |
| 72 | + return err |
| 73 | + } |
| 74 | + version := v.String() |
| 75 | + |
| 76 | + description, _ := flags.GetString(cobraext.ChangelogAddDescriptionFlagName) |
| 77 | + changeType, _ := flags.GetString(cobraext.ChangelogAddTypeFlagName) |
| 78 | + link, _ := flags.GetString(cobraext.ChangelogAddLinkFlagName) |
| 79 | + |
| 80 | + entry := changelog.Revision{ |
| 81 | + Version: version, |
| 82 | + Changes: []changelog.Entry{ |
| 83 | + { |
| 84 | + Description: description, |
| 85 | + Type: changeType, |
| 86 | + Link: link, |
| 87 | + }, |
| 88 | + }, |
| 89 | + } |
| 90 | + |
| 91 | + if err := patchChangelogFile(packageRoot, entry); err != nil { |
| 92 | + return err |
| 93 | + } |
| 94 | + |
| 95 | + if err := setManifestVersion(packageRoot, version); err != nil { |
| 96 | + return err |
| 97 | + } |
| 98 | + |
| 99 | + return nil |
| 100 | +} |
| 101 | + |
| 102 | +func changelogCmdVersion(nextMode, packageRoot string) (*semver.Version, error) { |
| 103 | + revisions, err := changelog.ReadChangelogFromPackageRoot(packageRoot) |
| 104 | + if err != nil { |
| 105 | + return nil, fmt.Errorf("failed to read current changelog: %w", err) |
| 106 | + } |
| 107 | + if len(revisions) == 0 { |
| 108 | + return semver.MustParse("0.0.0"), nil |
| 109 | + } |
| 110 | + |
| 111 | + version, err := semver.NewVersion(revisions[0].Version) |
| 112 | + if err != nil { |
| 113 | + return nil, fmt.Errorf("invalid version in changelog %q: %w", revisions[0].Version, err) |
| 114 | + } |
| 115 | + |
| 116 | + switch nextMode { |
| 117 | + case "": |
| 118 | + break |
| 119 | + case "major": |
| 120 | + v := version.IncMajor() |
| 121 | + version = &v |
| 122 | + case "minor": |
| 123 | + v := version.IncMinor() |
| 124 | + version = &v |
| 125 | + case "patch": |
| 126 | + v := version.IncPatch() |
| 127 | + version = &v |
| 128 | + default: |
| 129 | + return nil, fmt.Errorf("invalid value for %q: %s", |
| 130 | + cobraext.ChangelogAddNextFlagName, nextMode) |
| 131 | + } |
| 132 | + |
| 133 | + return version, nil |
| 134 | +} |
| 135 | + |
| 136 | +// patchChangelogFile looks for the proper place to add the new revision in the changelog, |
| 137 | +// trying to conserve original format and comments. |
| 138 | +func patchChangelogFile(packageRoot string, patch changelog.Revision) error { |
| 139 | + changelogPath := filepath.Join(packageRoot, changelog.PackageChangelogFile) |
| 140 | + d, err := os.ReadFile(changelogPath) |
| 141 | + if err != nil { |
| 142 | + return err |
| 143 | + } |
| 144 | + |
| 145 | + d, err = changelog.PatchYAML(d, patch) |
| 146 | + if err != nil { |
| 147 | + return err |
| 148 | + } |
| 149 | + |
| 150 | + return os.WriteFile(changelogPath, d, 0644) |
| 151 | +} |
| 152 | + |
| 153 | +func setManifestVersion(packageRoot string, version string) error { |
| 154 | + manifestPath := filepath.Join(packageRoot, packages.PackageManifestFile) |
| 155 | + d, err := os.ReadFile(manifestPath) |
| 156 | + if err != nil { |
| 157 | + return err |
| 158 | + } |
| 159 | + |
| 160 | + d, err = changelog.SetManifestVersion(d, version) |
| 161 | + if err != nil { |
| 162 | + return err |
| 163 | + } |
| 164 | + |
| 165 | + return os.WriteFile(manifestPath, d, 0644) |
| 166 | +} |
0 commit comments