-
-
Notifications
You must be signed in to change notification settings - Fork 188
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Discrepancy in README about preserve_job_records? #1265
Comments
You're right that sentence doesn't give the full picture. A more accurate statement would be something like. "By default, GoodJob retains finished job records for 14 days and then automatically deletes them." The setting that is used immediately after a job finishes to determine what to do is:
And then the settings related to how the jobs are automatically cleaned up are:
Looking at the Readme, it probably looks like jobs need to be manually cleaned up because it documents the manual action of the CLI before getting to the configuration values (and I think the manual action did exist before the automatic part was added) and this section: https://github.com/bensheldon/good_job?tab=readme-ov-file#monitor-and-preserve-worked-jobs |
I see! Thanks for the clarification. It might be worth giving this feature a self-explanatory name such as "auto cleanup". Just some (AI-generated) ideas:
|
preserve_job_records
is enabled by default:good_job/README.md
Line 300 in 3933005
but here it says "By default, GoodJob automatically destroys job records":
good_job/README.md
Lines 221 to 222 in 3933005
Am I misunderstanding, or are those two conflicting statements?
It seems that by default jobs are preserved for 14 days, but only if you run
good_job cleanup_preserved_jobs
will it actually clear out these older jobs. If that's the case, then I think the README should be clearer about the need for runninggood_job cleanup_preserved_jobs
.Also, a pre-existing
GoodJob::CleanupPreservedJobsJob
we can use with the cron feature would be handy for this.The text was updated successfully, but these errors were encountered: