README.md

Django Action

A GitHub action for drawing a Django data model automatically.

Usage

Parameters

Parameter	Required	Default	Description
commit_message	❌	Updated data schema	Custom git commit message
output_path	❌	.	Output path for generated files (see 'Example Config' for example)
pip_path	❌	requirements.txt	Requirements path for the Django project
project_path	❌	./	The path to manage.py (see 'Example Config' for example)

Note: The output_path has to exist already.

Example Config

name: Continuous Integration

# This action works with pull requests and pushes
on:
  pull_request:
  push:
    branches:
      - master

jobs:
  graph-models:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v2
        with:
          # Make sure the actual branch is checked out when running on pull requests
          ref: ${{ github.head_ref }}

      - name: Generate Data Schema
        uses: noah-software/[email protected]
        with:
          # This part is also where you can pass other options, for example:
          pip_path: testfolder/app/requirements.txt
          project_path: app/
          output_path: docs/model.png

More documentation for writing a workflow can be found here.

Issues

Please report all bugs and feature request using the GitHub issues function. Thanks!