Merge pull request #2602 from IFRCGo/feat/add-artifact-submodule

feat(submodule): add submodule for assets

Author: szabozoltan69

.github/go-api-artifacts-add-or-replace.sh

@@ -1,4 +1,10 @@
-Addresses xxxxxx
+## Addresses
+- https://github.com/IFRCGo/go-api/issues/XXXX
+- ...
+
+## Related PRs
+- https://github.com/IFRCGo/go-api-artifacts/pull/XXXX
+- ...
 
 ## Changes
 
@@ -13,4 +19,4 @@ Things that should succeed before merging.
 
 ## Release
 
-If there is a version update, make sure to tag the repository with the latest version.
+If there is a version update, make sure to tag the repository with the latest version.

.github/pull_request_template.md

@@ -59,6 +59,8 @@ jobs:
 
     steps:
       - uses: actions/checkout@main
+        with:
+          submodules: true
 
       - name: Login to GitHub Container Registry
         uses: docker/login-action@v3
@@ -139,30 +141,18 @@ jobs:
         run: docker compose run --rm serve ./manage.py test --keepdb -v 2 --pattern="test_fake.py"
 
       # NOTE: Schema generation requires a valid database. Therefore, this step must run after "Run Django migrations."
-      - name: 🕮 Generate latest openapi schema
+      - name: Validate latest OpenAPI schema.
         env:
           DOCKER_IMAGE: ${{ steps.prep.outputs.tagged_image }}
           DJANGO_DB_NAME: "test_test"
-        run: |
-          docker compose run --rm serve ./manage.py spectacular --file openapi-schema-latest.yaml
 
-      - name: 🕮 Upload latest openapi schema to IFRCGo/go-api-artifacts
-        env:
-          # Github
-          # NOTE: `GO_API_ARTIFACTS_TOKEN` has an expiry date. Please follow `docs/go-artifacts.md` for token rotation.
-          GITHUB_TOKEN: ${{ secrets.GO_API_ARTIFACTS_TOKEN }}
-          GITHUB_OWNER: IFRCGo
-          GITHUB_REPO: go-api-artifacts
-          GITHUB_BRANCH: main
-          # File
-          SOURCE_FILE_PATH: openapi-schema-latest.yaml
         run: |
-          COMMIT_SHA="${{ github.event.pull_request.head.sha || github.sha }}"
-          export DEST_FILE_PATH="generated/$COMMIT_SHA/openapi-schema.yaml"
-          export COMMIT_MESSAGE="Add openapi-schema of $GITHUB_REF_NAME@$COMMIT_SHA"
-          .github/go-api-artifacts-add-or-replace.sh
-          DEST_FILE_URL="https://github.com/$GITHUB_OWNER/$GITHUB_REPO/blob/$GITHUB_BRANCH/$DEST_FILE_PATH"
-          echo "::notice::Uploaded latest openapi-schema to: ${DEST_FILE_URL}"
+          docker compose run --rm serve ./manage.py spectacular --file openapi-schema-latest.yaml &&
+          cmp --silent ./assets/openapi-schema.yaml openapi-schema-latest.yaml || {
+            echo 'The openapi-schema is not up to date with the latest changes. Please update and push latest';
+            diff ./assets/openapi-schema.yaml openapi-schema-latest.yaml;
+            exit 1;
+          }
 
       - name: 🤞 Run Test 🧪
         env:

.github/workflows/ci.yml

@@ -0,0 +1,3 @@
+[submodule "assets"]
+	path = assets
+	url = https://github.com/IFRCGo/go-api-artifacts

.gitmodules

@@ -4,29 +4,39 @@ https://github.com/IFRCGo/go-api-artifacts
 
 ## What is this?
 
-This is a **GitHub repository** used to store and manage **build files**, **generated files**, or **automation results** made by other tools or workflows (like GitHub Actions or CI/CD pipelines).
+This is a **GitHub repository** used to store and manage **build files**, **generated files**, or **automation results**.
 
 - Why use this?
   - Keeps the main source code clean by storing big or auto-made files separately.
-  - Other projects (like go-web-app) can download the required files as required.
-
-## Creating a PAT Token
-
-A GitHub PAT (Personal Access Token) is needed to upload files to the `go-api-artifacts` repository.
-This token is stored in the GitHub Actions secret: `secrets.GO_API_ARTIFACTS_TOKEN`.
-For more details, see [ci.yml](/.github/workflows/ci.yml).
-
-> [!Important]
-> Currently, the PAT token is created using the https://github.com/ifrcgo-dev account.
-
-### How to create a new token:
-
-- **Go to**: [GitHub Personal Access Tokens](https://github.com/settings/personal-access-tokens)
-- **Token name**: `ifrc-go-artifacts-xyz` (replace `xyz` as needed)
-- **Resource owner**: `IFRCGO`
-- **Expiration**: No expiration
-- **Repository access**: Only select repositories
-  - Select: `IFRCGo/go-api-artifacts`
-- **Permissions**:
-  - **Repository permissions**:
-    - **Contents**: Read and write
+  - It helps avoid high costs from Git LFS - See https://github.com/IFRCGo/go-api/pull/2470#issuecomment-2861654878 
+
+> [!Note]
+> Previously, GitHub Actions in go-api or related projects uploaded artifacts automatically from CI using a Personal Access Token (PAT).
+> Now, CI only checks the current schema against the schema in **go-api-artifacts**.
+> **go-api-artifacts** is used as a submodule in **go-api**.
+
+## Developer Workflow
+
+### openapi-schema.yaml
+- Generate Schema File locally: 
+  - The required artifact files (e.g., `openapi-schema.yaml` file) should be generated in the local clone of the go-api-artifacts repository.
+- Commit and Push Schema:
+  - The generated files should be pushed to the go-api-artifacts repository.
+- Update Submodule Reference:
+  - The commit reference should be updated in the main repo.
+
+Command
+```bash
+docker compose run --rm serve ./manage.py spectacular --file .assets/openapi-schema.yaml
+```
+
+### 🚨 Manually added files
+
+- In `go-api-artifacts`
+  - For any files **other than `openapi-schema.yaml`**
+  - Create a **new branch** in the `go-api-artifacts` repo.
+  - Add the files there.
+  - Open a **Pull Request in the `go-api-artifacts` repository**.
+- In `go-api`
+  - **Update the submodule reference** in your `go-api` PR.
+  - In the corresponding **`go-api` Pull Request**, include the link to the `go-api-artifacts` PR as a *related PR* so reviewers can track both changes together.