Skip to content

Finalize backfill package documentation#816

Open
sij411 wants to merge 1 commit into
fedify-dev:feat/backfillfrom
sij411:feat/backfill-wrap-up
Open

Finalize backfill package documentation#816
sij411 wants to merge 1 commit into
fedify-dev:feat/backfillfrom
sij411:feat/backfill-wrap-up

Conversation

@sij411

@sij411 sij411 commented Jun 23, 2026

Copy link
Copy Markdown
Member

Summary

This PR wraps up the @fedify/backfill implementation completed across #779, #801, and #807, and closes #275.

It completes the release-facing documentation, documents all public strategies and traversal controls, adds the package to the contributor package list and changelog, and replaces the provisional @since 2.x.0 tags with the target release version, 2.3.0.

It also removes the unused "context" value from BackfillOrigin; the implementation only emits "collection", "in-reply-to", and "replies".

Closes #275

Changes

  • Add the consolidated @fedify/backfill entry to CHANGES.md
  • Add @fedify/backfill to the package list in CONTRIBUTING.md
  • Document context-objects and link FEP-f228
  • Document traversal budgets, cancellation, intervals, and caching
  • Finalize public API @since tags as 2.3.0
  • Remove the unused "context" backfill origin

Verification

  • mise run check:md
  • deno task -f @fedify/backfill check
  • deno task -f @fedify/backfill test
  • mise exec -- pnpm --filter @fedify/backfill test
  • mise exec -- pnpm --filter @fedify/backfill test:bun

AI usage

Assisted-by: Codex:gpt-5.5

Add changes and package descriptions.

Fix version to 2.3.0.

Assisted-by: Codex:gpt-5.5
@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: b560feca-ae23-43fa-8b19-c786c16ca67f

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request updates the documentation and type definitions for the @fedify/backfill package. Specifically, it documents the new context-objects strategy and traversal controls in the README, registers the package in CONTRIBUTING.md, updates the changelog, refines the BackfillOrigin type by removing the `

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

@codecov

codecov Bot commented Jun 23, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

Files with missing lines Coverage Δ
packages/backfill/src/backfill.ts 90.21% <ø> (ø)

... and 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@dahlia

dahlia commented Jun 23, 2026

Copy link
Copy Markdown
Member

The existing packages/backfill/README.md document is good, but since users mostly look at the docs website, it would be great if the docs for the @fedify/backfill package was written in the docs/manual/backfill.md file.

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.

2 participants