Update "dynamic"/"deterministic" usage in rules-of-workflows.mdx #18461
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
Dynamic is fine. Non-deterministic is not. Clarifying the latter.
mhart
requested review from
a team,
celso,
elithrar and
sidharthachatterjee
as code owners
github-actions
bot
added
size/xs
product:workflows
![hyperlint-ai[bot]](https://avatars.githubusercontent.com/in/718456?s=60&v=4){kind=small}
| ### Name steps deterministically | ||
| Steps should be named deterministically (even if dynamic). This ensures that their state is cached, and prevents the step from being rerun unnecessarily. Step names act as the "cache key" in your Workflow. | ||
| Steps should be named deterministically (ie, not using the current date/time, randomness, etc). This ensures that their state is cached, and prevents the step from being rerun unnecessarily. Step names act as the "cache key" in your Workflow. |
Contributor
There was a problem hiding this comment.
Suggested change
| Steps should be named deterministically (ie, not using the current date/time, randomness, etc). This ensures that their state is cached, and prevents the step from being rerun unnecessarily. Step names act as the "cache key" in your Workflow. | |
| Steps should be named deterministically (that is, not using the current date/time, randomness, etc). This ensures that their state is cached, and prevents the step from being rerun unnecessarily. Step names act as the "cache key" in your Workflow. |
Issues:
- Style Guide - (cloudflare.LatinTerms-warning) Use 'that is' instead of 'ie,', but consider rewriting the sentence.
Fix Explanation:
The suggestion to replace 'ie,' with 'that is,' is valid as it enhances clarity. The abbreviation 'ie,' is less formal and can be misinterpreted. The revised sentence maintains the original meaning while improving readability. No other issues were identified in the sentence.
Deploying cloudflare-docs with
|
| Latest commit: |
5c37951
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://59b74c74.cloudflare-docs-7ou.pages.dev |
| Branch Preview URL: | https://mhart-update-workflows-verbi.cloudflare-docs-7ou.pages.dev |
Contributor
|
Files with changes (up to 15)
|
elithrar
approved these changes
Dec 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
Dynamic is fine. Non-deterministic is not. Clarifying the latter.
Also fixed a minor bug. (
Date.nowwhen stringified is actually deterministic – it always outputs"[Function: now]"– it'sDate.now()that's the problem!)