Merge pull request #1654 from PokeAPI/paths

Limit builds in cicd

Author: Naramsim

.github/FUNDING.yml

@@ -1,12 +1 @@
-# These are supported funding model platforms
-
-github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
-patreon: # Replace with a single Patreon username
 open_collective: pokeapi
-ko_fi: # Replace with a single Ko-fi username
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
-issuehunt: # Replace with a single IssueHunt username
-otechie: # Replace with a single Otechie username
-custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/workflows/code-quality.yml

@@ -2,22 +2,18 @@ name: Code Quality
 
 on:
   pull_request:
-    paths:
+    paths: &paths
       - "**.py"
       - "**.toml"
-      - "Makefile"
-      - "uv.lock"
-      - ".github/workflows/code-quality.yml"
+      - "**.lock"
+      - Makefile
+      - .github/actions/setup-uv/action.yml
+      - .github/workflows/code-quality.yml
   push:
     branches-ignore:
       - master
       - staging
-    paths:
-      - "**.py"
-      - "**.toml"
-      - "Makefile"
-      - "uv.lock"
-      - ".github/workflows/code-quality.yml"
+    paths: *paths
 
 jobs:
   ruff:

.github/workflows/database.yml

@@ -2,10 +2,22 @@ name: Database
 
 on:
   pull_request:
+    paths: &paths
+      - "**.py"
+      - "**.toml"
+      - "**.lock"
+      - "data/**"
+      - "Resources/docker/app/Dockerfile"
+      - "Resources/nginx/**"
+      - "docker-compose**"
+      - Makefile
+      - .github/actions/setup-uv/action.yml
+      - .github/workflows/database.yml
   push:
     branches-ignore:
       - master
       - staging
+    paths: *paths
 
 jobs:
   csv:
@@ -66,19 +78,14 @@ jobs:
         with:
           submodules: recursive
       - name: Build and start services
-        run: |
-          docker compose -f docker-compose.yml -f docker-compose-dev.yml up -d --build
+        run: make docker-dev-up
       - name: Run migrations and build database
         run: |
           make docker-migrate
           make docker-build-db
       - name: Dump DB
-        run: docker compose exec -T db pg_dump -U ash -Fc -N 'hdb_*' pokeapi > pokeapi.dump
-      - name: Drop and recreate database
-        run: |
-          docker compose exec -T db psql -U ash -d postgres -c "DROP DATABASE pokeapi WITH (FORCE);"
-          docker compose exec -T db psql -U ash -d postgres -c "CREATE DATABASE pokeapi;"
+        run: make docker-dump-db
       - name: Import database
-        run: docker compose exec -T db pg_restore -U ash -d pokeapi < pokeapi.dump
+        run: make docker-restore-db
       - name: Test data
         run: curl -Ss http://localhost/api/v2/pokemon/1/ | grep -q 'bulbasaur'

.github/workflows/docker-build-and-push.yml

@@ -2,9 +2,15 @@ name: Publish
 
 on:
   push:
+    paths:
+      - "**.py"
+      - "**.toml"
+      - "**.lock"
+      - "Resources/docker/**"
+      - .github/workflows/docker-build-and-push.yml
     branches:
-      - 'master'
-      - 'staging'
+      - master
+      - staging
     tags:
       - '*.*.*'
 
@@ -28,7 +34,6 @@ jobs:
         id: buildx
         uses: docker/setup-buildx-action@v3
       - name: Login to DockerHub
-        if: github.event_name != 'pull_request'
         uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME_NARAMSIM }}

.github/workflows/docker-k8s.yml

@@ -2,6 +2,17 @@ name: Container
 
 on:
   pull_request:
+    paths:
+      - "**.py"
+      - "**.toml"
+      - "**.lock"
+      - "data/**"
+      - "docker-compose**"
+      - "Resources/docker/**"
+      - "Resources/k8s/**"
+      - "Resources/kind/**"
+      - Makefile
+      - .github/workflows/docker-k8s.yml
 
 jobs:
   docker:
@@ -107,8 +118,8 @@ jobs:
         uses: actions/checkout@v6
       - name: Build dev environment
         run: |
-          docker compose -f docker-compose.yml -f docker-compose-dev.yml up -d
-          sleep 30
+          make docker-dev-up
+          sleep 5
       - name: Assert containers running
         run: |
           last_command=$(docker ps | grep 'pokeapi-' | wc -l)

.github/workflows/nix-environment.yml

@@ -2,9 +2,17 @@ name: Nix Environment
 
 on:
   pull_request:
+    paths: &paths
+      - "**.py"
+      - "**.toml"
+      - "**.lock"
+      - default.nix
+      - Makefile
+      - .github/workflows/nix-environment.yml
   push:
     branches:
       - master
+    paths: *paths
 
 jobs:
   nix-test:

.github/workflows/release.yml

@@ -2,6 +2,14 @@ name: Release
 
 on:
   push:
+    paths:
+      - "**.py"
+      - "**.toml"
+      - "**.lock"
+      - "data/**"
+      - Makefile
+      - .github/actions/setup-uv/action.yml
+      - .github/workflows/release.yml
     branches:
       - master
     tags:
@@ -18,27 +26,24 @@ jobs:
           submodules: recursive
       - name: Start pokeapi (docker)
         run: |
-          docker compose -f docker-compose.yml -f docker-compose-dev.yml up -d
+          make docker-dev-up
           make docker-migrate
           make docker-build-db
       - name: Dump PG db
-        run: docker compose exec -T -u postgres db sh -c "cd /tmp && pg_dump -h localhost -Fc -U ash -N 'hdb_*' pokeapi > pokeapi.pgdump"
-      - name: Copy PG dump
-        run: |
-          docker compose cp db:/tmp/pokeapi.pgdump ./
-          ls -larth
+        run: make docker-dump-db
+      - name: List folder
+        run: ls -larth
       - name: Setup uv
         uses: ./.github/actions/setup-uv
-      - name: Start pokeapi
+      - name: Generate SQLite db
         run: |
           rm -rf .venv
           make install-base
           make setup
           make build-db
-          nohup make serve &
           sleep 3
       - name: Release tag
-        uses: softprops/action-gh-release@v3.0.1
+        uses: softprops/action-gh-release@v3.0.2
         if: startsWith(github.ref, 'refs/tags/')
         with:
           draft: true
@@ -48,7 +53,7 @@ jobs:
             db.sqlite3
           generate_release_notes: true
       - name: Release master branch
-        uses: softprops/action-gh-release@v3.0.1
+        uses: softprops/action-gh-release@v3.0.2
         if: github.ref == 'refs/heads/master'
         with:
           body: |

CONTRIBUTORS.txt

@@ -62,6 +62,9 @@ openapi-generate: check-uv
 docker-up:  # (Docker) Create services/volumes/networks
 	docker compose up -d
 
+docker-dev-up:  # (Docker) Build local pokeapi image and create services/volumes/networks
+	docker compose -f docker-compose.yml -f docker-compose-dev.yml up -d --build
+
 docker-migrate:  # (Docker) Run any pending migrations
 	docker compose exec -T app python manage.py migrate ${docker_config}
 
@@ -95,6 +98,14 @@ docker-prod:
 
 docker-setup: docker-up docker-migrate docker-build-db  # (Docker) Start services, prepare the latest DB schema, populate the DB
 
+docker-dump-db:
+	docker compose exec -T db pg_dump -U ash -Fc -N 'hdb_*' pokeapi > pokeapi.pgdump
+
+docker-restore-db:
+	docker compose exec -T db psql -U ash -d postgres -c "DROP DATABASE pokeapi WITH (FORCE);"
+	docker compose exec -T db psql -U ash -d postgres -c "CREATE DATABASE pokeapi;"
+	docker compose exec -T db pg_restore -U ash -d pokeapi < pokeapi.pgdump
+
 format: check-uv   # Format the source code
 	uv run ruff format .