Merge pull request #1 from getshifter/comment

Write comment for workflow

Author: wokamoto

.gitattributes

@@ -0,0 +1 @@
+.github/* export-ignore

.github/workflows/release.yml

@@ -1,30 +1,69 @@
+# Workflow Document: https://help.github.com/en/articles/workflow-syntax-for-github-actions
+
+# This workflow detects a tag push to Github, it will automatically upload the package to github releases.
 name: release
 
+# see: https://help.github.com/en/articles/workflow-syntax-for-github-actions#on
 on:
   create:
-    tags:
+    tags: []
+    # - v*.*.*  # to use filters. wildcard characters supported.
 
+# https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobs
 jobs:
   release:
     name: Release
+
+    # https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idruns-on
     runs-on: ubuntu-latest
+
+    # https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idsteps
     steps:
+
+    # [official action] clone code to workspace
+    # https://github.com/actions/checkout
     - uses: actions/checkout@v1
+
+
+    # install modules by composer. remove this step it if no needed.
     - name: composer install
       run: composer install
+
+    # install modules by npm.
+    # - name: npm clean install
+    #   run: npm ci
+
+    # remove this step if you want to update the version manually.
+    # NOTICE: ref_type exists only for events of type create. see https://developer.github.com/v3/activity/events/types/#createevent
     - name: add version
+      env:
+        PACKAGE_NAME: "shifter-github-hosting-plugin-sample"
       run: |
+        # retrieve tag and replase version number in file.
         export CREATE_EVENT_REF_TYPE=$(jq --raw-output .ref_type "$GITHUB_EVENT_PATH")
         export TAGNAME=$(jq --raw-output .ref "$GITHUB_EVENT_PATH")
-        sed -i -e "s/{release version}/${TAGNAME}/g" shifter-github-hosting-plugin-sample.php
+        sed -i -e "s/{release version}/${TAGNAME}/g" ${PACKAGE_NAME}.php
+
+    # create zip acrive for install to WordPress.
+    # please edit FILES_TO_ARCIVE to suit your project.
     - name: create archive
-      run: zip -r shifter-github-hosting-plugin-sample.zip *.php *.md vendor/*
-    - name: upload
       env:
+        PACKAGE_NAME: "shifter-github-hosting-plugin-sample"
+        FILES_TO_ARCIVE: "*.php *.md vendor/*"
+      run: zip -r ${PACKAGE_NAME}.zip ${FILES_TO_ARCIVE}
+
+    # upload zip arvive by ghr.
+    # `secrets.GITHUB_TOKEN` for using ghr is issued temporarily when executing action. No special settings are required.
+    # ghr - Easily ship your project to your user using Github Releases : https://deeeet.com/ghr/
+    - name: upload to github release
+      env:
+        PACKAGE_NAME: "shifter-github-hosting-plugin-sample"
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         GOPATH: /home/runner/go
       run: |
+        # retrieve tag and replase version number in file.
         export CREATE_EVENT_REF_TYPE=$(jq --raw-output .ref_type "$GITHUB_EVENT_PATH")
         export TAGNAME=$(jq --raw-output .ref "$GITHUB_EVENT_PATH")
+        # install ghr, then upload archve.
         go get -u github.com/tcnksm/ghr
-        ${GOPATH}/bin/ghr -replace ${TAGNAME} shifter-github-hosting-plugin-sample.zip
+        ${GOPATH}/bin/ghr -b "${PACKAGE_NAME} ${TAGNAME}" -replace ${TAGNAME} ${PACKAGE_NAME}.zip