Merge pull request #54 from fullstack-devops/feature/issue-53

add assets upload-url to env

Author: eksrha

CONTRIBUTION.md

@@ -2,9 +2,9 @@ tbd ;)
 
 ## Installation
 
-The installation is needed only for contirbuting.
+git clone <this-repo>
 
-Go to your GOPATH under `src/` and run: `go get https://gitlab.com/eksrvb/awesome-ci-semver`
+to test against github-actions source the env-template `. ./tests/.env-template-github`
 
 ## How to test the software
 

README.md

@@ -10,15 +10,15 @@
 
 ## Usage
 
-You can use this tool in your CI pipeline or locally on your command line. Just [download](https://github.com/eksrvb/awesome-ci/releases/latest/download/awesome-ci) the most recently released version and get started. You can find out how to integrate this into your respective pipeline in the following document. There are also several examples in the [examples section](https://eksrvb.github.io/awesome-ci/docs/examples) of the documentation. If an example is not included, please feel free to inquire about a related [issue](https://github.com/eksrvb/awesome-ci/issues/new/choose).
+You can use this tool in your CI pipeline or locally on your command line. Just [download](https://github.com/fullstack-devops/awesome-ci/releases/latest/download/awesome-ci) the most recently released version and get started. You can find out how to integrate this into your respective pipeline in the following document. There are also several examples in the [examples section](https://fullstack-devops.github.io/awesome-ci/docs/examples) of the documentation. If an example is not included, please feel free to inquire about a related [issue](https://github.com/fullstack-devops/awesome-ci/issues/new/choose).
 
-If more functionality is needed you can just open a problem in this project and of course bugs can be fixed in the same way by filing a [bug report](https://github.com/eksrvb/awesome-ci/issues/new/choose).
+If more functionality is needed you can just open a problem in this project and of course bugs can be fixed in the same way by filing a [bug report](https://github.com/fullstack-devops/awesome-ci/issues/new/choose).
 
-If you have any questions, you can find a form on the issue board. First, make sure your question is already in the [Questions and Answers](https://eksrvb.github.io/awesome-ci/docs/questions_and_answers) section before asking a question. You can find frequently asked questions there too.
+If you have any questions, you can find a form on the issue board. First, make sure your question is already in the [Questions and Answers](https://fullstack-devops.github.io/awesome-ci/docs/questions_and_answers) section before asking a question. You can find frequently asked questions there too.
 
 ## Documentation
 
-[See the manual](https://eksrvb.github.io/awesome-ci/) for setup, usage instructions and a lot more. (the documentation is still rising)
+[See the manual](https://fullstack-devops.github.io/awesome-ci/) for setup, usage instructions and a lot more. (the documentation is still rising)
 
 ## Getting help
 

docs/commands/index.md

@@ -31,7 +31,7 @@ You can find out more about the subcommands by clicking on the relevant one in t
 
 | Subcommand                                                                         | Description                                             |
 | ---------------------------------------------------------------------------------- | ------------------------------------------------------- |
-| [release](https://eksrvb.github.io/awesome-ci/commands/createRelease.html)         | creates a release at GitHub or GitLab                   |
-| [pr](https://eksrvb.github.io/awesome-ci/commands/getBuildInfos.html)              | prints out any git information and can manipulate these |
-| [parseJSON](https://eksrvb.github.io/awesome-ci/commands/parseJSON.html)           | can parse simple JSON files                             |
-| [parseYAML](https://eksrvb.github.io/awesome-ci/commands/parseYAML.html)           | can parse simple YAML files                             |
+| [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                             |

docs/commands/release.md

@@ -29,7 +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 |
-| `-upload`           | (only available in publish) uploads the given Artifacts to a release. Eg.: `file=out/awesome-ci` |
+| `-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              |
 
 
@@ -51,13 +51,13 @@ This can be useful in connection with `-version` when creating a manual release.
 awesome-ci createRelease -patchLevel feature
 ```
 
-#### -upload
+#### -assets
 
-The `-patchLevel` option can updload a single or multiple artifacts.
+The `-assets` option can updload a single or multiple artifacts.
 
 However, you must choose the format of the artefacts.
 
-eg.: `-uploadArtifacts "file=path/to/file,file=path/to/second/file"`
+eg.: `-assets "file=path/to/file,file=path/to/second/file"`
 
 
 ... more documentation to be done ;)

docs/examples/github_actions.md

@@ -18,64 +18,106 @@ nav_order: 1
 </details>
 
 
-### Build and publish npm packages
+### Build a Release
+
+This is an example from th awesome-ci project you can find the original workflow [here](https://github.com/fullstack-devops/awesome-ci/blob/main/.github/workflows/Release.yaml)
+
 ```yaml
-name: Publish
+name: Publish Release
 
 on:
   push:
-    branches:    
-    - 'master'
+    branches:
+      - "main"
+    paths-ignore:
+      - "README.md"
+      - 'docs/**'
+      - '.github/ISSUE_TEMPLATE/**'
+      - '.github/PULL_REQUEST_TEMPLATE.md'
+
 
 jobs:
-  setup:
-    runs-on: nodejs
+  generate_infos:
+    runs-on: ubuntu-latest
+    outputs:
+      releaseid: $\{\{ steps.tag.outputs.releaseid \}\}
+      version: $\{\{ steps.tag.outputs.version \}\}
+      pr: $\{\{ steps.tag.outputs.pr \}\}
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v1
-      - uses: eksrvb/awesome-ci@main
-      - uses: actions/setup-node@v2
-        with:
-          node-version: '14.x'
-          registry-url: 'https://registry.npmjs.org'
-      - name: install npm packages
-        run: npm install
-      - name: package Applikation
-        run: npm run build
-      name: DryRun Release
-        run: ./awesome-ci createRelease -publishNpm dist/my-project/
+      - name: Check out the repo
+        uses: actions/checkout@v2
+      - name: Setup awesome-ci
+        uses: fullstack-devops/awesome-ci-action@main
+
+      - name: collect infos and create release
+        run: |
+          awesome-ci pr info
+          awesome-ci release create # making a draft
         env:
           GITHUB_TOKEN: $\{\{ secrets.GITHUB_TOKEN \}\}
-```
 
-### Build and upload a go project
-```yaml
-name: Publish
+      - name: collect infos
+        id: tag
+        shell: bash
+        run: |
+          echo "::set-output name=version::$ACI_VERSION"
+          echo "::set-output name=pr::$ACI_PR"
+          echo "::set-output name=releaseid::$ACI_RELEASE_ID"
 
-on:
-  push:
-    branches:    
-    - 'master'
-
-jobs:
   build:
     runs-on: ubuntu-latest
+    needs: generate_infos
+    strategy:
+      matrix:
+        arch: ["amd64", "arm64"]
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
-      - uses: eksrvb/awesome-ci@main
       - name: Set up Go
         uses: actions/setup-go@v2
         with:
-          go-version: 1.15
-      - name: set environment variables
-        run: awesome-ci getBuildInfos
+          go-version: 1.17
+
+      - name: Build "$\{\{ matrix.arch \}\}"
+        run: go build -v -ldflags "-X main.version=$\{\{ needs.generate_infos.outputs.version \}\}" -o out/awesome-ci_$\{\{ needs.generate_infos.outputs.version \}\}_$\{\{ matrix.arch \}\}
         env:
-          GITHUB_TOKEN: $\{\{ secrets.GITHUB_TOKEN \}\}
-      - name: Build and write version to binary
-        run: go build -v -ldflags "-X main.version=$NEXT_VERSION"
-      - name: Create Release and upload
-        run: ./awesome-ci createRelease -uploadArtifacts file=my-compiled-binary
+          GOOS: linux
+          GOARCH: "$\{\{ matrix.arch \}\}"
+
+      - name: Cache build outputs
+        uses: actions/cache@v2
+        env:
+          cache-name: cache-outputs-modules
+        with:
+          path: out/
+          key: awesome-ci-$\{\{ github.sha \}\}-$\{\{ hashFiles('out/awesome-ci*') \}\}
+          restore-keys: |
+            awesome-ci-$\{\{ github.sha \}\}
+
+  publish_release:
+    runs-on: ubuntu-latest
+    needs: [generate_infos, build]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Setup awesome-ci
+        uses: fullstack-devops/awesome-ci-action@main
+
+      - name: get cached build outputs
+        uses: actions/cache@v2
+        env:
+          cache-name: cache-outputs-modules
+        with:
+          path: out/
+          key: awesome-ci-$\{\{ github.sha \}\}
+      
+      - name: Publish Release
+        run: awesome-ci release publish -releaseid "$ACI_RELEASE_ID" -assets "file=out/$ARTIFACT1,file=out/$ARTIFACT2"
         env:
           GITHUB_TOKEN: $\{\{ secrets.GITHUB_TOKEN \}\}
-```
+          ACI_RELEASE_ID: $\{\{ needs.generate_infos.outputs.releaseid \}\}
+          ARTIFACT1: awesome-ci_$\{\{ needs.generate_infos.outputs.version \}\}_amd64
+          ARTIFACT2: awesome-ci_$\{\{ needs.generate_infos.outputs.version \}\}_arm64
+```
+
+You need more examples? Please open an issue!

main.go

@@ -67,7 +67,7 @@ func init() {
 	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.PatchLevel, "patchLevel", "", "predefine version to Update")
-	releaseSet.Publish.Fs.StringVar(&releaseSet.Publish.UploadArtifacts, "upload", "", "upload assets to release. eg.: \"file=awesome-ci\"")
+	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")
 	releaseSet.Publish.Fs.BoolVar(&releaseSet.Publish.DryRun, "dry-run", false, "make dry-run before writing version to Git by calling it")
 

src/acigithub/release.go

@@ -56,13 +56,18 @@ func PublishRelease(version string, releaseId int64, uploadArtifacts *string) (e
 	if releaseId == 0 {
 		releaseIdStr, releaseIdBool := os.LookupEnv("ACI_RELEASE_ID")
 		if !releaseIdBool {
-			log.Fatalln("Not release found creating one...")
-			CreateRelease(version, draftFalse)
-		}
-		releaseId, err = strconv.ParseInt(releaseIdStr, 10, 64)
-		if err != nil {
-			fmt.Printf("%s of type %T", releaseIdStr, releaseIdStr)
-			os.Exit(2)
+			log.Println("No release found, creating one...")
+			release, err := CreateRelease(version, false)
+			if err != nil {
+				log.Fatalln(err)
+			}
+			releaseId = *release.ID
+		} else {
+			releaseId, err = strconv.ParseInt(releaseIdStr, 10, 64)
+			if err != nil {
+				fmt.Printf("%s of type %T", releaseIdStr, releaseIdStr)
+				os.Exit(2)
+			}
 		}
 	}
 
@@ -92,10 +97,10 @@ func PublishRelease(version string, releaseId int64, uploadArtifacts *string) (e
 			return err
 		}
 
-		for _, fileAndInfo := range filesAndInfos {
-			fmt.Printf("uploading %s as asset to release", fileAndInfo.Name)
+		for i, fileAndInfo := range filesAndInfos {
+			fmt.Printf("uploading %s as asset to release\n", fileAndInfo.Name)
 			// Upload assets to GitHub Release
-			_, _, err := GithubClient.Repositories.UploadReleaseAsset(
+			relAsset, _, err := GithubClient.Repositories.UploadReleaseAsset(
 				ctx,
 				owner,
 				repo,
@@ -106,6 +111,17 @@ func PublishRelease(version string, releaseId int64, uploadArtifacts *string) (e
 				&fileAndInfo.File)
 			if err != nil {
 				log.Println("error at uploading asset to release: ", err)
+			} else {
+				// export Download URL to env. See: #53
+				envVars, err := OpenEnvFile()
+				if err != nil {
+					log.Println("could open envs:", err)
+				}
+				envVars.Set(fmt.Sprintf("ACI_ARTIFACT_%d_URL", i+1), *relAsset.BrowserDownloadURL)
+				err = envVars.SaveEnvFile()
+				if err != nil {
+					log.Println("could not export atrifact url:", err)
+				}
 			}
 		}
 	}

src/service/release.go

@@ -26,13 +26,13 @@ type ReleaseCreateSet struct {
 }
 
 type ReleasePublishSet struct {
-	Fs              *flag.FlagSet
-	Version         string
-	PatchLevel      string
-	ReleaseId       int64
-	UploadArtifacts string
-	PrNumber        int
-	DryRun          bool
+	Fs         *flag.FlagSet
+	Version    string
+	PatchLevel string
+	ReleaseId  int64
+	Assets     string
+	PrNumber   int
+	DryRun     bool
 }
 
 func ReleaseCreate(args *ReleaseCreateSet) {
@@ -109,7 +109,7 @@ func ReleasePublish(args *ReleasePublishSet) {
 		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.UploadArtifacts)
+		acigithub.PublishRelease(version, args.ReleaseId, &args.Assets)
 	}
 }
 

tests/github_env

@@ -8,4 +8,5 @@ ACI_VERSION=0.7.7
 ACI_LATEST_VERSION=0.7.6
 ACI_OWNER=fullstack-devops
 ACI_REPO=awesome-ci
-ACI_RELEASE_ID=57228901
+ACI_RELEASE_ID=57778494
+ACI_ARTIFACT_0_URL=https://github.com/eksrha/playground/releases/download/2.0.0/awesome-ci