Merge pull request #6 from noah-software/dev

Updated documentation + Adjusted default commit_message

README.md

@@ -6,12 +6,14 @@ A GitHub action for drawing a Django data model automatically.
 
 ### Parameters
 
-| Parameter      | Required |      Default      | Description                              |
-| -------------- | :------: | :---------------: | ---------------------------------------- |
-| commit_message |   :x:    | Added data schema | Custom git commit message                |
-| output_path    |   :x:    |         .         | Output path for generated files          |
-| pip_path       |   :x:    | requirements.txt  | Requirements path for the Django project |
-| project_path   |   :x:    |        ./         | The path to manage.py                    |
+| Parameter      | Required |       Default       | Description                                                        |
+| -------------- | :------: | :-----------------: | ------------------------------------------------------------------ |
+| commit_message |   :x:    | Updated data schema | Custom git commit message                                          |
+| output_path    |   :x:    |          .          | Output path for generated files (see 'Example Config' for example) |
+| pip_path       |   :x:    |  requirements.txt   | Requirements path for the Django project                           |
+| project_path   |   :x:    |         ./          | The path to manage.py (see 'Example Config' for example)           |
+
+> Note: The output_path has to exist already.
 
 ### Example Config
 

action.yml

@@ -7,7 +7,7 @@ inputs:
   commit_message:
     description: Commit message of the changed data
     required: false
-    default: "Added data schema"
+    default: "Updated data schema"
   pip_path:
     description: Path relative to the repository root, where the requirements.txt is located
     required: false

entrypoint.sh

@@ -12,13 +12,14 @@ _git_setup ( ) {
 
 echo "Installing dependencies..."
 pip3 install -U pip wheel pygraphviz
-pip3 install -r "$INPUT_PIP_PATH"
+pip3 install --no-cache-dir -r "$INPUT_PIP_PATH"
 
 echo "Creating data model..."
 cd "$INPUT_PROJECT_PATH"
 python3 manage.py graph_models -a -g -o "$INPUT_OUTPUT_PATH"
 
 # To keep runtime good, just continue if something was changed
+
 if [[ `git status --porcelain` ]]; then
     # Calling method to configure the git environemnt
     _git_setup