Add basic files

.dockerignore

@@ -0,0 +1,2 @@
+/.git
+/.github

.editorconfig

@@ -0,0 +1,8 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

.github/workflows/build.yml

@@ -0,0 +1,12 @@
+name: Build docker image
+
+on: [push]
+
+jobs:
+    build-action:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v2
+            - name: Build action image
+              run: docker build ./

.github/workflows/doctum.yml

@@ -0,0 +1,13 @@
+name: build doctum docs
+on: [push]
+
+jobs:
+    sync:
+        runs-on: ubuntu-latest
+        steps:
+            - name: build doctum docs
+              uses: sudo-bot/action-doctum@v5
+              with:
+                  config-file: doctum.php
+                  method: "update"
+                  cli-args: "--output-format=github --no-ansi --no-progress"

.gitignore

@@ -0,0 +1 @@
+/.env

Dockerfile

@@ -0,0 +1,11 @@
+FROM php:cli-alpine
+
+ARG RELEASE_VERSION=latest
+
+COPY entrypoint.sh /entrypoint.sh
+
+ADD https://doctum.long-term.support/releases/${RELEASE_VERSION}/doctum.phar /bin/doctum
+
+RUN echo "Downloaded release version: ${RELEASE_VERSION}" && chmod +x /bin/doctum && php /bin/doctum --version
+
+ENTRYPOINT ["/entrypoint.sh"]

README.md

@@ -2,3 +2,15 @@
 
 [Doctum](https://github.com/code-lts/doctum#readme)
 
+## Example usage
+
+```yml
+  - name: build doctum docs
+    uses: sudo-bot/action-doctum@v5
+    with:
+        config-file: doctum.php
+        # parse, render or update
+        method: "update"
+        # You can change them, defaults to '--output-format=github --no-ansi --no-progress' (optional)
+        cli-args: "--output-format=github --no-ansi --no-progress"
+```

action.yml

@@ -0,0 +1,29 @@
+name: "Use Doctum"
+author: williamdes
+description: "Use Doctum without having to install it"
+inputs:
+    config-file:
+        description: "The configuration file"
+        required: true
+    method:
+        description: "parse, render or update"
+        required: true
+    cli-args:
+        description: "Command line arguments"
+        default: '--output-format=github --no-ansi --no-progress'
+        required: false
+    docker-version:
+        description: "The docker image to use"
+        default: 'latest'
+        required: false
+
+branding:
+    icon: "book"
+    color: blue
+runs:
+    using: "docker"
+    image: "docker://botsudo/action-doctum:${{ inputs.docker-version }}"
+    args:
+        - "${{ inputs.config-file }}"
+        - "${{ inputs.method }}"
+        - "${{ inputs.cli-args }}"

entrypoint.sh

@@ -0,0 +1,17 @@
+#!/bin/sh -l
+##
+# @license http://unlicense.org/UNLICENSE The UNLICENSE
+# @author William Desportes <[email protected]>
+##
+
+set -e
+
+CONFIG_FILE="$1"
+METHOD="$2"
+CLI_ARGS="$3"
+
+echo "::debug CONFIG_FILE: ${CONFIG_FILE}"
+echo "::debug METHOD: ${METHOD}"
+echo "::debug CLI_ARGS: ${CLI_ARGS}"
+
+php /bin/doctum ${METHOD} ${CLI_ARGS} ${CONFIG_FILE}