feat: show progress flag

Author: christophwitzko

pkg/config/config.go

@@ -36,6 +36,7 @@ type Config struct {
 	MaintainedVersion               string
 	PrependChangelog                bool
 	DownloadPlugins                 bool
+	ShowProgress                    bool
 }
 
 func mustGetString(cmd *cobra.Command, name string) string {
@@ -124,6 +125,7 @@ func NewConfig(cmd *cobra.Command) (*Config, error) {
 		MaintainedVersion:               viper.GetString("maintainedVersion"),
 		PrependChangelog:                mustGetBool(cmd, "prepend-changelog"),
 		DownloadPlugins:                 mustGetBool(cmd, "download-plugins"),
+		ShowProgress:                    mustGetBool(cmd, "show-progress"),
 	}
 	return conf, nil
 }
@@ -177,6 +179,7 @@ func InitConfig(cmd *cobra.Command) error {
 	cmd.Flags().Bool("allow-no-changes", false, "exit with code 0 if no changes are found, useful if semantic-release is automatically run")
 	cmd.Flags().Bool("prepend-changelog", false, "if the changelog file already exist the new changelog is prepended")
 	cmd.Flags().Bool("download-plugins", false, "downloads all required plugins if needed")
+	cmd.Flags().Bool("show-progress", false, "shows the plugin download progress")
 	cmd.Flags().SortFlags = true
 
 	viper.AddConfigPath(".")

pkg/plugin/discovery/discovery.go

@@ -20,6 +20,7 @@ import (
 	"github.com/cavaliercoder/grab"
 	"github.com/go-semantic-release/semantic-release/v2/pkg/analyzer"
 	"github.com/go-semantic-release/semantic-release/v2/pkg/condition"
+	"github.com/go-semantic-release/semantic-release/v2/pkg/config"
 	"github.com/go-semantic-release/semantic-release/v2/pkg/generator"
 	"github.com/go-semantic-release/semantic-release/v2/pkg/hooks"
 	"github.com/go-semantic-release/semantic-release/v2/pkg/plugin"
@@ -75,7 +76,15 @@ type apiPlugin struct {
 	Versions      map[string]*apiPluginRelease
 }
 
-func getPluginInfo(name string) (*apiPlugin, error) {
+type Discovery struct {
+	config *config.Config
+}
+
+func New(config *config.Config) (*Discovery, error) {
+	return &Discovery{config}, nil
+}
+
+func (d *Discovery) getPluginInfo(name string) (*apiPlugin, error) {
 	res, err := http.Get(fmt.Sprintf("%s/plugins/%s.json", PluginAPI, name))
 	if err != nil {
 		return nil, err
@@ -125,8 +134,8 @@ func showDownloadProgressBar(name string, res *grab.Response) {
 	<-done
 }
 
-func fetchPlugin(name, pth string, cons *semver.Constraints) (string, error) {
-	pluginInfo, err := getPluginInfo(name)
+func (d *Discovery) fetchPlugin(name, pth string, cons *semver.Constraints) (string, error) {
+	pluginInfo, err := d.getPluginInfo(name)
 	if err != nil {
 		return "", err
 	}
@@ -176,7 +185,9 @@ func fetchPlugin(name, pth string, cons *semver.Constraints) (string, error) {
 	}
 
 	res := grab.DefaultClient.Do(req)
-	showDownloadProgressBar(name, res)
+	if d.config.ShowProgress {
+		showDownloadProgressBar(name, res)
+	}
 	if err := res.Err(); err != nil {
 		return "", err
 	}
@@ -220,7 +231,7 @@ func getMatchingVersionDir(pth string, cons *semver.Constraints) (string, error)
 	return "", errors.New("no matching version found")
 }
 
-func findPluginLocally(pth string, cons *semver.Constraints) (string, error) {
+func (d *Discovery) findPluginLocally(pth string, cons *semver.Constraints) (string, error) {
 	vPth, err := getMatchingVersionDir(pth, cons)
 	if err != nil {
 		return "", err
@@ -263,7 +274,7 @@ func getPluginType(t string) string {
 	return ""
 }
 
-func FindPlugin(t, name string) (*plugin.PluginOpts, error) {
+func (d *Discovery) FindPlugin(t, name string) (*plugin.PluginOpts, error) {
 	pType := getPluginType(t)
 	if pType == "" {
 		return nil, errors.New("invalid plugin type")
@@ -285,9 +296,9 @@ func FindPlugin(t, name string) (*plugin.PluginOpts, error) {
 		return nil, err
 	}
 
-	binPath, err := findPluginLocally(pPath, cons)
+	binPath, err := d.findPluginLocally(pPath, cons)
 	if err != nil {
-		binPath, err = fetchPlugin(pName, pPath, cons)
+		binPath, err = d.fetchPlugin(pName, pPath, cons)
 		if err != nil {
 			return nil, err
 		}

pkg/plugin/manager/manager.go

@@ -13,15 +13,23 @@ import (
 )
 
 type PluginManager struct {
-	config *config.Config
+	config    *config.Config
+	discovery *discovery.Discovery
 }
 
 func New(config *config.Config) (*PluginManager, error) {
-	return &PluginManager{config}, nil
+	dis, err := discovery.New(config)
+	if err != nil {
+		return nil, err
+	}
+	return &PluginManager{
+		config:    config,
+		discovery: dis,
+	}, nil
 }
 
 func (m *PluginManager) GetCICondition() (condition.CICondition, error) {
-	opts, err := discovery.FindPlugin(condition.CIConditionPluginName, m.config.CIConditionPlugin)
+	opts, err := m.discovery.FindPlugin(condition.CIConditionPluginName, m.config.CIConditionPlugin)
 	if err != nil {
 		return nil, err
 	}
@@ -34,7 +42,7 @@ func (m *PluginManager) GetCICondition() (condition.CICondition, error) {
 }
 
 func (m *PluginManager) GetProvider() (provider.Provider, error) {
-	opts, err := discovery.FindPlugin(provider.PluginName, m.config.ProviderPlugin)
+	opts, err := m.discovery.FindPlugin(provider.PluginName, m.config.ProviderPlugin)
 	if err != nil {
 		return nil, err
 	}
@@ -47,7 +55,7 @@ func (m *PluginManager) GetProvider() (provider.Provider, error) {
 }
 
 func (m *PluginManager) GetCommitAnalyzer() (analyzer.CommitAnalyzer, error) {
-	opts, err := discovery.FindPlugin(analyzer.CommitAnalyzerPluginName, m.config.CommitAnalyzerPlugin)
+	opts, err := m.discovery.FindPlugin(analyzer.CommitAnalyzerPluginName, m.config.CommitAnalyzerPlugin)
 	if err != nil {
 		return nil, err
 	}
@@ -60,7 +68,7 @@ func (m *PluginManager) GetCommitAnalyzer() (analyzer.CommitAnalyzer, error) {
 }
 
 func (m *PluginManager) GetChangelogGenerator() (generator.ChangelogGenerator, error) {
-	opts, err := discovery.FindPlugin(generator.ChangelogGeneratorPluginName, m.config.ChangelogGeneratorPlugin)
+	opts, err := m.discovery.FindPlugin(generator.ChangelogGeneratorPluginName, m.config.ChangelogGeneratorPlugin)
 	if err != nil {
 		return nil, err
 	}
@@ -75,7 +83,7 @@ func (m *PluginManager) GetChangelogGenerator() (generator.ChangelogGenerator, e
 func (m *PluginManager) GetChainedUpdater() (*updater.ChainedUpdater, error) {
 	updaters := make([]updater.FilesUpdater, 0)
 	for _, pl := range m.config.FilesUpdaterPlugins {
-		opts, err := discovery.FindPlugin(updater.FilesUpdaterPluginName, pl)
+		opts, err := m.discovery.FindPlugin(updater.FilesUpdaterPluginName, pl)
 		if err != nil {
 			return nil, err
 		}
@@ -96,7 +104,7 @@ func (m *PluginManager) GetChainedUpdater() (*updater.ChainedUpdater, error) {
 func (m *PluginManager) GetChainedHooksExecutor() (*hooks.ChainedHooksExecutor, error) {
 	hooksChain := make([]hooks.Hooks, 0)
 	for _, pl := range m.config.HooksPlugins {
-		opts, err := discovery.FindPlugin(hooks.PluginName, pl)
+		opts, err := m.discovery.FindPlugin(hooks.PluginName, pl)
 		if err != nil {
 			return nil, err
 		}
@@ -125,21 +133,21 @@ func (m *PluginManager) FetchAllPlugins() error {
 		generator.ChangelogGeneratorPluginName: m.config.ChangelogGeneratorPlugin,
 	}
 	for t, name := range pluginMap {
-		_, err := discovery.FindPlugin(t, name)
+		_, err := m.discovery.FindPlugin(t, name)
 		if err != nil {
 			return err
 		}
 	}
 
 	for _, pl := range m.config.FilesUpdaterPlugins {
-		_, err := discovery.FindPlugin(updater.FilesUpdaterPluginName, pl)
+		_, err := m.discovery.FindPlugin(updater.FilesUpdaterPluginName, pl)
 		if err != nil {
 			return err
 		}
 	}
 
 	for _, pl := range m.config.HooksPlugins {
-		_, err := discovery.FindPlugin(hooks.PluginName, pl)
+		_, err := m.discovery.FindPlugin(hooks.PluginName, pl)
 		if err != nil {
 			return err
 		}