-
Notifications
You must be signed in to change notification settings - Fork 142
Description
Roadmap
As discussed in previous community calls, GitProxy is direly in need of a Roadmap so that contributors can see more clearly the order in which things ought to be developed and merged into the project. It'll also help us start developing v2 on the right foot.
I've decided to write a quick draft after looking at all the open issues and PRs. I'm classifying most issues roughly based on need (engagement), difficulty and whether they'll cause breaking changes with our current setup.
Feel free to add the issues that are relevant to your organization!
Note: We might want to reorder these according to our perceived priority (my default sorting is older issues first).
Easy wins
Anything that we could probably get done within a day or two.
- feat: allow git-proxy to be configured both by environment as well as config file(s) #382
- Create a new slogan for GitProxy #505
- A reviewer must provide a reason when rejecting a push 💬 #605
- Run a hosted demo of the GitProxy dashboard ☁️ #627
- Default config not loaded due to excessive validation #654
- Support filter by file with file pattern and literal configuration #745
- Add Apache-2.0 license headers to source code #1002 (PR ready)
- Define and publicise our standards for testing and CI gating #1019
- Improve default admin user creation #1022
- Validate that a project doesn't already exist in GitProxy before creation (to avoid duplicates) #1028
- Restrict developers from overriding blocked pushes #1031
- Z_DATA_ERROR during push parsing #1040
- Validate attestation against config #1041
Need, fixes and minor releases
Fixes and non-breaking features that will provide significant value to users.
- SSH support #27
- Patch oriented workflow #61
- Contribute in personal capacity #64
- git push hangs with Git Proxy on macOS #510
- Implement a license inventory ⚖️ #594 and related PRs
- proposal: refactor configuration code #743
- Expose proxy support within GitProxy itself for air gapped environments #759
- Cypress tests require data created by mocha tests, but should be self-contained #978
- optimize pullRemote for large repos #985
- Add support for pushing tags
git push --tags
#986 - (bug) scanDiff fails on force pushes #1008
- docs/samples: example pull plugin fails to import PullActionPlugin #1088
- Support additional email addresses for users #1104
Need, but may cause breaking changes
Anything that requires deep refactoring/architectural changes may fall in this category. We will likely release these in GitProxy v3.
- Git Proxy 2.x architecture #425
- Lots of architectural changes here that will help pave the way for new features
- Open Policy Agent checks #99
- Add first class support for WASM-backed plugins #463
- Depends on Git Proxy 2.x architecture #425
- Extend GitProxy to Handle All GitHub Communications and Reviews #910
- Super valuable, may not strictly require v3 but changes are expected to be large
- Commits should be associated with users via email rather than the git user.name config #946, Repositories should be identified and retrieved via URL rather than name #950
- Planned for v2 release
- Feature Request: User Creation Endpoint and CLI Command #980
Nice-to-have, tech debt fixes
We don't strictly need these, but they'll help improve maintainability and user/developer experience.
Tech Debt
- Increase test coverage to 80% ⚡️ #240
- Almost there, just a few % left
- TypeScript and ESM support #276
- Almost there, just a few PRs left to merge refactor: refactor
git-proxy-cli
to TS + ESM #1065 refactor: Refactorservice
module to TS + ESM #1063 - Related: Add TypeScript to the Project #927
- Almost there, just a few PRs left to merge refactor: refactor
- e2e testing of git-proxy #394
- We do have E2E tests set up, we just need more coverage
- Related: Extend Cypress tests for dashboard pages and components #624
- Replace console.log with structured logging #399
- There is a PR for this almost ready to merge Replace console.log with structured logging #508
- Bump OSSF score above 9.0 ⬆️ #694
- PR ready for this test: Implement fuzz tests for processors #1115
- Remove usages of
trimTrailingDotGit
#1113