Add input of upload release switch and output of file related informa…

…tion (#158) * Output release_asset_dir for use by other workflows * Fix release_name bug * Allow release_asset_dir to be used in INPUT_POST_COMMAND * Fix typo & Add option to upload release or not * Drop release_asset_path/release_asset_name/release_asset_file * Update README.md * Bug fix
wangyoucao577 · Feb 7, 2024 · 5efa231 · 5efa231
1 parent 19d6983
commit 5efa231
Show file tree

Hide file tree

Showing 3 changed files with 57 additions and 25 deletions.
diff --git a/README.md b/README.md
@@ -52,7 +52,7 @@ jobs:
         goarch: amd64
 ```
 
-### Parameters
+### Input Parameters
 
 | Parameter | **Mandatory**/**Optional** | Description |
 | --------- | -------- | ----------- |
@@ -80,6 +80,14 @@ jobs:
 | retry | **Optional** | How many times retrying if upload fails. `3` by default. |
 | post_command | **Optional** | Extra command that will be executed for teardown work. e.g. you can use it to upload artifacts to AWS s3 or aliyun OSS |
 | compress_assets | **Optional** | `auto` default will produce a `zip` file for Windows and `tar.gz` for others. `zip` will force the use of `zip`. `OFF` will disable packaging of assets. |
+| upload | **Optional** | Upload release or not upload. If you need to use subsequent workflow to process the file, you can choose not to upload the release. |
+
+### Output Parameters
+
+| Parameter | Description |
+| --------- | -------- |
+| release_asset_dir | Release file directory provided for use by other workflows. |
+
 
 ### Advanced Example
 

diff --git a/action.yml b/action.yml
@@ -99,6 +99,14 @@ inputs:
     description: 'Compress assets before uploading'
     required: false
     default: 'TRUE'
+  upload:
+    description: 'Upload release or not upload'
+    required: false
+    default: 'TRUE'
+
+outputs:
+  release_asset_dir:
+    description: 'Release file directory provided for use by other workflows'
 
 runs:
   using: 'docker'

diff --git a/release.sh b/release.sh
@@ -17,7 +17,11 @@ elif [ ! -z "${INPUT_RELEASE_NAME}" ]; then # prevent upload-asset by tag due to
   RELEASE_TAG=""
 fi
 
-RELEASE_NAME=${INPUT_RELEASE_NAME}
+if [ ! -z "${INPUT_RELEASE_NAME}" ]; then
+  RELEASE_NAME=${INPUT_RELEASE_NAME}
+else
+  RELEASE_NAME=$(jq -r '.release.name' ${GITHUB_EVENT_PATH})
+fi
 
 RELEASE_ASSET_NAME=${BINARY_NAME}-${RELEASE_TAG}-${INPUT_GOOS}-${INPUT_GOARCH}
 if [ ! -z "${INPUT_GOAMD64}" ]; then
@@ -97,7 +101,8 @@ fi
 
 # build
 BUILD_ARTIFACTS_FOLDER=build-artifacts-$(date +%s)
-mkdir -p ${INPUT_PROJECT_PATH}/${BUILD_ARTIFACTS_FOLDER}
+RELEASE_ASSET_DIR=${INPUT_PROJECT_PATH}/${BUILD_ARTIFACTS_FOLDER}
+mkdir -p ${RELEASE_ASSET_DIR}
 cd ${INPUT_PROJECT_PATH}
 if [[ "${INPUT_BUILD_COMMAND}" =~ ^make.* ]]; then
     # start with make, assumes using make to build golang binaries, execute it directly
@@ -125,7 +130,7 @@ fi
 # prepare extra files
 if [ ! -z "${INPUT_EXTRA_FILES}" ]; then
   cd ${GITHUB_WORKSPACE}
-  cp -r ${INPUT_EXTRA_FILES} ${INPUT_PROJECT_PATH}/${BUILD_ARTIFACTS_FOLDER}/
+  cp -r ${INPUT_EXTRA_FILES} ${RELEASE_ASSET_DIR}/
   cd ${INPUT_PROJECT_PATH}
 fi
 
@@ -135,52 +140,63 @@ ls -lha
 # INPUT_COMPRESS_ASSETS=='TRUE' is used for backwards compatability. `AUTO`, `ZIP`, `OFF` are the recommended values
 if [ ${INPUT_COMPRESS_ASSETS^^} == "TRUE" ] || [ ${INPUT_COMPRESS_ASSETS^^} == "AUTO" ] || [ ${INPUT_COMPRESS_ASSETS^^} == "ZIP" ]; then
   # compress and package binary, then calculate checksum
-  RELEASE_ASSET_EXT='.tar.gz'
-  MEDIA_TYPE='application/gzip'
-  RELEASE_ASSET_FILE=${RELEASE_ASSET_NAME}${RELEASE_ASSET_EXT}
   if [ ${INPUT_GOOS} == 'windows' ] || [ ${INPUT_COMPRESS_ASSETS^^} == "ZIP" ]; then
     RELEASE_ASSET_EXT='.zip'
     MEDIA_TYPE='application/zip'
     RELEASE_ASSET_FILE=${RELEASE_ASSET_NAME}${RELEASE_ASSET_EXT}
-    ( shopt -s dotglob; zip -vr ${RELEASE_ASSET_FILE} * )
+    RELEASE_ASSET_PATH="../${RELEASE_ASSET_FILE}"
+    ( shopt -s dotglob; zip -vr ${RELEASE_ASSET_PATH} * )
   else
-    ( shopt -s dotglob; tar cvfz ${RELEASE_ASSET_FILE} * )
+    RELEASE_ASSET_EXT='.tar.gz'
+    MEDIA_TYPE='application/gzip'
+    RELEASE_ASSET_FILE=${RELEASE_ASSET_NAME}${RELEASE_ASSET_EXT}
+    RELEASE_ASSET_PATH="../${RELEASE_ASSET_FILE}"
+    ( shopt -s dotglob; tar cvfz ${RELEASE_ASSET_PATH} * )
   fi
 elif [ ${INPUT_COMPRESS_ASSETS^^} == "OFF" ] || [ ${INPUT_COMPRESS_ASSETS^^} == "FALSE" ]; then
   RELEASE_ASSET_EXT=${EXT}
   MEDIA_TYPE="application/octet-stream"
   RELEASE_ASSET_FILE=${RELEASE_ASSET_NAME}${RELEASE_ASSET_EXT}
-  cp ${BINARY_NAME}${EXT} ${RELEASE_ASSET_FILE}
+  RELEASE_ASSET_PATH=${RELEASE_ASSET_FILE}
+  cp ${BINARY_NAME}${EXT} ${RELEASE_ASSET_PATH}
 else
   echo "Invalid value for INPUT_COMPRESS_ASSETS: ${INPUT_COMPRESS_ASSETS} . Acceptable values are AUTO,ZIP, or OFF."
   exit 1
 fi
-MD5_SUM=$(md5sum ${RELEASE_ASSET_FILE} | cut -d ' ' -f 1)
-SHA256_SUM=$(sha256sum ${RELEASE_ASSET_FILE} | cut -d ' ' -f 1)
+MD5_SUM=$(md5sum ${RELEASE_ASSET_PATH} | cut -d ' ' -f 1)
+SHA256_SUM=$(sha256sum ${RELEASE_ASSET_PATH} | cut -d ' ' -f 1)
 
 # prefix upload extra params
 GITHUB_ASSETS_UPLOADR_EXTRA_OPTIONS=''
 if [ ${INPUT_OVERWRITE^^} == 'TRUE' ]; then
     GITHUB_ASSETS_UPLOADR_EXTRA_OPTIONS="-overwrite"
 fi
 
-# update binary and checksum
-github-assets-uploader -logtostderr -f ${RELEASE_ASSET_FILE} -mediatype ${MEDIA_TYPE} ${GITHUB_ASSETS_UPLOADR_EXTRA_OPTIONS} -repo ${RELEASE_REPO} -token ${INPUT_GITHUB_TOKEN} -tag=${RELEASE_TAG} -releasename=${RELEASE_NAME} -retry ${INPUT_RETRY}
-if [ ${INPUT_MD5SUM^^} == 'TRUE' ]; then
-MD5_EXT='.md5'
-MD5_MEDIA_TYPE='text/plain'
-echo ${MD5_SUM} >${RELEASE_ASSET_FILE}${MD5_EXT}
-github-assets-uploader -logtostderr -f ${RELEASE_ASSET_FILE}${MD5_EXT} -mediatype ${MD5_MEDIA_TYPE} ${GITHUB_ASSETS_UPLOADR_EXTRA_OPTIONS} -repo ${RELEASE_REPO} -token ${INPUT_GITHUB_TOKEN} -tag=${RELEASE_TAG} -releasename=${RELEASE_NAME} -retry ${INPUT_RETRY}
-fi
+if [ ${INPUT_UPLOAD^^} == 'TRUE' ]; then
+    # update binary and checksum
+    github-assets-uploader -logtostderr -f ${RELEASE_ASSET_PATH} -mediatype ${MEDIA_TYPE} ${GITHUB_ASSETS_UPLOADR_EXTRA_OPTIONS} -repo ${RELEASE_REPO} -token ${INPUT_GITHUB_TOKEN} -tag=${RELEASE_TAG} -releasename=${RELEASE_NAME} -retry ${INPUT_RETRY}
+    if [ ${INPUT_MD5SUM^^} == 'TRUE' ]; then
+    MD5_EXT='.md5'
+    MD5_MEDIA_TYPE='text/plain'
+    echo ${MD5_SUM} >${RELEASE_ASSET_PATH}${MD5_EXT}
+    github-assets-uploader -logtostderr -f ${RELEASE_ASSET_PATH}${MD5_EXT} -mediatype ${MD5_MEDIA_TYPE} ${GITHUB_ASSETS_UPLOADR_EXTRA_OPTIONS} -repo ${RELEASE_REPO} -token ${INPUT_GITHUB_TOKEN} -tag=${RELEASE_TAG} -releasename=${RELEASE_NAME} -retry ${INPUT_RETRY}
+    fi
 
-if [ ${INPUT_SHA256SUM^^} == 'TRUE' ]; then
-SHA256_EXT='.sha256'
-SHA256_MEDIA_TYPE='text/plain'
-echo ${SHA256_SUM} >${RELEASE_ASSET_FILE}${SHA256_EXT}
-github-assets-uploader -logtostderr -f ${RELEASE_ASSET_FILE}${SHA256_EXT} -mediatype ${SHA256_MEDIA_TYPE} ${GITHUB_ASSETS_UPLOADR_EXTRA_OPTIONS} -repo ${RELEASE_REPO} -token ${INPUT_GITHUB_TOKEN} -tag=${RELEASE_TAG} -releasename=${RELEASE_NAME} -retry ${INPUT_RETRY}
+    if [ ${INPUT_SHA256SUM^^} == 'TRUE' ]; then
+    SHA256_EXT='.sha256'
+    SHA256_MEDIA_TYPE='text/plain'
+    echo ${SHA256_SUM} >${RELEASE_ASSET_PATH}${SHA256_EXT}
+    github-assets-uploader -logtostderr -f ${RELEASE_ASSET_PATH}${SHA256_EXT} -mediatype ${SHA256_MEDIA_TYPE} ${GITHUB_ASSETS_UPLOADR_EXTRA_OPTIONS} -repo ${RELEASE_REPO} -token ${INPUT_GITHUB_TOKEN} -tag=${RELEASE_TAG} -releasename=${RELEASE_NAME} -retry ${INPUT_RETRY}
+    fi
 fi
 
+ls -lha ../
+
+# output path for use by other workflows (e.g.: actions/upload-artifact)
+echo "release_asset_dir=${RELEASE_ASSET_DIR}" >> "${GITHUB_OUTPUT}"
+
 # execute post-command if exist, e.g. upload to AWS s3 or aliyun OSS
 if [ ! -z "${INPUT_POST_COMMAND}" ]; then
+    INPUT_POST_COMMAND=${INPUT_POST_COMMAND/"{RELEASE_ASSET_DIR}"/${RELEASE_ASSET_DIR}}
     eval ${INPUT_POST_COMMAND}
 fi