Optimize workflow with outputs (#8)

* Add workflow with outputs

* Optimize workflow

Author: kadiryazici

.github/actions/constants.ts

@@ -0,0 +1,5 @@
+export const OWNER = 'Gitification-App'
+export const REPO = 'gitification'
+export const token = process.env.GITHUB_TOKEN
+export const secret = process.env.CLIENT_SECRET
+export const id = process.env.CLIENT_ID

.github/actions/env.d.ts

@@ -0,0 +1,11 @@
+declare global {
+  namespace NodeJS {
+    interface ProcessEnv {
+      CLIENT_SECRET: string
+      CLIENT_ID: string
+      GITHUB_TOKEN: string
+    }
+  }
+}
+
+export {}

.github/actions/release.ts

@@ -3,43 +3,23 @@ import { fileURLToPath } from 'url'
 import fs from 'node:fs/promises'
 import * as github from '@actions/github'
 import { execaCommand } from 'execa'
-
-declare global {
-  namespace NodeJS {
-    interface ProcessEnv {
-      CLIENT_SECRET: string
-      CLIENT_ID: string
-      GITHUB_TOKEN: string
-    }
-  }
-}
+import { OWNER, REPO, id, secret, token } from './constants'
 
 const dirname = path.dirname(fileURLToPath(import.meta.url))
 const envPath = path.join(dirname, '..', '..', '.env')
 const tauriConfPath = path.join(dirname, '..', '..', 'src-tauri', 'tauri.conf.json')
-const packageJsonPath = path.join(dirname, '..', '..', 'package.json')
-const token = process.env.GITHUB_TOKEN
-const secret = process.env.CLIENT_SECRET
-const id = process.env.CLIENT_ID
 
 const envFileContent = `\
 VITE_CLIENT_SECRET=${secret}
 VITE_CLIENT_ID=${id}
 `
 
 async function run() {
-  const tauriConf = JSON.parse(
+  const { package: { productName, version } } = JSON.parse(
     await fs.readFile(tauriConfPath, 'utf-8'),
   ) as typeof import('../../src-tauri/tauri.conf.json')
 
-  const packageJSON = JSON.parse(
-    await fs.readFile(packageJsonPath, 'utf-8'),
-  ) as typeof import('../../package.json')
-
-  if (packageJSON.version !== tauriConf.package.version)
-    throw new Error('Tauri config and Package JSON versions are not the same, update both of them!')
-
-  const dmgFileName = `Gitification_${packageJSON.version}_universal.dmg`
+  const dmgFileName = `${productName}_${version}_universal.dmg`
 
   const dmgPath = path.join(
     dirname,
@@ -56,33 +36,20 @@ async function run() {
 
   const octokit = github.getOctokit(token)
 
-  try {
-    const remoteRelease = await octokit.rest.repos.getLatestRelease({
-      owner: 'Gitification-App',
-      repo: 'gitification',
-    })
-
-    if (remoteRelease.data.name === packageJSON.version.toString()) {
-      console.log('No version change detected, skipping build.')
-      return
-    }
-  }
-  catch { /* If endpoint throws, it means no release yet */ }
-
   await fs.writeFile(envPath, envFileContent, 'utf-8')
   await execaCommand('pnpm tauri build --target universal-apple-darwin', { stdio: 'inherit' })
 
   const release = await octokit.rest.repos.createRelease({
-    owner: 'Gitification-App',
-    repo: 'gitification',
-    tag_name: packageJSON.version.toString(),
-    name: packageJSON.version.toString(),
-    body: 'Click to view [CHANGELOG](https://github.com/Gitification-App/gitification/blob/main/CHANGELOG.md).',
+    owner: OWNER,
+    repo: REPO,
+    tag_name: version,
+    name: version,
+    body: `Click to view [CHANGELOG](https://github.com/${OWNER}/${REPO}/blob/main/CHANGELOG.md).`,
   })
 
   octokit.rest.repos.uploadReleaseAsset({
-    owner: 'Gitification-App',
-    repo: 'gitification',
+    owner: OWNER,
+    repo: REPO,
     name: dmgFileName,
     release_id: release.data.id,
     // @ts-expect-error type

.github/actions/versionCheck.ts

@@ -0,0 +1,50 @@
+import path from 'path'
+import { fileURLToPath } from 'url'
+import fs from 'node:fs/promises'
+import * as github from '@actions/github'
+import actions from '@actions/core'
+import { compare } from 'compare-versions'
+import { OWNER, REPO, token } from './constants'
+
+const dirname = path.dirname(fileURLToPath(import.meta.url))
+const tauriConfPath = path.join(dirname, '..', '..', 'src-tauri', 'tauri.conf.json')
+const packageJsonPath = path.join(dirname, '..', '..', 'package.json')
+
+async function run() {
+  const tauriConf = JSON.parse(
+    await fs.readFile(tauriConfPath, 'utf-8'),
+  ) as typeof import('../../src-tauri/tauri.conf.json')
+
+  const packageJSON = JSON.parse(
+    await fs.readFile(packageJsonPath, 'utf-8'),
+  ) as typeof import('../../package.json')
+
+  if (packageJSON.version !== tauriConf.package.version)
+    throw new Error('Tauri config and Package JSON versions are not the same, update both of them!')
+
+  const octokit = github.getOctokit(token)
+  const version = packageJSON.version
+
+  try {
+    const { data: remoteReleases } = await octokit.rest.repos.listReleases({
+      owner: OWNER,
+      repo: REPO,
+    })
+
+    const isNewRelease = remoteReleases
+      .filter(release => !release.draft)
+      .every(release => (
+        compare(version, release.tag_name, '>')
+      ))
+
+    if (isNewRelease) {
+      actions.setOutput('isNewRelease', 'true')
+      return
+    }
+  }
+  catch { /* If endpoint throws, it means no release yet */ }
+
+  actions.setOutput('isNewRelease', 'false')
+}
+
+run()

.github/workflows/release.yml

@@ -40,13 +40,23 @@ jobs:
 
       - name: Install dependencies
         run: pnpm install 
+
+      - name: Check if new release
+        id: releaseCheck
+        run: pnpx tsx .github/actions/versionCheck.ts
+        env:
+          CLIENT_SECRET: ${{ secrets.CLIENT_SECRET }}
+          CLIENT_ID: ${{ secrets.CLIENT_ID }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: install Rust stable
+        if: steps.releaseCheck.outputs.isNewRelease == 'true'
         uses: dtolnay/rust-toolchain@stable
         with:
           targets: 'aarch64-apple-darwin,x86_64-apple-darwin'
 
       - name: Run Release
+        if: steps.releaseCheck.outputs.isNewRelease == 'true'
         run: pnpx tsx .github/actions/release.ts
         env:
           CLIENT_SECRET: ${{ secrets.CLIENT_SECRET }}

package.json

@@ -27,6 +27,7 @@
     "package.json"
   ],
   "devDependencies": {
+    "@actions/core": "^1.10.0",
     "@actions/github": "^5.1.1",
     "@antfu/eslint-config": "^0.34.1",
     "@iconify-json/octicon": "^1.1.30",