✨ Improve artefact manager download methods by adding download options (#126)

<!--
Copyright (C) 2020-2022 Arm Limited or its affiliates and Contributors.
All rights reserved.
SPDX-License-Identifier: Proprietary
-->
### Description

<!--
Please add any detail or context that would be useful to a reviewer.
-->



### Test Coverage

<!--
Please put an `x` in the correct box e.g. `[x]` to indicate the testing
coverage of this change.
-->

- [ ]  This change is covered by existing or additional automated tests.
- [ ] Manual testing has been performed (and evidence provided) as
automated testing was not feasible.
- [ ] Additional tests are not required for this change (e.g.
documentation update).

---------

Co-authored-by: aorabdel <[email protected]>
Co-authored-by: Adrien CABARBAYE <[email protected]>

Author: aorabdel

.goreleaser.yml

@@ -1,3 +1,4 @@
+version: 2
 env:
   - GO111MODULE=on
 # Commented out because requires Pro features
@@ -19,7 +20,7 @@ archives:
 checksum:
   name_template: 'checksums.txt'
 snapshot:
-  name_template: "{{ incpatch .Tag }}-dev"
+  version_template: "{{ incpatch .Tag }}-dev"
 changelog:
   sort: asc
   filters:

changes/20251024142639.feature

@@ -0,0 +1 @@
+:sparkles: Improve artefact manager download methods by adding download options

changes/20251024143330.bugfix

@@ -0,0 +1 @@
+:bug: Update goreleaser yaml to work with version 2

changes/20251024152328.bugfix

@@ -0,0 +1 @@
+:camel: Upgrade dependencies

utils/artefacts/artefacts.go

@@ -332,10 +332,16 @@ func (m *ArtefactManager[M, D, L, C]) DownloadAllJobArtefacts(ctx context.Contex
 }
 
 func (m *ArtefactManager[M, D, L, C]) DownloadAllJobArtefactsWithTree(ctx context.Context, jobName string, maintainTreeStructure bool, outputDirectory string) (err error) {
+	return m.DownloadAllJobArtefactsWithOptions(ctx, jobName, outputDirectory, WithMaintainStructure(maintainTreeStructure))
+}
+
+func (m *ArtefactManager[M, D, L, C]) DownloadAllJobArtefactsWithOptions(ctx context.Context, jobName string, outputDirectory string, opts ...DownloadOption) (err error) {
 	err = parallelisation.DetermineContextError(ctx)
 	if err != nil {
 		return
 	}
+
+	dlOpts := NewDownloadOptions(opts...)
 	err = filesystem.MkDir(outputDirectory)
 	if err != nil {
 		err = commonerrors.WrapErrorf(commonerrors.ErrUnexpected, err, "failed creating the output directory [%v] for job artefacts", outputDirectory)
@@ -347,37 +353,48 @@ func (m *ArtefactManager[M, D, L, C]) DownloadAllJobArtefactsWithTree(ctx contex
 	}
 	stop := paginator.Stop()
 	defer stop()
+	var collatedDownloadErrors []error
 	for {
 		if !paginator.HasNext() {
+			if len(collatedDownloadErrors) > 0 {
+				err = commonerrors.Join(collatedDownloadErrors...)
+			}
 			return
 		}
 		item, subErr := paginator.GetNext()
 		if subErr != nil {
 			err = commonerrors.WrapError(commonerrors.ErrUnexpected, subErr, "failed getting information about job artefacts")
 			return
 		}
+		var artefactName string
+		var downloadErr error
 		artefactLink, ok := item.(D)
 		if ok {
-			subErr = m.DownloadJobArtefactFromLinkWithTree(ctx, jobName, maintainTreeStructure, outputDirectory, artefactLink)
-			if subErr != nil {
-				err = subErr
-				return
-			}
-
+			artefactName = artefactLink.GetName()
+			downloadErr = m.DownloadJobArtefactFromLinkWithTree(ctx, jobName, dlOpts.MaintainTreeStructure, outputDirectory, artefactLink)
 		} else {
-			artefactManager, ok := item.(M)
-			if ok {
-				subErr = m.DownloadJobArtefactWithTree(ctx, jobName, maintainTreeStructure, outputDirectory, artefactManager)
-				if subErr != nil {
-					err = subErr
-					return
-				}
+			artefactManager, isManager := item.(M)
+			if isManager {
+				artefactName = artefactManager.GetName()
+				downloadErr = m.DownloadJobArtefactWithTree(ctx, jobName, dlOpts.MaintainTreeStructure, outputDirectory, artefactManager)
 			} else {
-				err = commonerrors.New(commonerrors.ErrMarshalling, "the type of the response from service cannot be interpreted")
-				return
+				downloadErr = commonerrors.New(commonerrors.ErrMarshalling, "the type of the response from service cannot be interpreted")
 			}
-
 		}
 
+		if downloadErr != nil {
+			if dlOpts.StopOnFirstError {
+				err = downloadErr
+				return
+			}
+			collatedDownloadErrors = append(collatedDownloadErrors, downloadErr)
+			if dlOpts.Logger != nil {
+				dlOpts.Logger.LogError(downloadErr)
+			}
+		} else if !reflection.IsEmpty(artefactName) {
+			if dlOpts.Logger != nil {
+				dlOpts.Logger.Log(fmt.Sprintf("downloading %s", artefactName))
+			}
+		}
 	}
 }