docs: clarify cron attribute format for coder_script resource #409
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
![blink-so[bot]](https://avatars.githubusercontent.com/in/1271127?s=60&v=4){kind=small}
|
All contributors have signed the CLA ✍️ ✅ |
- Update cron description to specify 6-field format (seconds minutes hours day month day-of-week) - Fix misleading example that used 5-field Unix format - Add additional cron examples with proper 6-field format - Include inline comments explaining the schedule Fixes #353
- Detect when users provide Unix 5-field cron format - Provide helpful warning with suggested 6-field conversion - Maintain backwards compatibility - expressions still work - Add comprehensive tests for validation function This helps users avoid confusion where '*/5 * * * *' (intended for every 5 minutes) actually runs every 5 seconds due to the missing seconds field.
- Added the missing every_5_minutes cron script example to examples/resources/coder_script/resource.tf - This example demonstrates the 6-field cron format with a health check that runs every 5 minutes - Ensures examples directory matches the documentation examples
- Updated the cron field description in provider/script.go to include detailed 6-field format explanation - Fixed formatting issues in documentation (removed extra spaces before comments) - Regenerated documentation to ensure consistency between schema and docs - This ensures the documentation generation preserves the detailed cron description instead of reverting to generic text
blink-so
bot
force-pushed
the
fix-cron-documentation
branch
from
e998cb2 to
e810230
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR clarifies the cron attribute format used by the coder_script resource, addressing issue #353 by updating documentation and examples to reflect the usage of a 6-field cron format.
- Updated cron description in resource schema and docs
- Fixed misleading example by converting a 5-field expression to a correct 6-field expression
- Added tests to validate cron expressions and introduced a new example for an every 5 minutes schedule
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| provider/script_test.go | Added tests for various cron expression scenarios |
| provider/script.go | Introduced ValidateCronExpression and updated the resource's validation logic |
| examples/resources/coder_script/resource.tf | Updated resource examples to use the correct 6-field cron format |
| docs/resources/script.md | Updated documentation for the cron attribute to clarify the 6-field format |
kylecarbs
approved these changes
Jun 4, 2025
jatcod3r
approved these changes
Jun 5, 2025
There was a problem hiding this comment.
The description looks good to me! I tested out the 6-field format too and it works per what example describes.
I'm not sure about the new function though. I don't know how to test this myself, but it looks like the runner was able to verify it: https://github.com/coder/terraform-provider-coder/actions/runs/15445849660
Would be good to get someone to test out the resource change, but overall this looks great to me!
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.
This PR addresses issue #353 by clarifying the cron format documentation for the
coder_scriptresource.Changes Made
seconds minutes hours day-of-month month day-of-week) instead of the standard Unix 5-field format"0 22 * * *"to"0 0 22 * * *"to show proper 6-field formatProblem Solved
The original issue was that users expected the standard Unix cron format (
minutes hours day month day-of-week) but the provider actually uses a 6-field format that includes seconds as the first field. This caused confusion where a user's"*/5 * * * *"(intended for every 5 minutes) was actually running every 5 seconds.Testing
The documentation changes have been tested by verifying the cron parser configuration in
provider/script.gowhich shows:This confirms the 6-field format is correct.
Fixes #353