feat: Add sameCommitPolicy option (#213)

Co-authored-by: François Best <github@francoisbest.com>

Author: jereze

.github/workflows/pr-preview.yml

@@ -28,19 +28,21 @@ jobs:
 
             // Only create comment if it doesn't exist
             if (!approvalComment) {
+              const body = `<!-- approval-request-comment -->
+              ## ⚠️ &nbsp;Manual approval required
+
+              A repository owner must approve the Docker preview deployment for this PR.
+
+              **PR Author:** @${{ github.event.pull_request.user.login }}
+              **Head SHA:** \`${{ github.event.pull_request.head.sha }}\`
+
+              [Review and approve in Actions →](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})`;
+
               await github.rest.issues.createComment({
                 owner: context.repo.owner,
                 repo: context.repo.repo,
                 issue_number: context.issue.number,
-                body: `<!-- approval-request-comment -->
-                ## ⚠️ &nbsp;Manual approval required
-
-                A repository owner must approve the Docker preview deployment for this PR.
-
-                **PR Author:** @${{ github.event.pull_request.user.login }}
-                **Head SHA:** \`${{ github.event.pull_request.head.sha }}\`
-
-                [Review and approve in Actions →](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})`
+                body
               });
             }
 

README.md

@@ -10,20 +10,20 @@ GitHub action to deploy your application to [Clever Cloud](https://clever-cloud.
 ## Prerequisite
 
 ⚠️ When creating an application on Clever Cloud, you have to choose
-between deploying "*from a local repository*" (using Clever CLI, Git
-or SFTP) or "*from a Github repository*" (using a webhook setup
+between deploying "_from a local repository_" (using Clever CLI, Git
+or SFTP) or "_from a Github repository_" (using a webhook setup
 automatically by Clever Cloud). Only the first type of applications
 can be deployed using this Github action.
 
 In your project's `.clever.json`, if the `deploy_url` value starts
 with `https://github.com/`, your application is meant to be deployed
-"*from a Github repository*" only.
+"_from a Github repository_" only.
 If you try deploying it with this Github action, you will get the
 following message in your logs: `[ERROR] HTTP Error: 401 Authorization
 Required`.
 
 Currently (early 2023), the only workaround is to create a new
-application on Clever Cloud, that deploys "*from a local repository*",
+application on Clever Cloud, that deploys "_from a local repository_",
 then remove the Clever Cloud webhook that has been created on your
 Github repository.
 
@@ -102,8 +102,9 @@ $ cat ~/.config/clever-cloud/clever-tools.json
 ```
 
 4. In your repository settings, [add the following secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets):
-  - `CLEVER_TOKEN`: the `token` value in the credentials
-  - `CLEVER_SECRET`: the `secret` value in the credentials
+
+- `CLEVER_TOKEN`: the `token` value in the credentials
+- `CLEVER_SECRET`: the `secret` value in the credentials
 
 ## Extra Environment Variables
 
@@ -121,7 +122,7 @@ key=value).
       EGG=spam
     # ^-- ..and the indentation here
   env:
-    CLEVER_TOKEN:  ${{ secrets.CLEVER_TOKEN }}
+    CLEVER_TOKEN: ${{ secrets.CLEVER_TOKEN }}
     CLEVER_SECRET: ${{ secrets.CLEVER_SECRET }}
 ```
 
@@ -158,7 +159,7 @@ regardless of the deployment status:
   with:
     timeout: 1800 # wait at maximum 30 minutes before moving on
   env:
-    CLEVER_TOKEN:  ${{ secrets.CLEVER_TOKEN }}
+    CLEVER_TOKEN: ${{ secrets.CLEVER_TOKEN }}
     CLEVER_SECRET: ${{ secrets.CLEVER_SECRET }}
 ```
 
@@ -178,6 +179,26 @@ Clever Cloud uses a Git remote to perform deploys. By default, if the commit you
     CLEVER_SECRET: ${{ secrets.CLEVER_SECRET }}
 ```
 
+## Same Commit Policy
+
+> Support: introduced in v2.1.0
+
+When the local and remote commits are identical, you can control what happens using the `sameCommitPolicy` option. Possible values are:
+
+- `error` (default): Fail the deployment
+- `ignore`: Skip the deployment silently
+- `restart`: Restart the application without redeploying
+- `rebuild`: Rebuild and redeploy the application
+
+```yml
+- uses: 47ng/actions-clever-cloud@v2.0.0
+  with:
+    sameCommitPolicy: restart
+  env:
+    CLEVER_TOKEN: ${{ secrets.CLEVER_TOKEN }}
+    CLEVER_SECRET: ${{ secrets.CLEVER_SECRET }}
+```
+
 ## Logs
 
 > Support: introduced in v1.3.1
@@ -225,6 +246,7 @@ _Note: this behaviour will be disabled if the `quiet` option is used._
 This action follows [SemVer](https://semver.org/).
 
 To specify the version of the action to use:
+
 - `uses: 47ng/actions-clever-cloud@v2.0.0`: latest stable version
 - `uses: 47ng/actions-clever-cloud@3e5402496b8d6492401ebb3134acfeccc25c3fce`: pinned to a specific Git SHA-1 (check out the [releases](https://github.com/47ng/actions-clever-cloud/releases))
 - `uses: docker://ghcr.io/47ng/actions-clever-cloud:latest`: latest code from master (not recommended, as it may break: hic sunt dracones.)
@@ -258,10 +280,11 @@ Using this action at work ? [Sponsor me](https://github.com/sponsors/franky47) t
 
 ## Deploying a Specific Directory
 
+> Support: introduced in v2.1.0
+
 > ⚠️ Important note about the difference between `working-directory` and `deployPath`:
 >
 > - `working-directory` (GitHub Actions option) : Only changes the directory where the action runs. All files remain available, only the execution context changes.
-> 
 > - `deployPath` (this action's option) : Specifies exactly which files will be sent to Clever Cloud. Allows deploying only a subset of files, like a `dist` or `build` folder.
 
 ### Example
@@ -270,15 +293,16 @@ Using this action at work ? [Sponsor me](https://github.com/sponsors/franky47) t
 # This will NOT deploy only the build folder:
 - uses: 47ng/actions-clever-cloud@v2.0.0
   with:
-    working-directory: ./build    # ❌ Only changes where the action runs
+    working-directory: ./build # ❌ Only changes where the action runs
 
 # This will deploy only the build folder:
 - uses: 47ng/actions-clever-cloud@v2.0.0
   with:
-    deployPath: ./build          # ✅ Only sends these files to Clever Cloud
+    deployPath: ./build # ✅ Only sends these files to Clever Cloud
 ```
 
 This option is particularly useful for:
+
 - Monorepos where you want to deploy a single package
 - Projects where you only want to deploy built/compiled files
 - Filtering which files are sent to Clever Cloud

action.yml

@@ -48,6 +48,12 @@ inputs:
     description: |
       Don't print deployment output to the console. Use this in case your deployment
       may reveal secrets or PII.
+  sameCommitPolicy:
+    required: false
+    description: |
+      What to do when local and remote commit are identical.
+      Possible values: error, ignore, restart, rebuild.
+      If not set, the Clever Cloud CLI default (error) will be used.
 runs:
   using: docker
-  image: docker://ghcr.io/47ng/actions-clever-cloud:2.0.1
+  image: docker://ghcr.io/47ng/actions-clever-cloud:2.1.0

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@47ng/actions-clever-cloud",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "private": true,
   "description": "GitHub Action to deploy to Clever Cloud",
   "license": "MIT",

src/action.ts

@@ -33,7 +33,8 @@ export async function run({
   deployPath,
   logFile,
   quiet = false,
-  extraEnv = {}
+  extraEnv = {},
+  sameCommitPolicy
 }: Arguments): Promise<void> {
   try {
     await checkForShallowCopy()
@@ -90,6 +91,10 @@ export async function run({
       args.push('--force')
     }
 
+    if (sameCommitPolicy) {
+      args.push('--same-commit-policy', sameCommitPolicy)
+    }
+
     if (timeout) {
       let timeoutID: NodeJS.Timeout | undefined
       let timedOut = false

src/arguments.test.ts

@@ -151,3 +151,18 @@ test('deployPath is set from input', () => {
   const args = processArguments()
   expect(args.deployPath).toBe('./packages/backend')
 })
+
+test('sameCommitPolicy is unset by default', () => {
+  process.env.CLEVER_TOKEN = 'token'
+  process.env.CLEVER_SECRET = 'secret'
+  const args = processArguments()
+  expect(args.sameCommitPolicy).toBeUndefined()
+})
+
+test('sameCommitPolicy is set from input', () => {
+  process.env.CLEVER_TOKEN = 'token'
+  process.env.CLEVER_SECRET = 'secret'
+  process.env.INPUT_SAMECOMMITPOLICY = 'restart'
+  const args = processArguments()
+  expect(args.sameCommitPolicy).toBe('restart')
+})

src/arguments.ts

@@ -20,6 +20,7 @@ export type Arguments = {
   deployPath?: string
   logFile?: string
   quiet?: boolean
+  sameCommitPolicy?: string
 }
 
 function throwMissingEnvVar(name: string): never {
@@ -74,6 +75,7 @@ export function processArguments(): Arguments {
   const logFile = core.getInput('logFile') || undefined
   const quiet = core.getBooleanInput('quiet', { required: false })
   const deployPath = core.getInput('deployPath') || undefined
+  const sameCommitPolicy = core.getInput('sameCommitPolicy') || undefined
 
   return {
     token,
@@ -86,6 +88,7 @@ export function processArguments(): Arguments {
     cleverCLI: path.resolve(__dirname, '../node_modules/.bin/clever'),
     extraEnv: listExtraEnv(),
     logFile,
-    quiet
+    quiet,
+    sameCommitPolicy
   }
 }