Skip to content

Conversation

hunterachieng
Copy link
Contributor

@hunterachieng hunterachieng commented Oct 13, 2025

Short Description

Update cron trigger runs description to make it easy to understand

Closes #680

Details

Screenshot 2025-10-13 at 16 35 45 Screenshot 2025-10-13 at 16 35 53

AI Usage

Please disclose how you've used AI in this work (it's cool, we just want to
know!):

  • Code generation (copilot but not intellisense)
  • Learning or fact checking
  • Strategy / design
  • Optimisation / refactoring
  • Translation / spellchecking / doc gen
  • Other
  • I have not used AI

You can read more details in our
Responsible AI Policy

Signed-off-by: Hunter Achieng <achienghunter@gmail.com>
Copy link
Contributor

@mtuchi mtuchi left a comment

Choose a reason for hiding this comment

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

This looks good @hunterachieng

final output state of the **last succesful run** for this workflow. This allows
each subsequent run to _know_ about previous runs—i.e., you can pass information
from one run to another even if they happen days apart.
#### What are cron jobs?
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is this appropriate for this section of docs?

We're deep in an explanation of state here. I don't think this is the time or place to explain what a cron job is. We could add a single sentence definition, but otherwise we should link to the full cron docs.

Otherwise I think this is just a distraction from the discussion on this page.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@josephjclark In the link you have shared, the explanation still links to the docs we are currently updating to explain about state in cron jobs.

If readers are being directed to these docs, should we go deeper into state in cron jobs?

Screenshot 2025-10-13 at 21 49 01

Copy link
Collaborator

Choose a reason for hiding this comment

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

But that's only for state specifically.

"What is a cron job and how does it work" needs to be answered on build/triggers. I think those docs are fine right now but I'm open to discussing improvements.

"What is the input state passed into my cron job" needs to be explained in-depth in jobs/state. This stuff about "the output of the trigger step will be the input to the next step". It might need a concerete worked example to explain it.

build/triggers can have a single-sentence explanation of how state works, then link to jobs/state for more detail

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have explained more about the state in jobs/state with the new discovery of how state works in cronjobs

Signed-off-by: Hunter Achieng <achienghunter@gmail.com>
Signed-off-by: Hunter Achieng <achienghunter@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

Update cron triggered runs docs

3 participants