noah/django_action
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Releases Activity

Updated documentation

Browse Source
This commit is contained in:
Conrad
2020-10-06 16:43:56 +02:00
parent 20e1ffa8a2
commit 62411b35b6
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@@ -10,7 +10,6 @@ A GitHub action for drawing a Django data model automatically.
| -------------- | :------: | :---------------: | ---------------------------------------- | | -------------- | :------: | :---------------: | ---------------------------------------- |
| commit_options | :x: | - | Custom git commit options | | commit_options | :x: | - | Custom git commit options |
| commit_message | :x: | Added data schema | Custom git commit message | | commit_message | :x: | Added data schema | Custom git commit message |
| file_pattern | :x: | \* | Custom git add file pattern |
| output_path | :x: | . | Output path for generated files | | output_path | :x: | . | Output path for generated files |
| pip_path | :x: | requirements.txt | Requirements path for the Django project | | pip_path | :x: | requirements.txt | Requirements path for the Django project |
| project_path | :x: | ./ | The path to manage.py | | project_path | :x: | ./ | The path to manage.py |
@@ -43,6 +42,8 @@ jobs:
with: with:
# This part is also where you can pass other options, for example: # This part is also where you can pass other options, for example:
pip_path: testfolder/app/requirements.txt pip_path: testfolder/app/requirements.txt
project_path: app/
output_path: docs/model.png
``` ```
More documentation for writing a workflow can be found [here](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions). More documentation for writing a workflow can be found [here](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions).