Merge pull request #2 from aidmax/dev

Update README and add tests

Author: aidmax

README.md

@@ -1,6 +1,13 @@
-# Structurizr-cli Action
+# structurizr-cli GitHub Action
 
-This action allows you to run `structurizr-cli`.
+This GitHub action allows you to run [structurizr-cli](https://github.com/structurizr/cli), a command line utility for [Structurizr](https://structurizr.com/) that lets you create software architecture models based upon the [C4 model](https://c4model.com/) using a textual [domain specific language (DSL)](https://github.com/structurizr/dsl).
+
+Currently, the action supports the following functionality:
+
+- __Push__ content to a Structurizr workspace (the cloud service or an on-premises installation)
+  - A model and views defined using the [Structurizr DSL](https://github.com/structurizr/dsl)
+  - Markdown/AsciiDoc documentation
+  - Architecture Decision Records (ADRs)
 
 ## Usage
 
@@ -26,10 +33,16 @@ jobs:
         uses: aidmax/structurizr-cli-action
         id: test
         with:
-          id: # required
-          key: # required
-          secret: # required
-          workspace: # required
+          id: # The workspace ID (required)
+          key: # The workspace API key (required)
+          secret: # The workspace API secret (required)
+          workspace: # The path to the workspace JSON file/DSL file(s) (required)
+
+          # optional parameters
+          docs: # The path to the directory containing Markdown/AsciiDoc files to be published (optional)
+          adrs: # The path to the directory containing ADRs (optional)
+          url: # The Structurizr API URL (optional; defaults to https://api.structurizr.com)
+          passphrase: # The passphrase to use (optional; only required if client-side encryption enabled on the workspace)
 ```
 
 ## License

action.yml

@@ -1,10 +1,6 @@
 name: 'structurizr-cli-action'
 description: 'Runs structurizr command line application'
 inputs:
-  command:
-    description: 'Command argument (optional; defaults to push)'
-    required: false
-    default: push
   id:
     description: 'The workspace ID (required)'
     required: true
@@ -34,7 +30,7 @@ runs:
   using: 'docker'
   image: 'Dockerfile'
   args:
-    - ${{ inputs.command }}
+    - 'push'
     - '-id'
     - ${{ inputs.id }}
     - '-key'

tests/doc/adr/0001-record-architecture-decisions.md

@@ -0,0 +1,19 @@
+# 1. Record architecture decisions
+
+Date: 2020-11-25
+
+## Status
+
+Accepted
+
+## Context
+
+We need to record the architectural decisions made on this project.
+
+## Decision
+
+We will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).
+
+## Consequences
+
+See Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools).

tests/doc/adr/0002-implement-as-unix-shell-scripts.md

@@ -0,0 +1,19 @@
+# 2. Implement as Unix shell scripts
+
+Date: 2020-11-25
+
+## Status
+
+Accepted
+
+## Context
+
+The issue motivating this decision, and any context that influences or constrains the decision.
+
+## Decision
+
+The change that we're proposing or have agreed to implement.
+
+## Consequences
+
+What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.

tests/doc/docs/example.md

@@ -0,0 +1 @@
+## Section Title

tests/workspace.dsl

@@ -1,5 +1,8 @@
 workspace "Getting Started" "This is a model of my software system." {
 
+    !adrs doc/adr
+    !docs doc/docs
+
     model {
         user = person "User" "A user of my software system."
         softwareSystem = softwareSystem "Software System" "My software system."