Updates (#15)

* Fix Password Login

* Prevent Hanging on Error

* Add Job Summary

* Improve Output

* Add Test to Cron

* Update Workflows

Author: smashedr

.github/workflows/lint.yaml

@@ -0,0 +1,35 @@
+name: "Lint"
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches: [master]
+
+jobs:
+  lint:
+    name: "Lint"
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+
+    steps:
+      - name: "Checkout"
+        uses: actions/checkout@v4
+
+      #- name: "Debug event.json"
+      #  run: |
+      #    cat "${GITHUB_EVENT_PATH}"
+
+      - name: "ShellCheck"
+        if: ${{ always() }}
+        uses: ludeeus/action-shellcheck@master
+        env:
+          SHELLCHECK_OPTS: -x
+        with:
+          scandir: src
+
+      - name: "Prettier"
+        if: ${{ always() }}
+        run: |
+          npm install prettier
+          npx prettier --check .

.github/workflows/mirror.yaml

@@ -2,8 +2,6 @@ name: "Mirror"
 
 on:
   workflow_dispatch:
-  release:
-    types: ["published"]
   push:
     branches: ["**"]
     tags: ["**"]
@@ -21,7 +19,7 @@ jobs:
           fetch-depth: 0
 
       - name: "Mirror to Codeberg"
-        uses: cssnr/mirror-repository-action@master
+        uses: cssnr/mirror-repository-action@v1
         with:
           host: https://codeberg.org
           create: true

.github/workflows/release.yaml

@@ -0,0 +1,17 @@
+name: "Release"
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  release:
+    name: "Release"
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    permissions:
+      contents: write
+
+    steps:
+      - name: "Update Tags"
+        uses: cssnr/update-version-tags-action@v1

.github/workflows/tags.yaml

@@ -1,17 +1,23 @@
 name: "Tags"
 
 on:
-  release:
-    types: [published]
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: "Target Tag"
+        required: true
 
 jobs:
   tags:
     name: "Tags"
     runs-on: ubuntu-latest
     timeout-minutes: 5
+    permissions:
+      contents: write
 
     steps:
       - name: "Update Tags"
         uses: cssnr/update-version-tags-action@v1
         with:
-          token: ${{ secrets.GITHUB_TOKEN }}
+          tag: ${{ inputs.tag }}
+          token: ${{ secrets.GH_PAT }}

.github/workflows/test.yaml

@@ -2,30 +2,45 @@ name: "Test"
 
 on:
   workflow_dispatch:
-  pull_request:
+  schedule:
+    - cron: "23 23 * * 4"
   push:
-    branches: [master]
+    paths:
+      - "src/**"
+      - ".github/workflows/test.yaml"
+      - "Dockerfile"
+      - "action.yaml"
 
 env:
   PRIVATE_IMAGE: "smashedr/alpine-private:latest" # amd64/arm64
 
 jobs:
   test:
     name: "Test"
+    if: ${{ !contains(github.event.head_commit.message, '#notest') }}
     runs-on: ubuntu-latest
     timeout-minutes: 5
+    concurrency:
+      group: test
+      cancel-in-progress: true
 
     steps:
       - name: "Checkout"
         uses: actions/checkout@v4
 
-      - name: "Write YAML Basic"
+      #- name: "Debug event.json"
+      #  run: |
+      #    cat "${GITHUB_EVENT_PATH}"
+
+      - name: "1: Write YAML"
+        if: ${{ always() }}
         uses: teunmooij/yaml@v1
         with:
           data: '{"version":"3.8","services":{"alpine":{"image":"alpine:latest","command":"tail -f /dev/null"}}}'
           to-file: "docker-compose.yaml"
 
-      - name: "Test Action Basic"
+      - name: "1: Test Password"
+        if: ${{ always() }}
         id: test1
         uses: ./
         with:
@@ -34,16 +49,18 @@ jobs:
           host: ${{ secrets.DOCKER_HOST }}
           port: ${{ secrets.DOCKER_PORT }}
           user: ${{ secrets.DOCKER_USER }}
-          #pass: ${{ secrets.DOCKER_PASS }}
-          ssh_key: "${{ secrets.DOCKER_SSH_KEY }}"
+          pass: ${{ secrets.DOCKER_PASS }}
+          #ssh_key: "${{ secrets.DOCKER_SSH_KEY }}"
 
-      - name: "Write YAML Private"
+      - name: "2: Write YAML"
+        if: ${{ always() && !github.event.act }}
         uses: teunmooij/yaml@v1
         with:
           data: '{"version":"3.8","services":{"alpine":{"image":"${{ env.PRIVATE_IMAGE }}","command":"tail -f /dev/null"}}}'
           to-file: "docker-compose.yaml"
 
-      - name: "Test Action Private"
+      - name: "2: Test SSH and Auth"
+        if: ${{ always() && !github.event.act }}
         id: test2
         uses: ./
         with:
@@ -54,20 +71,6 @@ jobs:
           user: ${{ secrets.DOCKER_USER }}
           #pass: ${{ secrets.DOCKER_PASS }}
           ssh_key: "${{ secrets.DOCKER_SSH_KEY }}"
-          #registry_host: "ghcr.io"
           registry_user: ${{ vars.DOCKER_HUB_USER }}
           registry_pass: ${{ secrets.DOCKER_HUB_PASS }}
-
-  lint:
-    name: "Lint"
-    runs-on: ubuntu-latest
-    timeout-minutes: 5
-
-    steps:
-      - name: "Checkout"
-        uses: actions/checkout@v4
-
-      - name: "ShellCheck"
-        uses: ludeeus/action-shellcheck@master
-        with:
-          scandir: src
+          summary: false

.prettierignore

@@ -0,0 +1,8 @@
+# IDE
+.idea/
+.vscode/
+
+# Tools
+.ruff_cache/
+.mypy_cache/
+.pytest_cache/

CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contributing
+
+> [!WARNING]  
+> This guide is a work in progress and may not be complete.
+
+This is a basic contributing guide and is a work in progress.
+
+## Workflow
+
+1. Fork the repository.
+2. Create a branch in your fork!
+3. Make your changes.
+4. [Test](#Testing) your changes.
+5. Commit and push your changes.
+6. Create a PR to this repository.
+7. Verify the tests pass, otherwise resolve.
+8. Make sure to keep your branch up-to-date.
+
+## Testing
+
+GitHub is easier to set up, but you have to push your commits to test.  
+Running locally is harder to set up, but it is much easier to test; and by far recommended!
+
+### GitHub
+
+Add your secrets to GitHub Actions Secrets.
+
+When you push your branch to your repository, the [test.yaml](.github/workflows/test.yaml) should run...
+
+### Locally
+
+To run actions locally you need to install act: https://nektosact.com/installation/index.html
+
+1. Create a `.secrets` file with all your secrets in .env file format.
+2. Run: `act -j test`
+
+To test the private image you must create a `.env` file with, or use --env `PRIVATE_IMAGE=yourimage`
+
+To skip the private image test run with `-e event.json`.
+
+To print your secrets in plan text (insecure) use `--insecure-secrets`
+
+To see all available jobs run `act -l` and see `act --help`
+
+```shell
+act -j test --insecure-secrets -e event.json
+act -j test --insecure-secrets --env PRIVATE_IMAGE=your/private-image:latest
+act -j lint
+```
+
+For more information see the documentation: https://nektosact.com/usage/index.html

Dockerfile

@@ -1,7 +1,7 @@
-FROM docker:24-dind
+FROM docker:28-dind
 
 RUN apk add --update --no-cache bash sshpass
 
-COPY src/main.sh /main.sh
+COPY src/ /src
 
-ENTRYPOINT ["bash", "/main.sh"]
+ENTRYPOINT ["bash", "/src/main.sh"]