fix: ensure changes to files can optionally be staged

cmd/uplift/bump.go

@@ -124,6 +124,7 @@ func setupBumpContext(opts bumpOptions, out io.Writer) (*context.Context, error)
 	ctx.Debug = opts.Debug
 	ctx.DryRun = opts.DryRun
 	ctx.NoPush = opts.NoPush
+	ctx.NoStage = opts.NoStage
 	ctx.Out = out
 
 	// Handle prerelease suffix if one is provided

cmd/uplift/changelog.go

@@ -163,6 +163,7 @@ func setupChangelogContext(opts changelogOptions, out io.Writer) (*context.Conte
 	ctx.Debug = opts.Debug
 	ctx.DryRun = opts.DryRun
 	ctx.NoPush = opts.NoPush
+	ctx.NoStage = opts.NoStage
 	ctx.Changelog.DiffOnly = opts.DiffOnly
 	ctx.Changelog.All = opts.All
 

cmd/uplift/release.go

@@ -160,6 +160,7 @@ func setupReleaseContext(opts releaseOptions, out io.Writer) (*context.Context,
 	ctx.Debug = opts.Debug
 	ctx.DryRun = opts.DryRun
 	ctx.NoPush = opts.NoPush
+	ctx.NoStage = opts.NoStage
 	ctx.FetchTags = opts.FetchTags
 	ctx.Out = out
 	ctx.SkipChangelog = opts.SkipChangelog

cmd/uplift/root.go

@@ -35,6 +35,7 @@ type globalOptions struct {
 	DryRun                   bool
 	Debug                    bool
 	NoPush                   bool
+	NoStage                  bool
 	Silent                   bool
 	IgnoreExistingPrerelease bool
 	IgnoreDetached           bool
@@ -75,6 +76,7 @@ func newRootCmd(out io.Writer) *rootCommand {
 	pf.BoolVar(&rootCmd.Opts.DryRun, "dry-run", false, "run without making any changes")
 	pf.BoolVar(&rootCmd.Opts.Debug, "debug", false, "show me everything that happens")
 	pf.BoolVar(&rootCmd.Opts.NoPush, "no-push", false, "no changes will be pushed to the git remote")
+	pf.BoolVar(&rootCmd.Opts.NoStage, "no-stage", false, "no changes will be git staged")
 	pf.BoolVar(&rootCmd.Opts.Silent, "silent", false, "silence all logging")
 	pf.BoolVar(&rootCmd.Opts.IgnoreDetached, "ignore-detached", false, "ignore reported git detached HEAD error")
 	pf.BoolVar(&rootCmd.Opts.IgnoreShallow, "ignore-shallow", false, "ignore reported git shallow clone error")

cmd/uplift/root_test.go

@@ -89,3 +89,13 @@ func TestRoot_IgnoreShallowFlag(t *testing.T) {
 
 	assert.True(t, rootCmd.Opts.IgnoreShallow)
 }
+
+func TestRoot_NoStage(t *testing.T) {
+	rootCmd := newRootCmd(os.Stdout)
+
+	rootCmd.Cmd.SetArgs([]string{"--no-stage"})
+	err := rootCmd.Cmd.Execute()
+	require.NoError(t, err)
+
+	assert.True(t, rootCmd.Opts.NoStage)
+}

internal/context/context.go

@@ -50,6 +50,7 @@ type Context struct {
 	PrintCurrentTag          bool
 	PrintNextTag             bool
 	NoPush                   bool
+	NoStage                  bool
 	Changelog                Changelog
 	SCM                      SCM
 	SkipChangelog            bool

internal/task/bump/bump.go

@@ -51,15 +51,14 @@ func (t Task) Run(ctx *context.Context) error {
 
 	n := 0
 	for _, bump := range ctx.Config.Bumps {
-		var bumped bool
 		if len(bump.Regex) > 0 {
 			ok, err := regexBump(ctx, bump.File, bump.Regex)
 			if err != nil {
 				return err
 			}
 
 			if ok {
-				bumped = ok
+				n++
 			}
 		}
 
@@ -70,20 +69,19 @@ func (t Task) Run(ctx *context.Context) error {
 			}
 
 			if ok {
-				bumped = ok
+				n++
 			}
 		}
 
-		if bumped {
-			// Attempt to stage the changed file, if this isn't a dry run
-			if !ctx.DryRun {
-				if err := git.Stage(bump.File); err != nil {
-					return err
-				}
-				log.WithField("file", bump.File).Info("successfully staged file")
-			}
-			n++
+		if ctx.NoStage {
+			log.Info("skip staging of file")
+			continue
+		}
+
+		if err := git.Stage(bump.File); err != nil {
+			return err
 		}
+		log.WithField("file", bump.File).Info("successfully staged file")
 	}
 
 	if n > 0 {

internal/task/bump/bump_test.go

@@ -30,6 +30,7 @@ import (
 	"github.com/gembaadvantage/uplift/internal/git"
 	"github.com/gembaadvantage/uplift/internal/semver"
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 )
 
 func TestString(t *testing.T) {
@@ -66,3 +67,36 @@ func TestRun_NotGitRepository(t *testing.T) {
 	err := Task{}.Run(ctx)
 	assert.EqualError(t, err, "fatal: not a git repository (or any of the parent directories): .git")
 }
+
+func TestRun_NoStage(t *testing.T) {
+	git.InitRepo(t)
+	file := WriteFile(t, "version: 0.1.0")
+
+	ctx := &context.Context{
+		NextVersion: semver.Version{
+			Raw: "0.1.1",
+		},
+		Config: config.Uplift{
+			Bumps: []config.Bump{
+				{
+					File: file,
+					Regex: []config.RegexBump{
+						{
+							Pattern: "version: $VERSION",
+						},
+					},
+				},
+			},
+		},
+		NoStage: true,
+	}
+
+	err := Task{}.Run(ctx)
+	require.NoError(t, err)
+
+	actual := ReadFile(t, file)
+	assert.Equal(t, "version: 0.1.1", actual)
+
+	staged, _ := git.Staged()
+	assert.Empty(t, staged)
+}

internal/task/changelog/changelog.go

@@ -147,6 +147,11 @@ func (t Task) Run(ctx *context.Context) error {
 		return chgErr
 	}
 
+	if ctx.NoStage {
+		log.Info("skip staging of CHANGELOG.md")
+		return nil
+	}
+
 	log.Debug("staging CHANGELOG.md")
 	return git.Stage(MarkdownFile)
 }

internal/task/changelog/changelog_test.go

@@ -126,6 +126,24 @@ func TestRun_Staged(t *testing.T) {
 	assert.Equal(t, "CHANGELOG.md", stg[0])
 }
 
+func TestRun_NotStaged(t *testing.T) {
+	git.InitRepo(t)
+	git.EmptyCommitsAndTag(t, "1.0.0", "first commit", "second commit")
+
+	ctx := &context.Context{
+		NextVersion: semver.Version{
+			Raw: "1.0.0",
+		},
+		NoStage: true,
+	}
+
+	err := Task{}.Run(ctx)
+	require.NoError(t, err)
+
+	stg, _ := git.Staged()
+	assert.Len(t, stg, 0)
+}
+
 func TestRun_AppendToUnsupportedTemplate(t *testing.T) {
 	git.InitRepo(t)
 	git.EmptyCommitsAndTag(t, "1.0.0", "first commit")