Skip to content

update doc - #6

Merged
bubunyo merged 1 commit into
masterfrom
feat/update-doc
Mar 8, 2026
Merged

update doc#6
bubunyo merged 1 commit into
masterfrom
feat/update-doc

Conversation

@bubunyo

@bubunyo bubunyo commented Mar 8, 2026

Copy link
Copy Markdown
Owner

update doc

Copilot AI review requested due to automatic review settings March 8, 2026 05:11

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.

Pull request overview

Updates the README usage documentation to match the current BuildGraph CLI entrypoint and analyze output behavior.

Changes:

  • Update installation and local build commands to use the module root (go install github.com/bubunyo/buildgraph@latest, go build .).
  • Refresh buildgraph analyze examples to reflect text as the default format and document json/dot formats.
  • Adjust CI baseline persistence description wording (artifact naming examples).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
### How the baseline is persisted

The baseline artifact is uploaded at the end of each successful run and downloaded at the start of the next. Each branch gets its own artifact (`buildgraph-baseline`) so feature branches don't interfere with each other. On the very first run no artifact exists yet — BuildGraph treats all functions as new and returns all services in `services_to_build`, so a cold start is always safe.
The baseline artifact is uploaded at the end of each successful run and downloaded at the start of the next. Each branch gets its own artifact (e.g. `buildgraph-baseline-main`, `buildgraph-baseline-feature-foo`) so branches don't interfere with each other. On the very first run no artifact exists yet — BuildGraph treats all functions as new and returns all services in `services_to_build`, so a cold start is always safe.

Copilot AI Mar 8, 2026

Copy link

Choose a reason for hiding this comment

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

This section now states that each branch gets its own baseline artifact (e.g. buildgraph-baseline-main). That naming scheme conflicts with the repository’s other documentation/spec, which still references a single buildgraph-baseline artifact name in the CI examples (see SPEC.md around the GitHub Actions example). Please align the docs (either make the README wording more generic/configurable, or update the other docs/examples) to avoid confusing users about the expected artifact name(s).

Suggested change
The baseline artifact is uploaded at the end of each successful run and downloaded at the start of the next. Each branch gets its own artifact (e.g. `buildgraph-baseline-main`, `buildgraph-baseline-feature-foo`) so branches don't interfere with each other. On the very first run no artifact exists yet — BuildGraph treats all functions as new and returns all services in `services_to_build`, so a cold start is always safe.
The baseline artifact is uploaded at the end of each successful run and downloaded at the start of the next. The exact artifact name and how it is scoped (single shared artifact vs. per-branch artifacts) are controlled by your CI workflow configuration, so that branches can be isolated if desired. On the very first run no artifact exists yet — BuildGraph treats all functions as new and returns all services in `services_to_build`, so a cold start is always safe.

Copilot uses AI. Check for mistakes.
@bubunyo
bubunyo merged commit ed1515f into master Mar 8, 2026
9 checks passed
@bubunyo
bubunyo deleted the feat/update-doc branch March 13, 2026 06:33
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