Skip to content

Activity Commands public preview docs#3625

Merged
axfelix merged 14 commits intomainfrom
drewhoskins_reset
Jul 11, 2025
Merged

Activity Commands public preview docs#3625
axfelix merged 14 commits intomainfrom
drewhoskins_reset

Conversation

@drewhoskins-temporal
Copy link
Contributor

@drewhoskins-temporal drewhoskins-temporal commented Jun 21, 2025

What does this PR do?

  • Grammar/clarity improvements
  • Add public preview stability info

Reset

  • Clarifies reset pre-timeout behavior in response to user confusion.
  • Adds documentation of cancellation exceptions caused by resets.

Pause

  • Show search attribute in unpause instructions.

Update Options

  • Link out to existing docs rather than rewriting them here.

Notes to reviewers

Resetting an activity restarts the activity as if it were first being scheduled. That is, it will reset both the number of attempts and the activity timeout, as well as, optionally, the [heartbeat details](#reset-heartbeats).

If activity is paused and 'keep_paused' flag is not provided - it will be
If the activity may be executing (i.e. it has not yet timed out), the reset will take effect the next time it fails or times out.
Copy link
Contributor

Choose a reason for hiding this comment

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

unless they are long-running activities.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed!

@drewhoskins-temporal drewhoskins-temporal changed the title Activity Reset public preview docs Activity Commands public preview docs Jul 8, 2025
Copy link
Contributor

@axfelix axfelix left a comment

Choose a reason for hiding this comment

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

Doesn't look like anything is changing in terms of syntax here, just clarifications. As discussed, these should generally go into the CLI repo in the future, but approving this for now while we improve that process.

@axfelix axfelix merged commit 574e1eb into main Jul 11, 2025
6 checks passed
@axfelix axfelix deleted the drewhoskins_reset branch July 11, 2025 20:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants