CI Artifact Completeness Gate --> GitHub Push → Sentry Artifact Verification → GitHub Commit Status

1.2 Summary (TL;DR)

This workflow acts as a CI/CD quality gate for mobile app crash-symbolication artifacts.
Whenever a new commit is pushed to GitHub, the workflow automatically checks the corresponding Sentry release and confirms whether required build artifacts (dSYM or ProGuard + mapping.txt) exist. If artifacts are complete, it updates the GitHub commit status to success, allowing the PR to be merged. If incomplete, the workflow fails silently (no commit status update), effectively blocking merges.

⚡ Quick Implementation Steps

1. Configure GitHub Trigger for your repo.
2. Add Sentry API credentials.
3. Add GitHub API credentials.
4. Update Sentry project URLs with your org_slug and proj_slug.
5. Ensure your build pipeline uploads artifacts to Sentry before the workflow runs.
6. Activate workflow.

---

1.3 What It Does

This workflow ensures your mobile crash-symbolication artifacts are fully present in Sentry for every release. When a new GitHub push occurs, the workflow:

1. Reads the commit SHA and repo info from the GitHub Push event.
2. Fetches the list of all releases from Sentry.
3. Locates the correct release and fetches its uploaded artifact files.
4. Runs custom validation logic:
   • Success if:
     • a *.dSYM file exists OR
     • both proguard.txt AND mapping.txt are present
   • Failure if:
     • neither dSYM nor both mapping artifacts exist
5. If validated successfully, the commit receives a success status on GitHub → PR can be merged.

This provides a strong CI gate ensuring symbolication completeness and preventing un-debuggable releases.

---

1.4 Who's It For

• Mobile development teams using Sentry for crash reporting
• Engineering teams enforcing strict release-quality gates
• DevOps teams wanting automated artifact validation
• CI/CD pipeline engineers integrating Sentry symbolication checks
• Teams who frequently upload dSYM or ProGuard mapping files

---

1.5 Requirements to Use This Workflow

• n8n instance (cloud or self-hosted)
• GitHub repository access (API credentials)
• Sentry project with:
  • org_slug
  • project_slug
  • Auth Token with release access
• Build process that uploads artifacts to Sentry releases
• The release version must match the format expected by the workflow

---

1.6 How It Works & How To Set Up

Step 1: GitHub Push Trigger

The GithubPushTrigger node listens for push events and extracts:

• Commit SHA\
• Repository full name\
• Branch\
• Metadata

No configuration required except selecting your GitHub credentials.

---

Step 2: Configure Sentry Release Fetching

Open Check Sentry Artifacts Releases and update:

https://sentry.io/api/0/projects/<org_slug>/<proj_slug>/releases/

Make sure the Sentry credential is correctly selected.

---

Step 3: Fetch Files for the Specific Release

The next HTTP Request (Check Sentry Artifacts Files) uses a dynamic URL:

https://sentry.io/api/0/projects/<org_slug>/<proj_slug>/releases/{{ $json.version }}/files/

Ensure your build pipeline sets version consistently with what Sentry receives.

---

Step 4: Artifact Validation Logic

The Verify Artifacts node runs JS logic to check:

✔ Condition 1 --- Valid dSYM

Any file ending with .dSYM

✔ Condition 2 --- Valid Android Mapping

• proguard.txt
• mapping.txt

✖ Failure --- If neither set exists

The Code node returns:

{ "status": "failure", "description": "Missing artifacts..." }

This stops the workflow and prevents GitHub commit-status update.

---

Step 5: Extract Commit Info & Prepare Update

The Artifacts Validation and Get Repository Data node compiles:

• repo full name
• commit SHA
• validation status

If validation failed → workflow ends here.

---

Step 6: Update GitHub Commit Status

The Update Status node hits:

POST https://api.github.com/repos/<repoFullName>/statuses/<commitSHA>

And sends:

{
  "state": "success",
  "description": "Artifacts successfully verified."
}

This appears as a green check on your commit/PR.

---

Step 7: Activate the Workflow

Turn on the workflow to start enforcing symbolication completeness for all releases.

---

1.7 How To Customize Nodes

Change Sentry Project

Edit URLs in both Sentry HTTP Request nodes:

• org_slug
• proj_slug

Add Additional Artifact Rules

Modify JS inside Verify Artifacts, e.g., require:

• native symbols
• extra asset files
• other platform artifacts

Customize Commit Status Message

Edit the request body in Update Status.

Support Multiple Platforms / Multiple Releases

Branch logic in:

• Code nodes
• Conditional checks

---

1.8 Add-Ons (Optional Enhancements)

• Add Slack/Teams notifications when artifacts are missing
• Auto-retry release checks after build completes
• Merge-blocking PR checks for GitHub
• Multi-platform artifact validation (iOS + Android + Unity)
• Upload artifacts directly from n8n
• Store validation logs in Airtable or Google Sheets
• Add GitHub Checks API rich reporting

---

1.9 Use Case Examples

1. Block merges until symbolication artifacts are uploaded.
2. Enforce strict Sentry release completeness for every build.
3. Ensure Android mapping files always match the correct release version.
4. Automatically verify multiple release types (debug, staging, production).
5. Improve crash debugging by preventing un-symbolicated builds from shipping.

---

1.10 Troubleshooting Guide

Issue	Possible Cause	Solution
Commit status never updates	Validation failed silently	Check logs in the Verify Artifacts node
version undefined in URL	Release not matched	Ensure CI uploads release with correct version
401 from Sentry API	Invalid or expired token	Regenerate token and update credentials
Validation always fails	Artifact names differ (e.g. .dsym.zip)	Update regex logic in the Code node
GitHub status API returns 404	Missing repo permissions	Enable repo:status scope in GitHub token
Files array empty	Artifacts not uploaded to Sentry	Verify CI → Sentry artifact upload step

---

1.11 Need Help?

If you need help customizing the artifact rules, integrating multiple platforms, or automating Sentry/GitHub workflows, reach out.
We can assist with:

• Mobile CI/CD pipelines
• Sentry automation
• Multi-artifact validation
• GitHub PR quality-gates
• Advanced Code-node scripting

Happy automating! 🚀