Skip to content

Document --cleanup-only flag for report scheduler command#708

Merged
adiati98 merged 5 commits into
mautic:7.2from
Promptless:promptless/report-scheduler-cleanup-only
May 28, 2026
Merged

Document --cleanup-only flag for report scheduler command#708
adiati98 merged 5 commits into
mautic:7.2from
Promptless:promptless/report-scheduler-cleanup-only

Conversation

@promptless-for-oss
Copy link
Copy Markdown

Open this suggestion in Promptless to view citations and reasoning process

Adds documentation for the new --cleanup-only flag on mautic:reports:scheduler that allows users to run report cleanup separately from report sending, preventing duplicate Report Emails.

Trigger Events


Tip: Use Vale? Add your vale.ini when setting up your Docs Collection.

@promptless-for-oss promptless-for-oss requested a review from a team as a code owner May 6, 2026 10:34
@promptless-for-oss promptless-for-oss requested review from adiati98 and favour-chibueze and removed request for a team May 6, 2026 10:34
Comment thread docs/configuration/cron_jobs.rst
Comment thread docs/configuration/cron_jobs.rst Outdated
@promptless-for-oss
Copy link
Copy Markdown
Author

Thanks for catching that! I've removed the incorrect note about Mautic 1.1.3 requiring --env=prod — you're right that report schedule sends didn't exist in that version.

escopecz
escopecz previously approved these changes May 21, 2026
Copy link
Copy Markdown
Member

@escopecz escopecz left a comment

Choose a reason for hiding this comment

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

Looks good 👍

@adiati98
Copy link
Copy Markdown
Contributor

@promptless-for-oss please rebase to 7.2 branch

promptless Bot added 2 commits May 26, 2026 11:26
Add documentation for the new --cleanup-only flag that allows users to
run report cleanup separately from report sending, preventing duplicate
Report Emails when both operations run simultaneously.
PR reviewer noted that Mautic 1.1.3 didn't have report schedule sends,
so the --env=prod note for that version was incorrect.
@promptless-for-oss promptless-for-oss force-pushed the promptless/report-scheduler-cleanup-only branch from 022bc8a to 452e7c9 Compare May 26, 2026 11:26
@promptless-for-oss promptless-for-oss requested a review from a team May 26, 2026 11:26
@promptless-for-oss promptless-for-oss changed the base branch from 7.1 to 7.2 May 26, 2026 11:27
@promptless-for-oss promptless-for-oss dismissed escopecz’s stale review May 26, 2026 11:27

The base branch was changed.

@promptless-for-oss
Copy link
Copy Markdown
Author

Done! I've rebased the branch onto 7.2 and updated the PR base branch to target 7.2. The PR is ready for review.

Copy link
Copy Markdown
Contributor

@adiati98 adiati98 left a comment

Choose a reason for hiding this comment

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

@promptless-for-oss please address the suggestions

Comment thread docs/configuration/cron_jobs.rst Outdated
Comment thread docs/configuration/cron_jobs.rst
Comment thread docs/configuration/cron_jobs.rst Outdated
Comment thread docs/configuration/cron_jobs.rst Outdated
Comment thread docs/reports/reports.rst Outdated
Comment thread docs/configuration/cron_jobs.rst Outdated
Comment thread docs/reports/reports.rst Outdated
Apply all 7 suggestions from reviewer @adiati98:
- Change "Command parameters:" header from asterisks to dashes
- Wrap "Preventing duplicate Report Emails" header in vale off/on
- Use #. instead of numbered list items for cron job steps
- Capitalize "cron" to "Cron" in duplicate emails paragraph
- Update bullet style and add cross-reference for report scheduler args
- Fix RST label target capitalization for "Send scheduled Reports Cron job"
- Use code block instead of inline code for command syntax in reports.rst
@promptless-for-oss
Copy link
Copy Markdown
Author

Thanks for the detailed review @adiati98! I've addressed all 7 suggestions:

  1. ✅ Changed header level from *** to --- and removed colon
  2. ✅ Added vale off/on around "Preventing duplicate Report Emails" header
  3. ✅ Changed numbered list items to #. for auto-numbering
  4. ✅ Capitalized "cron" to "Cron"
  5. ✅ Updated bullet style to * and added cross-reference
  6. ✅ Fixed RST label target capitalization
  7. ✅ Changed inline code to code block format

Please let me know if you'd like any further changes!

Comment thread docs/configuration/cron_jobs.rst Outdated
Address reviewer feedback to explicitly state that the cleanup-only
job does not send Report Emails.
@promptless-for-oss
Copy link
Copy Markdown
Author

Thanks for the feedback, @adiati98! Good catch — I've updated line 308 in docs/configuration/cron_jobs.rst to explicitly clarify that the cleanup-only job "removes old exported files without sending Report Emails".

@adiati98 adiati98 merged commit 3677a8b into mautic:7.2 May 28, 2026
3 checks passed
@promptless-for-oss promptless-for-oss deleted the promptless/report-scheduler-cleanup-only branch May 28, 2026 13:21
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