Code

Add API documentation workflow#3281

Code

Closed

varshadr wants to merge 17 commits intodevelopmathesar-foundation/mathesar:developfrom 3278-automate-api-documentation-generation-with-github-actionsmathesar-foundation/mathesar:3278-automate-api-documentation-generation-with-github-actionsCopy head branch name to clipboard

+42

Commits

Commits on Nov 1, 2023

• Implemented workflow to automate api documentation

  varshadr

  committed
  3daa6e7

• fixed event name

  varshadr

  committed
  a80b8f2

Commits on Nov 2, 2023

• .github/workflows/update-api-docs.yml

  varshadr

  committed
  371355f

• changed the trigger event and checkout branch

  varshadr

  committed
  1732e58

• changed the commit message to 'updated the schema file'

  varshadr

  committed
  75db2a7

• Set MATHESAR_DATABASES environment variable

  varshadr

  committed
  f3d3a5a

• Update workflow to use Python shell

  varshadr

  committed
  267c901

• Customize shell for docs generation

  varshadr

  committed
  962c2f9

• fixed 'shell' indentation

  varshadr

  committed
  096eb94

• Updated workflow to run the ./manage.py spectacular --color --file schema.yml command in the mathesar_service_dev container.

  varshadr

  committed
  bea6a12

• fixes the error 'the input device is not a TTY'

  varshadr

  committed
  82dc7ec

• added workflow to copy the env file

  varshadr

  committed
  fc57242

• Update workflow to start dev-service container in detached mode

  varshadr

  committed
  106e911

• Update workflow file to use the official GitHub Actions bot username and email address

  varshadr

  committed
  b804f57

• Added a Checkout step to the beginning of the workflow file.

  varshadr

  committed
  ae81c32

• Update workflow to only commit and push changes to remote branch if schema file has changed.

  varshadr

  committed
  27d4f1c

• updated name of the step to Start Docker Compose

  varshadr

  committed
  75961f7