chore(backend) : add ts-backend-check config and CI workflow#2000
chore(backend) : add ts-backend-check config and CI workflow#2000MuraliChowdhary wants to merge 2 commits intoactivist-org:mainfrom
Conversation
✅ Deploy Preview for activist-org ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Thank you for the pull request! ❤️The activist team will do our best to address your contribution as soon as we can. The following are some important points:
Note activist uses Conventional Comments in reviews to make sure that communication is as clear as possible. |
Maintainer ChecklistThe following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)
|
There was a problem hiding this comment.
First PR Commit Check
- The commit messages for the remote branch of a new contributor should be checked to make sure their email is set up correctly so that they receive credit for their contribution
- The contributor's name and icon in remote commits should be the same as what appears in the PR
- If there's a mismatch, the contributor needs to make sure that the email they use for GitHub matches what they have for
git config user.emailin their local activist repo (can be set withgit config --global user.email "GITHUB_EMAIL")
Contributor Checklist
mainbranchDescription
This PR integrates the
ts-backend-checkCLI into the Activist backend CI to ensure consistency between Django backend models and the corresponding TypeScript types used in the frontend.Configuration
Adds a
.ts-backend-check.yamlconfiguration file at the repository root that defines checks for the following model ↔ type mappings:backend/communities/organizations/models.py↔frontend/shared/types/organization.d.ts(organizations)backend/communities/groups/models.py↔frontend/shared/types/group.d.ts(groups)backend/events/models.py↔frontend/shared/types/event.d.ts(events, mapped to theCommunityEventinterface)CI Workflow
Introduces a dedicated GitHub Actions workflow:
pr_ci_ts_backend_checkWorkflow steps:
Workflow Triggers
Runs on PRs and pushes that modify:
Current Status
ts-backend-checkruns successfully in CIThese differences can be addressed in this PR or in follow-up changes depending on reviewer preference.
Testing
Backend
Run from
backend/:Type Checks
Run from the repository root:
Verified that the command runs using the new YAML configuration and reports the current set of model / type mismatches for organizations, groups, and events.
Related Issue
Closes #1325