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

Updated documentation + Adjusted default commit_message

Browse Source
This commit is contained in:
Conrad
2020-10-06 17:04:33 +02:00
parent 96d86388ed
commit ecc49a0807
2 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -7,11 +7,13 @@ A GitHub action for drawing a Django data model automatically.
### Parameters ### Parameters
| Parameter | Required | Default | Description | | Parameter | Required | Default | Description |
| -------------- | :------: | :---------------: | ---------------------------------------- | | -------------- | :------: | :-----------------: | ------------------------------------------------------------------ |
| commit_message | :x: | Added data schema | Custom git commit message | | commit_message | :x: | Updated data schema | Custom git commit message |
| output_path | :x: | . | Output path for generated files | | output_path | :x: | . | Output path for generated files (see 'Example Config' for example) |
| 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 (see 'Example Config' for example) |
> Note: The output_path has to exist already.
### Example Config ### Example Config

2
action.yml
View File

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