first draft

Author: holyjak

Dockerfile

@@ -0,0 +1,7 @@
+FROM clojure:tools-deps
+
+COPY check.sh /check.sh
+
+RUN clojure -Ttools install io.github.cljdoc/cljdoc-analyzer '{:git/tag "v1.0.695"}' :as cljdoc
+
+ENTRYPOINT ["bash", "/check.sh"]

README.md

@@ -1,2 +1,33 @@
-# cljdoc-check-action
+# CljDoc Check Action
+
 GitHub Action for checking that CljDoc will be able to analyze the project successfully
+
+NOTE: CljDoc only works on the JAR archive of the library so you need to build it first.
+
+Checking a clojure-deps based library is as simple as:
+
+```yaml
+name: Check Cljdoc
+on: [pull_request]
+jobs:
+  check-cljdoc:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name Build target/<the lib>*.jar so that CljDoc analyze can use it:
+        run: clojure -T:build jar # REPALCE with whatever you do to build your jar
+      - name: CljDoc Check
+          uses: cljdoc/cljdoc-check-action@v1
+```
+
+For other types of libraries, you need to install these into the local Maven repository (e.g. via `lein install`) and pass it the Maven coordinate and version:
+
+```yaml
+# inside jobs.<name>.steps
+- run: lein install # or whatever is usitable for your build tool/project, to install the library into a maven repo
+- name: CljDoc Check
+    uses: cljdoc/cljdoc-check-action@v1
+    with:
+      mvn_project: io.aviso/pretty
+      mvn_version: LATEST
+```

action.yml

@@ -0,0 +1,30 @@
+# ref: https://help.github.com/en/actions/building-actions/metadata-syntax-for-github-actions
+name: CljDoc Check Action
+description: Check that CljDoc will be able to analyze the project successfully 
+
+author: Jakub Holý
+
+branding:
+  color: blue
+  icon: check-square
+
+inputs:
+  action:
+    required: false
+    description: 'The check action to run - analyze-local for deps-based projects, analyze for others'
+    default: 'analyze-local'
+  mvn_project:
+    required: false
+    description: 'Required for `analyze` - the maven group-id/project-id of the library to check; ex.: io.aviso/pretty'
+  mvn_version:
+    required: false
+    description: 'Required for `analyze` - the maven version of the library to check; ex.: 0.1.29-SNAPSHOT'
+
+
+runs:
+  using: docker
+  image: Dockerfile
+  args:
+    - -e action=${{ inputs.action }}
+    - -e mvn_project=${{ inputs.mvn_project }}
+    - -e mvn_version=${{ inputs.mvn_version }}

check.sh

@@ -0,0 +1,16 @@
+set -x
+set -e
+die {
+    echo "ERROR: $1"
+    exit -1;
+}
+
+if [ "$action" -eq "analyze" ]; then
+    echo "Running 'analyze :project $mvn_project :version $mvn_version' to check a libary installed into a Maven repo"
+    [ -n "$mvn_project" ] || die 'Missing argument mvn_project that is required for action=analyze'
+    [ -n "$mvn_version" ] || die 'Missing argument mvn_version that is required for action=analyze'
+    clojure -Tcljdoc :download true analyze :project \""$mvn_project"\" :version \""$mvn_version"\"
+else
+  echo "Running 'analyze-local' to check the deps.edn based project in the current directory..."
+  clojure -Tcljdoc analyze-local
+fi