Test preview

.github/workflows/release-base.yml

@@ -0,0 +1,65 @@
+name: release-base
+on:
+  workflow_call:
+    inputs:
+      dry_run:
+        required: true
+        type: boolean
+
+jobs:
+  release-base:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+      id-token: write # to enable use of OIDC for npm provenance
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+      - name: Install dependencies
+        run: npm ci
+      - name: Build
+        run: npm run build
+
+      - name: Release Preview
+        if: ${{ inputs.dry_run == true }}
+        id: release-preview
+        run: |
+          # Unset variables for semantic-release to believe we are not in a PR
+          #  (https://github.com/semantic-release/env-ci/blob/master/services/github.js)
+          unset GITHUB_EVENT_NAME
+          unset GITHUB_EVENT_PATH
+          GITHUB_REF=$GITHUB_HEAD_REF
+          npx semantic-release --dry-run --no-ci --branches $GITHUB_REF --debug
+        env:
+          GITHUB_REF: ${{ github.head_ref }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Release summary
+        if: ${{ inputs.dry_run == true }}
+        uses: peter-evans/create-or-update-comment@v5
+        with:
+          issue-number: ${{ github.event.number }}
+          body: |
+            ### 📦 Semantic Release Summary
+
+            - Version: **${{ steps.release-preview.outputs.new-release-version }}**
+            - Tag: **${{ steps.release-preview.outputs.new-release-git-tag }}**
+
+            ---
+
+            ${{ steps.release-preview.outputs.new-release-release-notes }}
+
+      - name: Semantic Release
+        if: ${{ inputs.dry_run == false }}
+        run: npx semantic-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/release-preview.yml

@@ -0,0 +1,12 @@
+name: release-preview
+on:
+  pull_request:
+    branches: [main]
+    types: [opened, synchronize]
+
+jobs:
+  release-preview:
+    uses: ./.github/workflows/release-base.yml
+    with:
+      dry_run: true
+    secrets: inherit

.github/workflows/release-publish.yml

@@ -1,26 +1,13 @@
 name: release-publish
 on:
-  push:
+  pull_request:
     branches: [main]
+    types: [closed]
 
 jobs:
   release:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - name: Setup Node
-        uses: actions/setup-node@v3
-        with:
-          node-version: 16
-      - name: Install dependencies
-        run: npm ci
-      - name: Build
-        run: npm run build
-      - name: Semantic Release
-        uses: cycjimmy/semantic-release-action@v3
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+    if: github.event.pull_request.merged == true
+    uses: ./.github/workflows/release-base.yml
+    with:
+      dry_run: false
+    secrets: inherit

.releaserc.json

@@ -5,6 +5,7 @@
     ["@semantic-release/release-notes-generator", { "writerOpts": { "commitGroupsSort": ["feat", "fix"] } }],
     "@semantic-release/changelog",
     "@semantic-release/npm",
+    "semantic-release-export-data",
     ["@semantic-release/git", { "message": "chore(release): ${nextRelease.version}" }],
     [
       "@saithodev/semantic-release-backmerge",

README.md

@@ -50,9 +50,9 @@ The process will:
 
 - [**init**](/docs/commands.md#init): described above, to initially configure a server.
 - [**deploy**](/docs/commands.md#deploy): deploy a docker/web application from a folder.
+- [**upload**](/docs/commands.md#upload): upload files to the server.
 - [**config**](/docs/commands.md#deploy): read and update configuration values.
 
-
 ## Development
 
 ```sh

docs/commands.md

@@ -1,34 +1,95 @@
 List of available commands
 
 # `init`
-```
+Perform initial configuration on a server
+```sh
 Usage:  rpi init
 
 Initialize server tools and configuration
 ```
 
 # `deploy`
+Deploy an application
+
+## `deploy.dockerc`
+```sh
+Usage:  rpi deploy dockerc [OPTIONS]
+
+Deploy a docker-compose application
+
+Options:
+  --files, -f    List of docker-compose files (default: ["docker-compose.yaml"])
+  --exclude, -e  List of paths to exclude from packaging e.g. "/dev" (default: ["/dev", "/etc"])
+  --dry-run      Verify the list of entries that will be packaged, without performing deploy
+  --logs         Show container logs after the indicated time (seconds). Use value <= 0 to skip (default: 5)
+```
+
+## `deploy.docker`
+```sh
+Usage:  rpi deploy docker <location> [OPTIONS]
+
+Deploy a docker application
+
+Options:
+  --location         Location of the folder containing the application
+  --name             Name to tag the application. By default, the folder/file name will be used
+  --build-on-target  Build docker image on target machine instead of local (default: true)
+  --logs             Show container logs after the indicated time (seconds). Use value <= 0 to skip (default: 5)
+```
+
+Example:
+```sh
+rpi deploy ./dist --name=server -- -e PORT=8080 -p 8080:8080 --privileged --restart=unless-stopped
 ```
-Usage:  rpi deploy <location> [OPTIONS]
 
-Deploy an application from a folder
+> [!TIP]
+> For more complex parameters, transition to a docker-compose.yaml file and simply use `rpi deploy`
+
+## `deploy.web`
+```sh
+Usage:  rpi deploy web <location> [OPTIONS]
+
+Deploy a web application
 
 Options:
   --location         Location of the folder containing the application
-  --type             Type of application to deploy (allowed: "docker", "web", default: "docker")
   --name             Name to tag the application. By default, the folder/file name will be used
   --build-on-target  Build docker image on target machine instead of local (default: true)
-  --vars             List of variables for docker applications in <KEY>=<VALUE> format, e.g. PORT=8080 (default: [])
+  --logs             Show container logs after the indicated time (seconds). Use value <= 0 to skip (default: 5)
+```
+
+# `upload`
+
+```sh
+Usage:  rpi upload <files...> [OPTIONS]
+
+Upload files to the server
+
+Options:
+  --files     Location of the files to upload
+  -d, --dest  Destination path on host (default: "~/registry/")
 ```
 
 # `config`
+Manage configuration
+
+## `config.get`
+```sh
+Usage:  rpi config get [key]
+
+Read configuration values
+
+Options:
+  --key       Configuration key to read
 ```
-Usage:  rpi config <operation> [key] [value]
 
-Read and update configuration values
+## `config.set`
+```sh
+Usage:  rpi config set <key> <value>
+
+Update configuration values
 
 Options:
-  --operation  Operation to execute (default: "get")
-  --key        Configuration key
-  --value      For `set` operation, value to update
+  --key       Configuration key to set
+  --value     Configuration value to set
 ```