feat: --auto-snapshot on dirty git tree (#2286)

* feat: --auto-snapshot

Signed-off-by: Carlos A Becker <caarlos0@gmail.com>

* docs: fix

Signed-off-by: Carlos A Becker <caarlos0@gmail.com>

* fix: workflow

Signed-off-by: Carlos A Becker <caarlos0@gmail.com>

.github/workflows/build.yml

@@ -96,7 +96,7 @@ jobs:
           TWITTER_ACCESS_TOKEN_SECRET: ${{ secrets.TWITTER_ACCESS_TOKEN_SECRET }}
         run: |
           if [[ $GITHUB_REF == refs/tags/v* ]]; then
-            ./goreleaser
+            ./goreleaser --auto-snapshot
           elif [[ $GITHUB_REF == refs/heads/master ]]; then
             ./goreleaser --snapshot
           fi

cmd/release.go

@@ -8,6 +8,7 @@ import (
 	"github.com/caarlos0/ctrlc"
 	"github.com/fatih/color"
 	"github.com/goreleaser/goreleaser/internal/middleware"
+	"github.com/goreleaser/goreleaser/internal/pipe/git"
 	"github.com/goreleaser/goreleaser/internal/pipeline"
 	"github.com/goreleaser/goreleaser/pkg/context"
 	"github.com/spf13/cobra"
@@ -26,6 +27,7 @@ type releaseOpts struct {
 	releaseHeaderTmpl string
 	releaseFooterFile string
 	releaseFooterTmpl string
+	autoSnapshot      bool
 	snapshot          bool
 	skipPublish       bool
 	skipSign          bool
@@ -73,6 +75,7 @@ func newReleaseCmd() *releaseCmd {
 	cmd.Flags().StringVar(&root.opts.releaseNotesTmpl, "release-notes-tmpl", "", "Load custom release notes from a templated markdown file (overrides --release-notes)")
 	cmd.Flags().StringVar(&root.opts.releaseHeaderTmpl, "release-header-tmpl", "", "Load custom release notes header from a templated markdown file (overrides --release-header)")
 	cmd.Flags().StringVar(&root.opts.releaseFooterTmpl, "release-footer-tmpl", "", "Load custom release notes footer from a templated markdown file (overrides --release-footer)")
+	cmd.Flags().BoolVar(&root.opts.autoSnapshot, "auto-snapshot", false, "Automatically sets --snapshot if the repo is dirty")
 	cmd.Flags().BoolVar(&root.opts.snapshot, "snapshot", false, "Generate an unversioned snapshot release, skipping all validations and without publishing any artifacts (implies --skip-publish, --skip-announce and --skip-validate)")
 	cmd.Flags().BoolVar(&root.opts.skipPublish, "skip-publish", false, "Skips publishing artifacts")
 	cmd.Flags().BoolVar(&root.opts.skipAnnounce, "skip-announce", false, "Skips announcing releases (implies --skip-validate)")
@@ -123,6 +126,10 @@ func setupReleaseContext(ctx *context.Context, options releaseOpts) *context.Con
 	ctx.ReleaseFooterFile = options.releaseFooterFile
 	ctx.ReleaseFooterTmpl = options.releaseFooterTmpl
 	ctx.Snapshot = options.snapshot
+	if options.autoSnapshot && git.CheckDirty() != nil {
+		log.Info("git repo is dirty and --auto-snapshot is set, implying --snapshot")
+		ctx.Snapshot = true
+	}
 	ctx.SkipPublish = ctx.Snapshot || options.skipPublish
 	ctx.SkipAnnounce = ctx.Snapshot || options.skipPublish || options.skipAnnounce
 	ctx.SkipValidate = ctx.Snapshot || options.skipValidate

cmd/release_test.go

@@ -1,6 +1,7 @@
 package cmd
 
 import (
+	"path/filepath"
 	"testing"
 
 	"github.com/goreleaser/goreleaser/pkg/config"
@@ -15,6 +16,27 @@ func TestRelease(t *testing.T) {
 	require.NoError(t, cmd.cmd.Execute())
 }
 
+func TestReleaseAutoSnapshot(t *testing.T) {
+	t.Run("clean", func(t *testing.T) {
+		setup(t)
+		cmd := newReleaseCmd()
+		cmd.cmd.SetArgs([]string{"--auto-snapshot", "--skip-publish"})
+		require.NoError(t, cmd.cmd.Execute())
+		require.FileExists(t, "dist/fake_0.0.2_checksums.txt", "should not have run with --snapshot")
+	})
+
+	t.Run("dirty", func(t *testing.T) {
+		setup(t)
+		createFile(t, "foo", "force dirty tree")
+		cmd := newReleaseCmd()
+		cmd.cmd.SetArgs([]string{"--auto-snapshot", "--skip-publish"})
+		require.NoError(t, cmd.cmd.Execute())
+		matches, err := filepath.Glob("./dist/fake_v0.0.2-SNAPSHOT-*_checksums.txt")
+		require.NoError(t, err)
+		require.Len(t, matches, 1, "should have implied --snapshot")
+	})
+}
+
 func TestReleaseInvalidConfig(t *testing.T) {
 	setup(t)
 	createFile(t, "goreleaser.yml", "foo: bar")

internal/pipe/git/git.go

@@ -119,11 +119,10 @@ func validate(ctx *context.Context) error {
 	if _, err := os.Stat(".git/shallow"); err == nil {
 		log.Warn("running against a shallow clone - check your CI documentation at https://goreleaser.com/ci")
 	}
-	out, err := git.Run("status", "--porcelain")
-	if strings.TrimSpace(out) != "" || err != nil {
-		return ErrDirty{status: out}
+	if err := CheckDirty(); err != nil {
+		return err
 	}
-	_, err = git.Clean(git.Run("describe", "--exact-match", "--tags", "--match", ctx.Git.CurrentTag))
+	_, err := git.Clean(git.Run("describe", "--exact-match", "--tags", "--match", ctx.Git.CurrentTag))
 	if err != nil {
 		return ErrWrongRef{
 			commit: ctx.Git.Commit,
@@ -133,6 +132,15 @@ func validate(ctx *context.Context) error {
 	return nil
 }
 
+// CheckDirty returns an error if the current git repository is dirty.
+func CheckDirty() error {
+	out, err := git.Run("status", "--porcelain")
+	if strings.TrimSpace(out) != "" || err != nil {
+		return ErrDirty{status: out}
+	}
+	return nil
+}
+
 func getBranch() (string, error) {
 	return git.Clean(git.Run("rev-parse", "--abbrev-ref", "HEAD", "--quiet"))
 }

www/docs/cmd/goreleaser_release.md

@@ -9,6 +9,7 @@ goreleaser release [flags]
 ## Options
 
 ```
+      --auto-snapshot                Automatically sets --snapshot if the repo is dirty
   -f, --config string                Load configuration from file
   -h, --help                         help for release
   -k, --key string                   GoReleaser Pro license key [$GORELEASER_KEY]