Skip to content

Make generated projects Context7-ready - #281

Open
palewire with Copilot wants to merge 3 commits into
mainfrom
copilot/update-python-open-source-template-for-context7
Open

palewire with Copilot wants to merge 3 commits into
mainfrom
copilot/update-python-open-source-template-for-context7

Conversation

Copilot AI commented Sep 16, 2026 •

Copy link
Copy Markdown

Adds project-neutral Context7 indexing defaults and optional refresh automation to generated repositories.

Changes

  • Configuration
    • Adds schema-backed context7.json.
    • Indexes docs/ and README content while excluding operational files.
    • Avoids project-specific metadata and branch names.
{
  "$schema": "https://context7.com/schema/context7.json",
  "folders": ["docs"]
}
  • Automation

    • Adds an opt-in refresh workflow using the repository-derived Context7 library ID.
    • Requires explicit enablement and a CONTEXT7_API_KEY secret.
  • Documentation

    • Adds setup steps for submission, ownership claims, verification, and refresh management.
    • Includes context7.json in source distributions and records the feature in the changelog.

Verification

  • Generated and validated an isolated package from the updated template.

Copilot AI and others added 2 commits September 16, 2026 14:57
Co-authored-by: palewire <9993+palewire@users.noreply.github.com>
Co-authored-by: palewire <9993+palewire@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

Three moderate review findings remain unresolved.

Get a fresh assessment by requesting another Copilot review.

Pull request overview

Adds project-neutral Context7 indexing defaults and optional refresh automation to generated repositories.

Changes:

  • Adds schema-backed documentation indexing configuration.
  • Adds opt-in Context7 refresh workflow.
  • Documents setup and packages context7.json in source distributions.
  • Records the feature in the changelog.
File summaries
File Summary Final review comments
TEMPLATE_SETUP.md Documents Context7 setup and maintenance. None
MANIFEST.in Includes context7.json in source distributions. None
context7.json Defines documentation indexing and exclusions. Moderate: add remaining default operational filename variants. 1 vote
CHANGELOG.md Records the Context7 feature. None
.github/workflows/context7-refresh.yml Provides opt-in refresh automation. Moderate: isolate concurrency by ref. 3 votes; Moderate: keep workflow paths aligned with configurable documentation paths. 1 vote
Review details

Suppressed comments (2)

.github/workflows/context7-refresh.yml:8

  • The setup instructions invite maintainers to move the documentation paths in context7.json, but this workflow still watches only docs/** and README.md. After moving the docs, subsequent documentation changes will not trigger the advertised automatic refresh. Please make the setup checklist require updating this workflow's paths as well, or choose a trigger strategy that follows the configured documentation locations.
      - "docs/**"

context7.json:4

  • Because excludeFiles is supplied, Context7 no longer relies on its default filename exclusions. A generated repository that uses LICENSE.md, license.md, CHANGELOG.mdx, or the lowercase variants will therefore index those operational files, contrary to the setup text's claim that operational files are excluded. Add the remaining default filename variants (while retaining the template's extensionless LICENSE) so this default remains project-neutral.
  "excludeFiles": [
  • Files reviewed: 5/5 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread .github/workflows/context7-refresh.yml Outdated
@palewire

Copy link
Copy Markdown
Owner

@copilot Please fix the three outstanding review findings on this pull request in a cloud coding session:

  1. Update context7.json exclusions to cover the remaining default operational filename variants, including LICENSE.md, license.md, CHANGELOG.mdx, and lowercase variants, while retaining the template's extensionless LICENSE exclusion.
  2. Keep .github/workflows/context7-refresh.yml path triggers aligned with the documentation paths maintainers can configure in context7.json, so moving the documentation paths does not silently disable refreshes. Update the setup instructions or trigger strategy accordingly.
  3. Scope workflow concurrency by github.ref (or restrict triggers) so a docs push on another branch cannot cancel an in-progress default-branch refresh.

Please make the changes on this PR branch, run the relevant validation, and report the commit and results here. Preserve the opt-in behavior and project-neutral defaults.****

Co-authored-by: palewire <9993+palewire@users.noreply.github.com>

Copilot AI commented Sep 24, 2026

Copy link
Copy Markdown
Author

@copilot Please fix the three outstanding review findings on this pull request in a cloud coding session:

  1. Update context7.json exclusions to cover the remaining default operational filename va...

Fixed in 193d46a.

Validation:

  • python -m json.tool context7.json
  • make workflow-check
  • Copilot review / CodeQL via parallel validation: no findings

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants