feat: upgrade migrations chart

[mikolajsobolewski]

Summary by CodeRabbit

• New Features
  • Added options to control the number of successful and failed job histories retained for migrations jobs.
• Bug Fixes
  • Replaced the previous time-based job cleanup with history-based retention settings.
• Documentation
  • Updated documentation to reflect the new job history retention settings and version badge.
• Chores
  • Bumped the Helm chart version to 0.2.2.

[coderabbitai]

Walkthrough

The pull request updates the Helm chart for migrations by incrementing its version, removing the ttlSecondsAfterFinished field from job configuration, and introducing successfulJobsHistoryLimit and failedJobsHistoryLimit fields to control job history retention. Documentation and default values are updated accordingly.

Changes

File(s)	Change Summary
charts/migrations/Chart.yaml	Chart version incremented from 0.2.1 to 0.2.2.
charts/migrations/README.md	Updated version badge; replaced ttlSecondsAfterFinished with job history limit keys in docs.
charts/migrations/templates/job.yaml	Removed ttlSecondsAfterFinished; added successfulJobsHistoryLimit and failedJobsHistoryLimit fields to Job spec.
charts/migrations/values.yaml	Removed ttlSecondsAfterFinished; added successfulJobsHistoryLimit (3) and failedJobsHistoryLimit (1).

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Helm Chart
    participant Kubernetes

    User->>Helm Chart: Install/Upgrade migrations chart
    Helm Chart->>Kubernetes: Deploy Job with job history limits
    Kubernetes-->>Helm Chart: Retain N successful/failed Jobs (per limits)

Loading

Possibly related PRs

• feat: add migrations #20: Introduces the migrations Helm chart and the original job configuration, which this PR modifies by updating job history retention fields.

Suggested reviewers

• zavertiaev

Poem

In the meadow of charts, a hop and a skip,
Old TTL fields take their final trip.
Now history’s kept—three wins, one fail—
A tidy new burrow, with limits set hale.
Version hops forward, as all rabbits cheer,
For cleaner migrations, the future is here! 🐇

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 19eccdf and 8205e48.

📒 Files selected for processing (4)

• charts/migrations/Chart.yaml (1 hunks)
• charts/migrations/README.md (2 hunks)
• charts/migrations/templates/job.yaml (1 hunks)
• charts/migrations/values.yaml (1 hunks)

🔇 Additional comments (4)

charts/migrations/values.yaml (1)

11-12: Introduced job history limit defaults
Adding successfulJobsHistoryLimit and failedJobsHistoryLimit with sensible defaults (3 and 1) aligns the values schema with retention requirements.

charts/migrations/Chart.yaml (1)

5-5: Bump chart version to 0.2.2
The version increment from 0.2.1 to 0.2.2 correctly reflects the addition of new history limit fields and removal of ttlSecondsAfterFinished.

charts/migrations/README.md (2)

3-3: Update version badge to 0.2.2
The badge now matches the bumped chart version, keeping documentation in sync.

---

27-28: Document new job history limit keys
The table entries for job.failedJobsHistoryLimit (default 1) and job.successfulJobsHistoryLimit (default 3) accurately reflect the updated values schema.

[coderabbitai]

⚠️ Potential issue

Invalid fields on Job spec: use TTLSecondsAfterFinished or CronJob
successfulJobsHistoryLimit and failedJobsHistoryLimit are CronJob retention settings, not Job spec fields. These will be rejected by the Kubernetes API. Either revert to ttlSecondsAfterFinished for Job cleanup or switch to a CronJob resource.

🤖 Prompt for AI Agents

In charts/migrations/templates/job.yaml at lines 11-12, the fields
successfulJobsHistoryLimit and failedJobsHistoryLimit are invalid for a Job spec
and cause Kubernetes API rejection. Replace these fields with
ttlSecondsAfterFinished to handle Job cleanup correctly, or change the resource
type to CronJob if you need to use those retention settings. Adjust the template
accordingly to use valid Job spec fields.