Merge pull request #65 from fullstack-devops/bugfix/workflow-hardening-assets

workflow hardening missing assets

Author: eksrha

.github/workflows/Release.yaml

@@ -91,10 +91,17 @@ jobs:
           path: out/
           key: awesome-ci-${{ github.sha }}
 
-      - name: list generated artifacts
+      - name: get generated artifacts
         working-directory: out
         run: ls -la
 
+      - name: Check available assets
+        if: hashFiles('out/awesome-ci_${{ needs.generate_infos.outputs.version }}_arm64') != '' || hashFiles('out/awesome-ci_${{ needs.generate_infos.outputs.version }}_amd64') != ''
+        uses: actions/github-script@v3
+        with:
+          script: |
+              core.setFailed('Not all files provided')
+
       - name: Publish Release
         run: awesome-ci release publish -releaseid "$ACI_RELEASE_ID" -assets "file=out/$ARTIFACT1,file=out/$ARTIFACT2"
         env:
@@ -121,7 +128,7 @@ jobs:
 
           OLD_VERSION=$(echo "$(git describe --tags)" | tr -d '\n')
 
-          sed -i "s/$OLD_VERSION/$NEW_VERSION/g" action.yml README.md
+          sed -i "s/\([0-9]\+\.[0-9]\+\.[0-9]\+\)/$NEW_VERSION/g" action.yml README.md
 
           git status
           git commit -a -m "update to version v$NEW_VERSION"

.github/workflows/branchPR.yaml

@@ -76,3 +76,4 @@ jobs:
       - name: get generated artifacts
         working-directory: out
         run: ls -la
+

docs/commands/index.md

@@ -29,9 +29,16 @@ awesome-ci <subcommand> [subcommand-option]
 
 You can find out more about the subcommands by clicking on the relevant one in the navigation.
 
-| Subcommand                                                                         | Description                                             |
-| ---------------------------------------------------------------------------------- | ------------------------------------------------------- |
-| [release](https://fullstack-devops.github.io/awesome-ci/commands/createRelease.html)         | creates a release at GitHub or GitLab                   |
-| [pr](https://fullstack-devops.github.io/awesome-ci/commands/getBuildInfos.html)              | prints out any git information and can manipulate these |
-| [parseJSON](https://fullstack-devops.github.io/awesome-ci/commands/parseJSON.html)           | can parse simple JSON files                             |
-| [parseYAML](https://fullstack-devops.github.io/awesome-ci/commands/parseYAML.html)           | can parse simple YAML files                             |
+| Subcommand                              | Description                               |
+| --------------------------------------- | ------------------------------------------|
+| [release](/commands/createRelease.html) | creates a release at GitHub or            |
+| [pr](/commands/getBuildInfos.html)      | prints out any git information and can manipulate |
+| [parseJSON](/commands/parseJSON.html)   | can parse simple JSON                     |
+| [parseYAML](/commands/parseYAML.html)   | can parse simple YAML files               |
+
+
+## Release Body updates
+
+Now available: Any string or any markdown file can now be attached in the release section. In addition, the release assets are attached as text to each release body with the associated sha256. More about that in the picture below and in the release section.
+
+![Release Body with Asstes](/pictures/release-assets-readme.png "Release Body with Asstes")

docs/commands/release.md

@@ -29,6 +29,7 @@ awesome-ci release <subcommand> [subcommand-option]
 | `-version`          | overrides any version from git and, or patches the given string             |
 | `-patchLevel`       | overrides the patchLevel. make shure your following the alias definition.   |
 | `-dry-run`          | doesn't create a release. Prints out what it would do and check permissions |
+| `-body`             | add a text (markdown) to the release body                                   |
 | `-assets`           | (only available in publish) uploads the given Artifacts to a release. Eg.: `file=out/awesome-ci` |
 | `-releaseid`        | (only available in publish) publishes an early defined release              |
 
@@ -42,15 +43,6 @@ This can be useful in connection with `-patchLevel` when creating a manual relea
 awesome-ci createRelease -version 0.1.0
 ```
 
-#### -patchLevel
-
-The `-patchLevel` option can overwrite the evaluated patchLevel.
-This can be useful in connection with `-version` when creating a manual release.
-
-```bash
-awesome-ci createRelease -patchLevel feature
-```
-
 #### -assets
 
 The `-assets` option can updload a single or multiple artifacts.
@@ -59,5 +51,10 @@ However, you must choose the format of the artefacts.
 
 eg.: `-assets "file=path/to/file,file=path/to/second/file"`
 
+#### -body
+
+Send a custom release description. the input can be either a string or a path to a file.
+
+![Release Body with Asstes](/pictures/release-assets-readme.png "Release Body with Asstes")
 
 ... more documentation to be done ;)

docs/pictures/release-assets-readme.png

@@ -57,6 +57,7 @@ func init() {
 	releaseSet.Create.Fs = flag.NewFlagSet("release create", flag.ExitOnError)
 	releaseSet.Create.Fs.IntVar(&releaseSet.Create.PrNumber, "prnumber", 0, "overwrite the issue number")
 	releaseSet.Create.Fs.StringVar(&releaseSet.Create.Version, "version", "", "override version to Update")
+	releaseSet.Create.Fs.StringVar(&releaseSet.Create.Body, "body", "", "custom release message (markdow string or file)")
 	releaseSet.Create.Fs.StringVar(&releaseSet.Create.PatchLevel, "patchLevel", "", "predefine version to Update")
 	releaseSet.Create.Fs.BoolVar(&releaseSet.Create.DryRun, "dry-run", false, "make dry-run before writing version to Git by calling it")
 	releaseSet.Create.Fs.Usage = func() {
@@ -66,6 +67,7 @@ func init() {
 	releaseSet.Publish.Fs = flag.NewFlagSet("release publish", flag.ExitOnError)
 	releaseSet.Publish.Fs.IntVar(&releaseSet.Publish.PrNumber, "prnumber", 0, "overwrite the issue number")
 	releaseSet.Publish.Fs.StringVar(&releaseSet.Publish.Version, "version", "", "override version to Update")
+	releaseSet.Publish.Fs.StringVar(&releaseSet.Publish.Body, "body", "", "custom release message (markdow string or file)")
 	releaseSet.Publish.Fs.StringVar(&releaseSet.Publish.PatchLevel, "patchLevel", "", "predefine version to Update")
 	releaseSet.Publish.Fs.StringVar(&releaseSet.Publish.Assets, "assets", "", "upload assets to release. eg.: \"file=awesome-ci\"")
 	releaseSet.Publish.Fs.Int64Var(&releaseSet.Publish.ReleaseId, "releaseid", 0, "publish an early defined release")

main.go

@@ -0,0 +1,3 @@
+## Awesome-CI
+
+this project is still in the beta phase. But don't be shy and use this tool in advance. If you find bugs or have improvements, please feel free to open an [issue](https://github.com/fullstack-devops/awesome-ci/issues/new/choose) :rocket:

release-template.md

@@ -6,12 +6,13 @@ import (
 	"log"
 	"os"
 	"strconv"
+	"time"
 
 	"github.com/google/go-github/v39/github"
 )
 
 // CreateRelease
-func CreateRelease(version string, draft bool) (createdRelease *github.RepositoryRelease, err error) {
+func CreateRelease(version string, body string, draft bool) (createdRelease *github.RepositoryRelease, err error) {
 	if !isgithubRepository {
 		log.Fatalln("make shure the GITHUB_REPOSITORY is available!")
 	}
@@ -20,11 +21,20 @@ func CreateRelease(version string, draft bool) (createdRelease *github.Repositor
 	relName := "Release " + version
 	defaultBranch := tools.GetDefaultBranch()
 
+	// get body for release
+	if body != "" {
+		bodyFile, err := tools.CheckIsFile(body)
+		if err == nil {
+			body = bodyFile
+		}
+	}
+
 	releaseObject := github.RepositoryRelease{
 		TargetCommitish: &defaultBranch,
 		TagName:         &version,
 		Name:            &relName,
 		Draft:           &draft,
+		Body:            &body,
 	}
 	createdRelease, _, err = GithubClient.Repositories.CreateRelease(
 		ctx,
@@ -46,7 +56,7 @@ func CreateRelease(version string, draft bool) (createdRelease *github.Repositor
 }
 
 // PublishRelease
-func PublishRelease(version string, releaseId int64, uploadArtifacts *string) (err error) {
+func PublishRelease(version string, body string, releaseId int64, uploadArtifacts *string) (err error) {
 	draftFalse := false
 	if !isgithubRepository {
 		log.Fatalln("make shure the GITHUB_REPOSITORY is available!")
@@ -57,7 +67,7 @@ func PublishRelease(version string, releaseId int64, uploadArtifacts *string) (e
 		releaseIdStr, releaseIdBool := os.LookupEnv("ACI_RELEASE_ID")
 		if !releaseIdBool {
 			log.Println("No release found, creating one...")
-			release, err := CreateRelease(version, false)
+			release, err := CreateRelease(version, body, false)
 			if err != nil {
 				log.Fatalln(err)
 			}
@@ -80,23 +90,16 @@ func PublishRelease(version string, releaseId int64, uploadArtifacts *string) (e
 		return err
 	}
 
-	*existingRelease.Draft = draftFalse
-	_, _, err = GithubClient.Repositories.EditRelease(
-		ctx,
-		owner,
-		repo,
-		releaseId,
-		existingRelease)
-	if err != nil {
-		return err
-	}
-
+	// upload any given artifacts
+	var releaseBodyAssets string = ""
 	if uploadArtifacts != nil {
-		filesAndInfos, err := tools.GetFilesAndInfos(uploadArtifacts)
+		filesAndInfos, err := tools.GetAsstes(uploadArtifacts, false)
 		if err != nil {
 			return err
 		}
 
+		releaseBodyAssets = "### Asstes\n"
+
 		for i, fileAndInfo := range filesAndInfos {
 			fmt.Printf("uploading %s as asset to release\n", fileAndInfo.Name)
 			// Upload assets to GitHub Release
@@ -112,6 +115,9 @@ func PublishRelease(version string, releaseId int64, uploadArtifacts *string) (e
 			if err != nil {
 				log.Println("error at uploading asset to release: ", err)
 			} else {
+				// add asset to release body
+				releaseBodyAssets = fmt.Sprintf("%s\n- [%s](%s) `%s`\n  Sha256: `%x`", releaseBodyAssets, fileAndInfo.Name, *relAsset.BrowserDownloadURL, fileAndInfo.Infos.ModTime().Format(time.RFC3339), fileAndInfo.Hash)
+
 				// export Download URL to env. See: #53
 				envVars, err := OpenEnvFile()
 				if err != nil {
@@ -125,6 +131,22 @@ func PublishRelease(version string, releaseId int64, uploadArtifacts *string) (e
 			}
 		}
 	}
+
+	newReleaseBody := fmt.Sprintf("%s\n\n%s", *existingRelease.Body, releaseBodyAssets)
+	existingRelease.Body = &newReleaseBody
+
+	// publishing release
+	*existingRelease.Draft = draftFalse
+	_, _, err = GithubClient.Repositories.EditRelease(
+		ctx,
+		owner,
+		repo,
+		releaseId,
+		existingRelease)
+	if err != nil {
+		return err
+	}
+
 	return
 }
 

src/acigithub/release.go

@@ -3,6 +3,7 @@ package service
 import (
 	"awesome-ci/src/acigithub"
 	"awesome-ci/src/semver"
+	"awesome-ci/src/tools"
 	"errors"
 	"flag"
 	"fmt"
@@ -23,6 +24,7 @@ type ReleaseCreateSet struct {
 	PatchLevel string
 	PrNumber   int
 	DryRun     bool
+	Body       string
 }
 
 type ReleasePublishSet struct {
@@ -33,6 +35,7 @@ type ReleasePublishSet struct {
 	Assets     string
 	PrNumber   int
 	DryRun     bool
+	Body       string
 }
 
 func ReleaseCreate(args *ReleaseCreateSet) {
@@ -65,17 +68,11 @@ func ReleaseCreate(args *ReleaseCreateSet) {
 		fmt.Printf("Would create new release with version: %s\n", version)
 	} else {
 		fmt.Printf("Writing new release: %s\n", version)
-		createdRelease, err := acigithub.CreateRelease(version, true)
+		createdRelease, err := acigithub.CreateRelease(version, args.Body, true)
 		if err != nil {
 			log.Fatalln(err)
 		}
 		fmt.Println("Create release successful. ID:", *createdRelease.ID)
-		envVars, err := acigithub.OpenEnvFile()
-		if err != nil {
-			log.Fatalln(err)
-		}
-		envVars.Set("ACI_RELEASE_ID", fmt.Sprint(*createdRelease.ID))
-		envVars.SaveEnvFile()
 	}
 }
 
@@ -105,11 +102,21 @@ func ReleasePublish(args *ReleasePublishSet) {
 		version = prInfos.NextVersion
 	}
 
+	if args.Assets != "" {
+		_, err = tools.GetAsstes(&args.Assets, true)
+		if err != nil {
+			log.Fatalln("not all specified asstes available, please check")
+		}
+	}
+
 	if args.DryRun {
 		fmt.Printf("Would publishing release: %s\n", version)
 	} else {
 		fmt.Printf("Publishing release: %s - %d\n", version, args.ReleaseId)
-		acigithub.PublishRelease(version, args.ReleaseId, &args.Assets)
+		err = acigithub.PublishRelease(version, args.Body, args.ReleaseId, &args.Assets)
+		if err != nil {
+			log.Fatalln(err)
+		}
 	}
 }