Merge pull request #4 from edenlabllc/feature/RMK-2-refactoring-relea…

…se-notes #2 - add release notes file, change release notes publishing template…
edenlabllc · May 31, 2024 · afc2a43 · afc2a43
2 parents dec6b1c + 0f5f0a2
commit afc2a43
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 7 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -90,6 +90,7 @@ jobs:
       - name: Copy metadata RMK release
         run: |
           cp ./dist/metadata.json ./bin/metadata.json
+          echo "RELEASE_NOTES=$(cat docs/release-notes.md)" >> "${GITHUB_ENV}"
 
       - name: Run GoReleaser
         uses: goreleaser/goreleaser-action@v5

diff --git a/.goreleaser.yml b/.goreleaser.yml
@@ -7,6 +7,12 @@ release:
     owner: edenlabllc
     name: rmk
   name_template: '{{.ProjectName}}-v{{.Version}}'
+  prerelease: auto
+  header: |
+    ## Release notes:
+      {{ .Env.RELEASE_NOTES }}
+
+    [More info...](https://github.com/edenlabllc/{{ .ProjectName }}/blob/v{{ .Version }}/README.md)
 before:
   hooks:
 #    - go get ./...
@@ -97,27 +103,28 @@ announce:
     # Message template to use while publishing.
     # Defaults to `{{ .ProjectName }} {{ .Tag }} is out! Check it out at {{ .ReleaseURL }}`
     message_template: |
-      *Released new version of {{ .ProjectName }}: `{{.Tag}}`*
+      *Released a new version of {{ toupper .ProjectName }}: `{{ .Tag }}`*
       *Release notes:*
-        - Code base transferred from private to public GitHub repository.
-        - Changed S3 bucket name for RMK artifact.  
+      {{- range (split .Env.RELEASE_NOTES "\n") }}
+        {{ . }}
+      {{- end }}
 
 
-      Installation of latest RMK version:
+      Installation of the latest RMK version:
       ```
       curl -sL "https://edenlabllc-rmk.s3.eu-north-1.amazonaws.com/rmk/s3-installer" | bash
       rmk --version
       ```
-      Installation of specific RMK version:
+      Installation of a specific RMK version:
       ```
       curl -sL "https://edenlabllc-rmk.s3.eu-north-1.amazonaws.com/rmk/s3-installer" | bash -s -- "${RMK_VERSION}"
       rmk --version
       ```
-      Update to latest RMK version:
+      Update to the latest RMK version:
       ```
       rmk update
       ```
-      Update to the specific RMK version:
+      Update to a specific RMK version:
       ```
       rmk update --version vX.X.X
       ```

diff --git a/docs/release-notes.md b/docs/release-notes.md
@@ -0,0 +1 @@
+- #2 - Added release notes file, changed release notes publishing template via GoReleaser.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		- #2 - Added release notes file, changed release notes publishing template via GoReleaser.