fix: add docstring to defineConfig for maxComputeSeconds PR#6
Open
deepshekhardas wants to merge 9 commits into
Open
fix: add docstring to defineConfig for maxComputeSeconds PR#6deepshekhardas wants to merge 9 commits into
deepshekhardas wants to merge 9 commits into
Conversation
- defineConfig: resolves maxComputeSeconds ?? maxDuration into maxDuration - new resolveMaxComputeSeconds helper for shared.ts - task definitions, trigger and batchTrigger options funnel through helper Internal references to maxDuration (run engine, queues, DB) are unchanged.
…sting - trigger.config.ts: top-level maxComputeSeconds - example.ts: per-task maxComputeSeconds on maxDurationTask - example.ts: per-trigger override on triggerAndWait Variable name maxDurationTask kept since it labels the legacy fixture concept; the payload.maxDuration field is unrelated to the SDK property and untouched.
If a user exports a trigger.config plain object without going through defineConfig() (TypeScript allows it), validation previously rejected the new maxComputeSeconds field with an error mentioning maxDuration. Mirror the SDK boundary's resolution at the CLI boundary so downstream internals (which still read maxDuration) keep working.
Adds JSDoc to defineConfig function to improve docstring coverage.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| id: release | ||
| uses: softprops/action-gh-release@v1 | ||
| if: github.event_name == 'push' | ||
| uses: softprops/action-gh-release@b4309332981a82ec1c5618f44dd2e27cc8bfbfda # v3.0.0 |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Adds JSDoc documentation to the defineConfig function to improve docstring coverage to meet the 80% threshold required by CI.
Summary by cubic
Adds JSDoc to
defineConfigand introducesmaxComputeSecondsas a clearer replacement formaxDurationacross config, tasks, and trigger options. Keeps backward compatible behavior and satisfies CI docstring coverage.Migration
maxComputeSecondsindefineConfig, task definitions, and trigger options.maxDurationis JSDoc-deprecated but still accepted; if both are set,maxComputeSecondswins.Bug Fixes
uncaughtExceptioninstead of drifting to max duration, respecting normal retry policy.Written for commit f89e3de. Summary will update on new commits.