refactor(consume): avoid github api calls for direct url fixture inputs #1788
Conversation
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
danceratopz
added
type:feat
danceratopz
commented
Jun 24, 2025
danceratopz
commented
Jun 24, 2025
spencer-tb
requested changes
Jun 24, 2025
There was a problem hiding this comment.
Thanks! Some small tweaks/suggestions on the docs below :)
We should maybe rename from --no-api-calls to something else, like --reduced/suppress-api-calls, regarding this section:
- ❌ Version specifiers always require API calls, e.g. `--input=stable@latest` (the flag is ignored).
Co-authored-by: spencer <[email protected]>
Remove the --no-api-calls flag and instead make the behavior automatic: - Direct GitHub release URLs: No API calls, no release page output - Release specifiers (stable@latest): API calls required, includes release page This provides better CI/UX without requiring additional flags.
Describe the automatic API call avoidance for direct URLs without mentioning any flags since we implemented automatic behavior.
danceratopz
changed the title
--no-api-calls to avoid using the Github API with release URL inputs
danceratopz
added
type:refactor
|
From @spencer-tb offline:
This suggestion makes much more sense, so I updated this PR to go with that! |
spencer-tb
approved these changes
Jun 25, 2025
Co-authored-by: spencer <[email protected]>
danceratopz
added a commit
that referenced
this pull request
Jul 2, 2025
…ts (#1788) * feat(consume): add `--no-api-calls` flag for --input=<github-release-url> * docs(consume): update consume cache docs for the `--no-api-calls` flag * docs(hive): align sub-section title style * docs: update changelog * Apply suggestions from code review Co-authored-by: spencer <[email protected]> * refactor(consume): simplify API behavior for direct URLs Remove the --no-api-calls flag and instead make the behavior automatic: - Direct GitHub release URLs: No API calls, no release page output - Release specifiers (stable@latest): API calls required, includes release page This provides better CI/UX without requiring additional flags. * docs(changelog): update consume API behavior entry Describe the automatic API call avoidance for direct URLs without mentioning any flags since we implemented automatic behavior. * Apply suggestions from code review Co-authored-by: spencer <[email protected]> --------- Co-authored-by: spencer <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
🗒️ Description
Simplified
consumeAPI behavior: Direct GitHub release URLs now automatically avoid GitHub API calls (better for CI), while release specifiers likestable@latestcontinue to use the API.🔗 Related Issues
None
✅ Checklist
mkdocs servelocally and verified the auto-generated docs for new tests in the Test Case Reference are correctly formatted.