Skip to content

docs: document DynamicallyScheduledTaskHandler for custom rescheduling#2349

Open
Soner (shyim) wants to merge 3 commits into
mainfrom
docs/scheduled-task-dynamic-rescheduling
Open

docs: document DynamicallyScheduledTaskHandler for custom rescheduling#2349
Soner (shyim) wants to merge 3 commits into
mainfrom
docs/scheduled-task-dynamic-rescheduling

Conversation

@shyim

Copy link
Copy Markdown
Member

Summary

Documents the new DynamicallyScheduledTaskHandler interface in the "Add Scheduled Task" guide. A handler implementing it can compute its own next execution time (e.g. the timestamp of the next pending record) instead of the default now + runInterval schedule, while the executor still persists the schedule.

Adds a new "Dynamic rescheduling" section with an Available since Shopware version 6.7.13.0 note and a full handler example.

Related links

Checklist

  • I reviewed affected links, code samples, and cross-references, including PageRef references where relevant.
  • I added or updated redirects in .gitbook.yaml if pages were moved, renamed, or deleted.
  • I updated .wordlist.txt (and sorted it) if spellcheck flags new legitimate terms.
  • Any required dependent changes in downstream modules have already been merged and published.
  • This pull request is ready for review.

Notes

New terms are all wrapped in code fences/backticks, so no .wordlist.txt changes were needed — make spellcheck and the markdown style check both pass locally. The "available since" version (6.7.13.0) matches the upcoming release the platform PR targets; adjust if the platform PR lands in a different version.

Add a 'Dynamic rescheduling' section to the scheduled task guide
covering the new DynamicallyScheduledTaskHandler interface, available
since Shopware 6.7.13.0.
Copilot AI review requested due to automatic review settings June 24, 2026 08:29
@shopware-dev-docs-connector

shopware-dev-docs-connector Bot commented Jun 24, 2026

Copy link
Copy Markdown

Developer Docs healthcheck

Status: Completed with success.
Repository: shopware/docs
Commit: a8fcda6
Preview: https://developer-documentation-r4klfnxen-shopware-frontends.vercel.app
Workflow run: #4262

@shyim

Copy link
Copy Markdown
Member Author

I added blocked label, as we wait until it's released right?

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the Shopware 6 plugin documentation by extending the “Add Scheduled Task” guide with details on the new DynamicallyScheduledTaskHandler interface, enabling task handlers to compute their own next execution time.

Changes:

  • Adds a new “Dynamic rescheduling” section with an “Available since Shopware version …” note.
  • Documents the dynamic scheduling behavior (including null fallback) and provides a handler example implementing DynamicallyScheduledTaskHandler.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread guides/plugins/plugins/plugin-fundamentals/add-scheduled-task.md
Comment thread guides/plugins/plugins/plugin-fundamentals/add-scheduled-task.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@Isengo1989

Micha Hobert (Isengo1989) commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

I added blocked label, as we wait until it's released right?

This always depends on the PR; ideally, we merge when it is released. Sometimes we want to give external developers a longer "heads up".

As this is only one new interface and the version is clearly stated beforehand, I would go with "merge now".

@Isengo1989 Micha Hobert (Isengo1989) added the Undocumented Feature Feature which is not documented yet and is considered for documentation label Jun 24, 2026

@Isengo1989 Micha Hobert (Isengo1989) left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thx for the PR Soner (@shyim) 👍

@Isengo1989 Micha Hobert (Isengo1989) removed the Blocked Block PRs from merging label Jun 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Undocumented Feature Feature which is not documented yet and is considered for documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants