Extend action with supporting relative path for portainer be

.github/workflows/test.yaml

@@ -7,49 +7,49 @@ on:
     branches: [master]
 
 jobs:
-  test:
-    name: "Test"
-    runs-on: ubuntu-latest
-    timeout-minutes: 5
-
-    steps:
-      - name: "Checkout"
-        uses: actions/checkout@v4
-
-      - name: "Write YAML"
-        id: yaml-action
-        uses: teunmooij/yaml@v1
-        with:
-          data: '{"version":"3.8","services":{"alpine":{"image":"alpine","command":"tail -f /dev/null"}}}'
-          to-file: "docker-compose.yaml"
-
-      - name: "Test Local Action"
-        id: test
-        uses: ./
-        with:
-          token: ${{ secrets.PORTAINER_TOKEN }}
-          url: ${{ secrets.PORTAINER_URL }}
-          name: alpine-test
-          file: docker-compose.yaml
-          type: file
-
-      - name: "Echo Output"
-        run: |
-          echo 'stackID: ${{ steps.test.outputs.stackID }}'
-          echo 'swarmID: ${{ steps.test.outputs.swarmID }}'
-          echo 'endpointID: ${{ steps.test.outputs.endpointID }}'
-
-      #- name: "Call API"
-      #  uses: indiesdev/curl@v1.1
-      #  with:
-      #    url: "${{ secrets.PORTAINER_URL }}/api/stacks/${{ steps.test.outputs.stackID }}"
-      #    method: "DELETE"
-      #    accept: 204
-      #    headers: '{ "X-API-Key": "${{ secrets.PORTAINER_TOKEN }}" }'
-      #    params: '{ "endpointId": "${{ steps.test.outputs.endpointID }}" }'
-      #    timeout: 5000
-      #    log-response: true
-      #    retries: 1
+  # test:
+  #   name: "Test"
+  #   runs-on: ubuntu-latest
+  #   timeout-minutes: 5
+
+  #   steps:
+  #     - name: "Checkout"
+  #       uses: actions/checkout@v4
+
+  #     - name: "Write YAML"
+  #       id: yaml-action
+  #       uses: teunmooij/yaml@v1
+  #       with:
+  #         data: '{"version":"3.8","services":{"alpine":{"image":"alpine","command":"tail -f /dev/null"}}}'
+  #         to-file: "docker-compose.yaml"
+
+  #     - name: "Test Local Action"
+  #       id: test
+  #       uses: ./
+  #       with:
+  #         token: ${{ secrets.PORTAINER_TOKEN }}
+  #         url: ${{ secrets.PORTAINER_URL }}
+  #         name: alpine-test
+  #         file: docker-compose.yaml
+  #         type: file
+
+  #     - name: "Echo Output"
+  #       run: |
+  #         echo 'stackID: ${{ steps.test.outputs.stackID }}'
+  #         echo 'swarmID: ${{ steps.test.outputs.swarmID }}'
+  #         echo 'endpointID: ${{ steps.test.outputs.endpointID }}'
+
+      # - name: "Clean up"
+      #   uses: indiesdev/curl@v1.1
+      #   with:
+      #     url: "${{ secrets.PORTAINER_URL }}/api/stacks/${{ steps.test.outputs.stackID }}"
+      #     method: "DELETE"
+      #     accept: 204
+      #     headers: '{ "X-API-Key": "${{ secrets.PORTAINER_TOKEN }}" }'
+      #     params: '{ "endpointId": "${{ steps.test.outputs.endpointID }}" }'
+      #     timeout: 5000
+      #     log-response: true
+      #     retries: 1
 
   lint:
     name: "Lint"
@@ -89,6 +89,7 @@ jobs:
           npm install
           npm run build
 
+      # Remove this
       - name: "Verify"
         run: |
           git status --porcelain dist/

README.md

@@ -50,6 +50,7 @@ _No Portainer?_ You can deploy directly to a docker over ssh with: [cssnr/stack-
 | env_file   | No       | -                     | Dotenv File Path \*     |
 | username   | No       | -                     | Repository Username \*  |
 | password   | No       | -                     | Repository Password \*  |
+| fs_path    | No       | -                     | Relative Path (BE) \*  |
 
 **token** - To create a Portainer API token see: https://docs.portainer.io/api/access
 
@@ -70,6 +71,9 @@ JSON should be an object. Example: `{"KEY": "Value"}`
 **username/password** - Only set these if the `repo` is private and requires authentication.
 This is NOT the Portainer username/password, see `token` for Portainer authentication.
 
+**file_system_path** - Only available in Portainer Business Edition. When specified, enables relative path volumes support 
+and uses the provided path as the base directory for relative volume mappings in your compose file.
+
 ```yaml
 - name: 'Portainer Deploy'
   uses: cssnr/portainer-stack-deploy-action@v1
@@ -151,6 +155,19 @@ Specify environment variables, may use json, or file, or a combination of both:
     env_file: .env
 ```
 
+Deploy with relative path volumes (BE only):
+
+```yaml
+- name: 'Portainer Deploy'
+  uses: cssnr/portainer-stack-deploy-action@v1
+  with:
+      token: ${{ secrets.PORTAINER_TOKEN }}
+      url: https://portainer.example.com:9443
+      name: stack-name
+      file: docker-compose.yaml
+      fs_path: /mnt
+```
+
 To include this in a general workflow but only run on release events use an if:
 
 - `if: ${{ github.event_name == 'release' }}`

action.yml

@@ -62,6 +62,9 @@ inputs:
     description: "Repository Password"
     required: false
     default: ""
+  fs_path:
+    description: "Relative path volume in host (only available in Portainer BE)"
+    required: false
 
 outputs:
   stackID:

dist/index.js

@@ -33839,6 +33839,11 @@ class Portainer {
         })
     }
 
+    async getVersion() {
+        const response = await this.client.get('/status/version')
+        return response.data
+    }
+
     async getEndpoints() {
         const response = await this.client.get('/endpoints')
         return response.data
@@ -40672,9 +40677,22 @@ const Portainer = __nccwpck_require__(1055)
             repositoryUsername || repositoryPassword
         )
         console.log('repositoryAuthentication:', repositoryAuthentication)
+        let fs_path = core.getInput('fs_path')
+        console.log('fs_path:', fs_path)
 
         const portainer = new Portainer(url, token)
 
+        if (fs_path) {
+            // get system info and check if portainer is BE edition
+            const version = await portainer.getVersion()
+            const is_portainer_be = version.ServerEdition === 'EE'
+            if (!is_portainer_be) {
+                return core.setFailed(
+                    'Relative path is only supported on Portainer Business Edition'
+                )
+            }
+        }
+
         if (!endpointID) {
             const endpoints = await portainer.getEndpoints()
             // console.log('endpoints:', endpoints)
@@ -40734,6 +40752,11 @@ const Portainer = __nccwpck_require__(1055)
                     repositoryAuthentication,
                     repositoryPassword,
                     repositoryUsername,
+                    // If fs_path is set, add it to the body
+                    ...(fs_path && { 
+                        supportRelativePath: true,
+                        fileSystemPath: fs_path 
+                    }),
                 }
                 // console.log('body:', body)
                 stack = await portainer.createStackRepo(endpointID, body)

src/index.js

@@ -53,9 +53,22 @@ const Portainer = require('./portainer')
             repositoryUsername || repositoryPassword
         )
         console.log('repositoryAuthentication:', repositoryAuthentication)
+        let fs_path = core.getInput('fs_path')
+        console.log('fs_path:', fs_path)
 
         const portainer = new Portainer(url, token)
 
+        if (fs_path) {
+            // get system info and check if portainer is BE edition
+            const version = await portainer.getVersion()
+            const is_portainer_be = version.ServerEdition === 'EE'
+            if (!is_portainer_be) {
+                return core.setFailed(
+                    'Relative path is only supported on Portainer Business Edition'
+                )
+            }
+        }
+
         if (!endpointID) {
             const endpoints = await portainer.getEndpoints()
             // console.log('endpoints:', endpoints)
@@ -115,6 +128,11 @@ const Portainer = require('./portainer')
                     repositoryAuthentication,
                     repositoryPassword,
                     repositoryUsername,
+                    // If fs_path is set, add it to the body
+                    ...(fs_path && { 
+                        supportRelativePath: true,
+                        fileSystemPath: fs_path 
+                    }),
                 }
                 // console.log('body:', body)
                 stack = await portainer.createStackRepo(endpointID, body)

src/portainer.js

@@ -17,6 +17,11 @@ class Portainer {
         })
     }
 
+    async getVersion() {
+        const response = await this.client.get('/status/version')
+        return response.data
+    }
+
     async getEndpoints() {
         const response = await this.client.get('/endpoints')
         return response.data