📝 Document usage

Author: sergei-maertens

README.md

@@ -0,0 +1,48 @@
+# setup-django-backend Github workflow action
+
+This composite workflow action takes care of some boilerplate for Maykin's Djanog
+projects:
+
+* Setting up Python (with pip cache)
+* Installing backend dependencies
+* Tuning PostgreSQL for faster test running
+* Setting up NodeJS and npm + building the client-side code
+
+## Example usage:
+
+```yaml
+jobs:
+  tests:
+    name: Run the Django test suite
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres:14
+        env:
+          POSTGRES_HOST_AUTH_METHOD: trust
+        ports:
+          - 5432:5432
+        # Needed because the postgres container does not provide a healthcheck
+        options:
+          --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+          --name postgres
+      redis:
+        image: redis:6
+        ports:
+          - 6379:6379
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up backend environment
+        uses: maykinmedia/setup-django-backend@main
+        with:
+          apt-packages: 'libxml2-dev libxmlsec1-dev libxmlsec1-openssl gettext postgresql-client'
+          python-version: '3.10'
+          optimize-postgres: 'yes'
+          pg-service: 'postgres'
+          setup-node: 'yes'
+          npm-ci-flags: '--legacy-peer-deps'
+
+      - name: Run tests
+        run: ...
+```

action.yml

@@ -28,6 +28,11 @@ inputs:
     required: false
     default: ''
 
+  setup-node:
+    description: Whether to setup node and npm packages.
+    required: false
+    default: 'yes'
+
   npm-ci-flags:
     description: Additional arguments for the 'npm ci' command.
     required: false
@@ -37,6 +42,7 @@ runs:
   using: 'composite'
   steps:
     - name: Install OS dependencies
+      if: ${{ inputs.apt-packages }}
       run: |
         sudo apt-get update
         sudo apt-get install --yes ${{ inputs.apt-packages }}
@@ -79,10 +85,12 @@ runs:
 
     # TODO: enable cache
     - uses: actions/setup-node@v3
+      if: ${{ inputs.setup-node == 'yes' }}
       with:
         node-version-file: '.nvmrc'
 
     - name: Build frontend
+      if: ${{ inputs.setup-node == 'yes' }}
       run: |
         npm ci ${{ inputs.npm-ci-flags }}
         npm run build