Merge pull request #4 from pollenjp/feature/publish-prepare

update

Author: pollenjp

README.md

@@ -1,3 +1,19 @@
 # setup-shfmt
 
-- Install shfmt and cache it for GitHub Actions
+- Install [shfmt](https://github.com/mvdan/sh) and cache it for GitHub Actions
+- Caching makes it especially efficient when using self-hosted runners
+
+## Usage
+
+```yaml
+jobs:
+  shfmt:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: pollenjp/setup-shfmt@v1
+        with:
+          version: latest
+      - uses: actions/checkout@v4
+      - name: Run shfmt
+        run: shfmt -d .
+```

action.yml

@@ -1,4 +1,4 @@
-name: 'setup-shfmt'
+name: 'setup-shfmt-action'
 description: 'Install shfmt and cache it for GitHub Actions'
 author: 'pollenJP'
 

badges/coverage.svg

@@ -1,7 +1,7 @@
 {
   "name": "setup-shfmt",
   "description": "Install shfmt and cache it for GitHub Actions",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "author": "pollenJP",
   "private": true,
   "homepage": "https://github.com/pollenjp/setup-shfmt",

dist/index.js

@@ -2,3 +2,4 @@ export const REPO = 'sh'
 export const OWNER = 'mvdan'
 export const TOOL_CACHE_NAME = 'shfmt'
 export const CMD_NAME = 'shfmt'
+export const RETRY_COUNT = 3

dist/index.js.map

@@ -2,7 +2,13 @@ import * as core from '@actions/core'
 import * as tc from '@actions/tool-cache'
 import * as os from 'os'
 import { versionInput } from './inputs'
-import { CMD_NAME, OWNER, REPO, TOOL_CACHE_NAME } from './constants'
+import {
+  CMD_NAME,
+  OWNER,
+  REPO,
+  TOOL_CACHE_NAME,
+  RETRY_COUNT
+} from './constants'
 import { exec } from 'child_process'
 export const setupShfmt = async (): Promise<void> => {
   const version = await getVersion(versionInput)
@@ -43,9 +49,21 @@ const getVersion = async (version: string): Promise<string> => {
   switch (version) {
     case 'latest': {
       // curl -s https://api.github.com/repos/mvdan/sh/releases/latest | jq -r '.tag_name'
-      const response = await fetch(
-        `https://api.github.com/repos/${OWNER}/${REPO}/releases/latest`
-      )
+
+      const response = await (async () => {
+        for (let i = 0; i < RETRY_COUNT; i++) {
+          try {
+            return await fetch(
+              `https://api.github.com/repos/${OWNER}/${REPO}/releases/latest`
+            )
+          } catch (error) {
+            core.warning(
+              `Failed to get the latest version of shfmt. (${(error as Error).message}) Retry... ${i + 1}/${RETRY_COUNT}`
+            )
+          }
+        }
+        throw new Error('Failed to get the latest version of shfmt.')
+      })()
       const releaseResponse: ReleaseResponse =
         (await response.json()) as ReleaseResponse
       const tagName: string = releaseResponse.tag_name