add release templating + docs

Author: eksrha

.github/workflows/branchPR.yaml

@@ -77,9 +77,3 @@ jobs:
         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')

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

@@ -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,6 +6,7 @@ import (
 	"log"
 	"os"
 	"strconv"
+	"time"
 
 	"github.com/google/go-github/v39/github"
 )
@@ -89,23 +90,16 @@ func PublishRelease(version string, body string, releaseId int64, uploadArtifact
 		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.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
@@ -121,6 +115,9 @@ func PublishRelease(version string, body string, releaseId int64, uploadArtifact
 			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 {
@@ -134,6 +131,22 @@ func PublishRelease(version string, body string, releaseId int64, uploadArtifact
 			}
 		}
 	}
+
+	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

@@ -102,9 +102,11 @@ func ReleasePublish(args *ReleasePublishSet) {
 		version = prInfos.NextVersion
 	}
 
-	_, err = tools.GetAsstes(&args.Assets, true)
-	if err != nil {
-		log.Fatalln("not all specified asstes available, please check")
+	if args.Assets != "" {
+		_, err = tools.GetAsstes(&args.Assets, true)
+		if err != nil {
+			log.Fatalln("not all specified asstes available, please check")
+		}
 	}
 
 	if args.DryRun {

src/service/release.go

@@ -1,7 +1,10 @@
 package tools
 
 import (
+	"crypto/sha256"
 	"fmt"
+	"io"
+	"io/fs"
 	"os"
 	"strings"
 )
@@ -14,9 +17,12 @@ type UploadArtifact struct {
 type UploadAsset struct {
 	File  os.File
 	Name  string
+	Infos fs.FileInfo
 	IsZip bool
+	Hash  []byte
 }
 
+// deprecated
 func GetFilesAndInfos(uploadArtifacts *string) (artifacts []UploadArtifact, err error) {
 	artifactsToUpload := strings.Split(*uploadArtifacts, ",")
 	for _, artifact := range artifactsToUpload {
@@ -56,10 +62,13 @@ func GetAsstes(uploadArtifacts *string, check bool) (asset []UploadAsset, err er
 			if check {
 				file.Close()
 			} else {
+				hash, _ := getHashFromFile(assetName[1])
 				asset = append(asset, UploadAsset{
 					File:  *file,
 					Name:  info.Name(),
+					Infos: info,
 					IsZip: false,
+					Hash:  hash,
 				})
 			}
 		case "files":
@@ -74,6 +83,21 @@ func GetAsstes(uploadArtifacts *string, check bool) (asset []UploadAsset, err er
 	return
 }
 
+func getHashFromFile(name string) (hash []byte, err error) {
+	f, err := os.Open(name)
+	if err != nil {
+		return
+	}
+	defer f.Close()
+
+	h := sha256.New()
+	if _, err = io.Copy(h, f); err != nil {
+		return
+	}
+
+	return h.Sum(nil), nil
+}
+
 func CheckIsFile(name string) (body string, err error) {
 	data, err := os.ReadFile(name)
 	if err != nil {

src/tools/files.go

@@ -8,6 +8,6 @@ ACI_VERSION=0.7.7
 ACI_LATEST_VERSION=0.7.6
 ACI_OWNER=fullstack-devops
 ACI_REPO=awesome-ci
-ACI_RELEASE_ID=58286218
+ACI_RELEASE_ID=58310269
 ACI_ARTIFACT_0_URL=https://github.com/eksrha/playground/releases/download/2.0.0/awesome-ci
 ACI_ARTIFACT_1_URL=https://github.com/eksrha/playground/releases/download/4.0.0/awesome-ci

tests/github_env

@@ -0,0 +1,5 @@
+## Awesome-CI
+
+This is a great readme to appear as the body of the release.
+
+The great thing about it is that the asset section is self-generated by awesome-ci. However, only if an asset is also uploaded :rocket: