42 lines
1.5 KiB
Markdown
42 lines
1.5 KiB
Markdown
# Release 0.3 - GitHub Integration
|
|
|
|
## Purpose
|
|
|
|
Add GitHub as the second supported Git provider with parity to the current Gitea-based repository, branch, and pull request visibility flows.
|
|
|
|
## API Basis
|
|
|
|
This release is planned from `docs/gitApiDocs/api.github.com.json`.
|
|
|
|
Primary endpoints for release `0.3`:
|
|
|
|
- `GET /user`
|
|
- `GET /user/repos`
|
|
- `GET /repos/{owner}/{repo}`
|
|
- `GET /repos/{owner}/{repo}/branches`
|
|
- `GET /repos/{owner}/{repo}/pulls`
|
|
|
|
## Release Decisions
|
|
|
|
- The first release targets GitHub Cloud on `https://api.github.com`.
|
|
- The first auth mode is a per-user token connection.
|
|
- Repository readability is the connection gate.
|
|
- Authenticated user profile data is an optional enrichment step for display metadata.
|
|
- GitHub App and installation flows are intentionally deferred.
|
|
|
|
## Tickets
|
|
|
|
- [01 GitHub Provider Foundation and Auth Strategy](01-github-provider-foundation-and-auth-strategy.md)
|
|
- [02 User GitHub Connections and Repository Discovery](02-user-github-connections-and-repository-discovery.md)
|
|
- [03 Project GitHub Repository Connections](03-project-github-repository-connections.md)
|
|
- [04 GitHub Ticket Branch Discovery by Ticket Key](04-github-ticket-branch-discovery-by-ticket-key.md)
|
|
- [05 GitHub Ticket Pull Request Visibility](05-github-ticket-pull-request-visibility.md)
|
|
|
|
## Deferred from This Release
|
|
|
|
- GitHub App authentication and installations
|
|
- GitHub Enterprise Server
|
|
- Webhooks
|
|
- Merge, review, and status-check actions
|
|
- Branch creation from ticket detail
|