-
Notifications
You must be signed in to change notification settings - Fork 0
Improve repo health and release workflow #2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
IgnazioDS
wants to merge
1
commit into
main
Choose a base branch
from
branch/github-badge-readiness
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| * @IgnazioDS |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| name: Bug report | ||
| description: Report a reproducible defect in the starter | ||
| title: "[Bug]: " | ||
| labels: | ||
| - bug | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for taking the time to report a bug. | ||
| Please include enough detail for someone else to reproduce it. | ||
| - type: textarea | ||
| id: summary | ||
| attributes: | ||
| label: What happened? | ||
| description: Describe the bug and the expected behavior. | ||
| placeholder: The API returned..., but I expected... | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: steps | ||
| attributes: | ||
| label: Steps to reproduce | ||
| description: Include commands, requests, or configuration details. | ||
| placeholder: | | ||
| 1. Run ... | ||
| 2. Send ... | ||
| 3. Observe ... | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: environment | ||
| attributes: | ||
| label: Environment | ||
| description: Python version, OS, database setup, and any relevant env vars. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: logs | ||
| attributes: | ||
| label: Logs or stack traces | ||
| description: Paste any relevant output. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| blank_issues_enabled: false | ||
| contact_links: | ||
| - name: Security report | ||
| url: https://github.com/IgnazioDS/langgraph-fastapi-starter/security | ||
| about: Report vulnerabilities privately through GitHub Security Advisories. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| name: Feature request | ||
| description: Propose an improvement to the starter | ||
| title: "[Feature]: " | ||
| labels: | ||
| - enhancement | ||
| body: | ||
| - type: textarea | ||
| id: problem | ||
| attributes: | ||
| label: Problem to solve | ||
| description: What is missing or painful today? | ||
| placeholder: I want to use this starter for..., but... | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: proposal | ||
| attributes: | ||
| label: Proposed change | ||
| description: Describe the smallest useful improvement. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: alternatives | ||
| attributes: | ||
| label: Alternatives considered | ||
| description: Optional. Describe workarounds or other approaches. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| version: 2 | ||
| updates: | ||
| - package-ecosystem: "pip" | ||
| directory: "/" | ||
| schedule: | ||
| interval: "weekly" | ||
| open-pull-requests-limit: 5 | ||
| - package-ecosystem: "github-actions" | ||
| directory: "/" | ||
| schedule: | ||
| interval: "weekly" | ||
| open-pull-requests-limit: 5 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| ## Summary | ||
|
|
||
| - What changed? | ||
| - Why does it matter? | ||
|
|
||
| ## Verification | ||
|
|
||
| - [ ] `make lint` | ||
| - [ ] `make typecheck` | ||
| - [ ] `make test` | ||
|
|
||
| ## Notes | ||
|
|
||
| - Follow-up work | ||
| - Deployment or migration impact |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| name: Release | ||
|
|
||
| on: | ||
| push: | ||
| tags: | ||
| - "v*" | ||
| workflow_dispatch: | ||
|
|
||
| permissions: | ||
| contents: write | ||
|
|
||
| jobs: | ||
| release: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Check out code | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Set up Python | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: "3.11" | ||
|
|
||
| - name: Build distribution artifacts | ||
| run: | | ||
| python -m pip install --upgrade pip build | ||
| python -m build | ||
|
|
||
| - name: Create GitHub release | ||
| uses: softprops/action-gh-release@v2 | ||
| with: | ||
| generate_release_notes: true | ||
| files: | | ||
| dist/* | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # Contributing | ||
|
|
||
| This repository is meant to be forked, customized, and improved in the open. | ||
| Small, focused pull requests are easier to review and more likely to merge. | ||
|
|
||
| ## Development Setup | ||
|
|
||
| 1. Create a virtual environment. | ||
| 2. Install dependencies with `pip install -e ".[dev]"`. | ||
| 3. Copy `.env.example` to `.env`. | ||
| 4. Start PostgreSQL with `make up`. | ||
| 5. Run migrations with `make migrate`. | ||
|
|
||
| ## Recommended Workflow | ||
|
|
||
| 1. Create a branch from `main`. | ||
| 2. Make one logical change at a time. | ||
| 3. Run `make lint`, `make typecheck`, and `make test`. | ||
| 4. Update docs or examples if behavior changed. | ||
| 5. Open a pull request with a clear summary and verification notes. | ||
|
|
||
| ## Pull Request Expectations | ||
|
|
||
| - Keep PRs narrow in scope. | ||
| - Describe the user-visible or maintainer-visible impact. | ||
| - Include the commands you ran locally. | ||
| - Call out follow-up work instead of mixing it into the same PR. | ||
|
|
||
| ## Good First Contributions | ||
|
|
||
| - Documentation fixes and walkthrough improvements | ||
| - Additional tests around router, service, or graph behavior | ||
| - Production hardening and deployment guidance | ||
| - Example agent improvements that keep the starter generic | ||
|
|
||
| ## Reporting Problems | ||
|
|
||
| Open an issue with: | ||
|
|
||
| - What you expected | ||
| - What actually happened | ||
| - Steps to reproduce | ||
| - Environment details that matter | ||
|
|
||
| Security-sensitive issues should follow [SECURITY.md](./SECURITY.md). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| # Security Policy | ||
|
|
||
| If you discover a vulnerability, do not open a public issue with exploit details. | ||
|
|
||
| ## Reporting | ||
|
|
||
| Please report security issues privately through GitHub Security Advisories or by | ||
| contacting the repository owner directly through GitHub. | ||
|
|
||
| Include: | ||
|
|
||
| - A clear description of the issue | ||
| - Impact and affected components | ||
| - Reproduction steps or proof of concept | ||
| - Any suggested remediation | ||
|
|
||
| ## Scope | ||
|
|
||
| Security reports are especially helpful for: | ||
|
|
||
| - Authentication and authorization flaws | ||
| - Secrets handling issues | ||
| - Dependency risks with practical impact | ||
| - Injection, deserialization, or unsafe tool execution paths | ||
| - Data exposure through logs, persistence, or API responses | ||
|
|
||
| ## Response Goals | ||
|
|
||
| Best effort: | ||
|
|
||
| - Acknowledge receipt quickly | ||
| - Reproduce and assess impact | ||
| - Prepare a fix and coordinated disclosure plan |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| # Releasing | ||
|
|
||
| This repository is versioned manually on purpose. The goal is a simple release | ||
| path that keeps source, tags, and release notes in sync without introducing a | ||
| second layer of automation. | ||
|
|
||
| ## Release Checklist | ||
|
|
||
| 1. Run `make lint`, `make typecheck`, and `make test`. | ||
| 2. Confirm `README.md` and docs match the current setup flow. | ||
| 3. Bump the version in `pyproject.toml` and `app/main.py` if behavior changed. | ||
| 4. Commit the release changes. | ||
| 5. Create a tag such as `v0.2.0`. | ||
| 6. Push the branch and tag to GitHub. | ||
|
|
||
| ```bash | ||
| git tag v0.2.0 | ||
| git push origin main --follow-tags | ||
| ``` | ||
|
|
||
| ## What Happens On Tag Push | ||
|
|
||
| The `Release` GitHub Actions workflow: | ||
|
|
||
| - builds the source distribution and wheel | ||
| - creates a GitHub release for the tag | ||
| - attaches the built artifacts to the release | ||
|
|
||
| ## Versioning Guidance | ||
|
|
||
| Use pragmatic semver: | ||
|
|
||
| - patch: docs fixes, small bug fixes, non-breaking maintenance | ||
| - minor: new starter capabilities or meaningful extension points | ||
| - major: breaking API or setup changes |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With
workflow_dispatchenabled, a maintainer can run this workflow from the default branch instead of a version tag. Thesoftprops/action-gh-releaseaction defaultstag_nametogithub.ref_name, so a manual run frommainwould try to create/update a release taggedmainand attach artifacts built from that branch, bypassing the tag-driven release flow documented indocs/releasing.md. Add a tag input/guard or remove manual dispatch so manual runs cannot publish branch-named releases.Useful? React with 👍 / 👎.