Skip to content

[docs] Changelogs for v0.32.1 and changelog template - #1111

Merged
Timofei Larkin (lllamnyp) merged 1 commit into
mainfrom
changelogs-release-v0.32.x
Jul 10, 2025
Merged

[docs] Changelogs for v0.32.1 and changelog template#1111
Timofei Larkin (lllamnyp) merged 1 commit into
mainfrom
changelogs-release-v0.32.x

Conversation

@NickVolynkin

@NickVolynkin Nick Volynkin (NickVolynkin) commented Jun 25, 2025

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Added a new changelog template with predefined sections for consistent release documentation.
    • Published a detailed changelog for version 0.32.1, outlining major features, fixes, dependency updates, documentation changes, testing improvements, and CI/CD enhancements.

@coderabbitai

coderabbitai Bot commented Jun 25, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

A new changelog template was added, and a comprehensive changelog for version 0.32.1 was introduced. These files provide structured documentation of recent features, fixes, dependency updates, and process improvements, but do not modify any code or exported entities.

Changes

File(s) Change Summary
docs/changelogs/template.md Added a changelog template with section headers for documenting various types of changes.
docs/changelogs/v0.32.1.md Added a detailed changelog for version 0.32.1, listing features, fixes, dependency and process updates.

Suggested reviewers

  • kvaps
  • klinch0
  • lllamnyp

Poem

In the burrow of docs where the changelogs grow,
New features and fixes are listed in a row.
With templates to guide us, and updates so neat,
This rabbit’s heart thumps with a documentation beat!
🐇✨


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
🪧 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.

@NickVolynkin
Nick Volynkin (NickVolynkin) force-pushed the changelogs-release-v0.32.x branch 2 times, most recently from bfd1d64 to 10dbe9e Compare June 25, 2025 07:47
@NickVolynkin
Nick Volynkin (NickVolynkin) marked this pull request as ready for review June 26, 2025 07:06

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 0

🧹 Nitpick comments (2)
docs/changelogs/template.md (1)

1-11: Add a heading for version/date and brief release summary

The template jumps straight to second-level headings. Including a first-level heading placeholder (e.g. # vX.Y.Z – YYYY-MM-DD) and a short one-sentence release blurb will make future entries copy-paste-ready and consistent with most changelog conventions (Keep a Changelog, GitHub releases, etc.).

+# vX.Y.Z – YYYY-MM-DD
+
+A short sentence describing the gist of the release.
+
 ## Major Features and Improvements
docs/changelogs/v0.32.1.md (1)

3-6: Wrap bare URLs to satisfy MD034 and improve readability

markdownlint flags every bare URL (MD034). Wrapping the URLs in angle brackets or, better, turning them into reference links silences the linter and looks cleaner:

-* [postgres] Introduce new functionality for backup and restore in PostgreSQL. (@klinch0 in https://github.com/cozystack/cozystack/pull/1086)
+* [postgres] Introduce new functionality for backup and restore in PostgreSQL. (@klinch0 in <https://github.com/cozystack/cozystack/pull/1086>)

(Same pattern for the remaining bullets.)

Also applies to: 10-15, 18-21, 24-25, 28-36, 38-38

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4369b03 and 10dbe9e.

📒 Files selected for processing (2)
  • docs/changelogs/template.md (1 hunks)
  • docs/changelogs/v0.32.1.md (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/changelogs/v0.32.1.md

3-3: Bare URL used
null

(MD034, no-bare-urls)


4-4: Bare URL used
null

(MD034, no-bare-urls)


5-5: Bare URL used
null

(MD034, no-bare-urls)


6-6: Bare URL used
null

(MD034, no-bare-urls)


10-10: Bare URL used
null

(MD034, no-bare-urls)


11-11: Bare URL used
null

(MD034, no-bare-urls)


12-12: Bare URL used
null

(MD034, no-bare-urls)


13-13: Bare URL used
null

(MD034, no-bare-urls)


13-13: Bare URL used
null

(MD034, no-bare-urls)


14-14: Bare URL used
null

(MD034, no-bare-urls)


18-18: Bare URL used
null

(MD034, no-bare-urls)


19-19: Bare URL used
null

(MD034, no-bare-urls)


19-19: Bare URL used
null

(MD034, no-bare-urls)


20-20: Bare URL used
null

(MD034, no-bare-urls)


24-24: Bare URL used
null

(MD034, no-bare-urls)


28-28: Bare URL used
null

(MD034, no-bare-urls)


29-29: Bare URL used
null

(MD034, no-bare-urls)


30-30: Bare URL used
null

(MD034, no-bare-urls)


31-31: Bare URL used
null

(MD034, no-bare-urls)


32-32: Bare URL used
null

(MD034, no-bare-urls)


33-33: Bare URL used
null

(MD034, no-bare-urls)


34-34: Bare URL used
null

(MD034, no-bare-urls)


35-35: Bare URL used
null

(MD034, no-bare-urls)


36-36: Bare URL used
null

(MD034, no-bare-urls)


38-38: Bare URL used
null

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Test kafka
🔇 Additional comments (1)
docs/changelogs/v0.32.1.md (1)

30-30: Verify Kubernetes version “v1.33”

Upstream Kubernetes 1.33 does not yet exist. If this line refers to v1.23, v1.24, etc., please correct it to avoid confusion.

@NickVolynkin
Nick Volynkin (NickVolynkin) changed the base branch from main to skip-ci-on-docs-changes July 1, 2025 13:31
@NickVolynkin Nick Volynkin (NickVolynkin) changed the title [docs] Changelog for v0.32.1 and changelog template [docs] Changelogs for v0.32 series and changelog template Jul 1, 2025
@NickVolynkin
Nick Volynkin (NickVolynkin) force-pushed the changelogs-release-v0.32.x branch 2 times, most recently from 27dd4ef to 44d4b09 Compare July 2, 2025 06:33
Base automatically changed from skip-ci-on-docs-changes to main July 2, 2025 08:57

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 0

🧹 Nitpick comments (4)
docs/changelogs/v0.32.2.md (2)

9-9: Plural form: replace possessive “README's” with “READMEs”.

-* [apps] Give examples of new resource definitions in the managed app README's. (@NickVolynkin in https://github.com/cozystack/cozystack/pull/1120)
+* [apps] Give examples of new resource definitions in the managed app READMEs. (@NickVolynkin in https://github.com/cozystack/cozystack/pull/1120)

22-22: Add missing article “an”.

-* [apps] Enable selecting `resourcePreset` from a drop-down list for all applications by adding enum of allowed values in the config scheme. (@NickVolynkin in https://github.com/cozystack/cozystack/pull/1117)
+* [apps] Enable selecting `resourcePreset` from a drop-down list for all applications by adding an enum of allowed values in the config scheme. (@NickVolynkin in https://github.com/cozystack/cozystack/pull/1117)
docs/changelogs/v0.32.1.md (2)

12-12: Insert definite article “the” before option name.

-* [kubernetes] Remove `useCustomSecretForPatchContainerd` option and enable it by default. (@kvaps in https://github.com/cozystack/cozystack/pull/1104)
+* [kubernetes] Remove the `useCustomSecretForPatchContainerd` option and enable it by default. (@kvaps in https://github.com/cozystack/cozystack/pull/1104)

30-32: Minor wording & capitalisation tweaks for consistency.

-* [tests] Upd Kubernetes v1.33. (@kvaps in https://github.com/cozystack/cozystack/pull/1083)
-* [tests] increase postgres timeouts. (@kvaps in https://github.com/cozystack/cozystack/pull/1108)
-* [tests] don't wait for postgres ro service. (@kvaps in https://github.com/cozystack/cozystack/pull/1109)
+* [tests] Update Kubernetes to v1.33. (@kvaps in https://github.com/cozystack/cozystack/pull/1083)
+* [tests] Increase PostgreSQL timeouts. (@kvaps in https://github.com/cozystack/cozystack/pull/1108)
+* [tests] Don’t wait for the PostgreSQL read-only service. (@kvaps in https://github.com/cozystack/cozystack/pull/1109)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 10dbe9e and 2404bf5.

📒 Files selected for processing (3)
  • docs/changelogs/template.md (1 hunks)
  • docs/changelogs/v0.32.1.md (1 hunks)
  • docs/changelogs/v0.32.2.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/changelogs/template.md
🧰 Additional context used
🧠 Learnings (1)
docs/changelogs/v0.32.2.md (1)
Learnt from: NickVolynkin
PR: cozystack/cozystack#1120
File: packages/apps/ferretdb/README.md:35-37
Timestamp: 2025-07-02T09:58:11.385Z
Learning: In the cozystack repository, the maintainer NickVolynkin prefers to keep realistic-looking example credentials in README documentation rather than using generic placeholders like <ACCESS_KEY>, even though they are just examples and not real secrets.
🪛 LanguageTool
docs/changelogs/v0.32.1.md

[uncategorized] ~12-~12: You might be missing the article “the” here.
Context: ...ystack/pull/1076) * [kubernetes] Remove useCustomSecretForPatchContainerd optio...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

docs/changelogs/v0.32.2.md

[uncategorized] ~22-~22: You might be missing the article “an” here.
Context: ...own list for all applications by adding enum of allowed values in the config scheme....

(AI_EN_LECTOR_MISSING_DETERMINER_AN)

🪛 markdownlint-cli2 (0.17.2)
docs/changelogs/v0.32.1.md

5-5: Bare URL used

(MD034, no-bare-urls)


6-6: Bare URL used

(MD034, no-bare-urls)


7-7: Bare URL used

(MD034, no-bare-urls)


8-8: Bare URL used

(MD034, no-bare-urls)


9-9: Bare URL used

(MD034, no-bare-urls)


10-10: Bare URL used

(MD034, no-bare-urls)


14-14: Bare URL used

(MD034, no-bare-urls)


18-18: Bare URL used

(MD034, no-bare-urls)


19-19: Bare URL used

(MD034, no-bare-urls)


20-20: Bare URL used

(MD034, no-bare-urls)


21-21: Bare URL used

(MD034, no-bare-urls)


22-22: Bare URL used

(MD034, no-bare-urls)


26-26: Bare URL used

(MD034, no-bare-urls)


27-27: Bare URL used

(MD034, no-bare-urls)


28-28: Bare URL used

(MD034, no-bare-urls)


29-29: Bare URL used

(MD034, no-bare-urls)


30-30: Bare URL used

(MD034, no-bare-urls)


31-31: Bare URL used

(MD034, no-bare-urls)


31-31: Bare URL used

(MD034, no-bare-urls)


31-31: Bare URL used

(MD034, no-bare-urls)


32-32: Bare URL used

(MD034, no-bare-urls)

docs/changelogs/v0.32.2.md

5-5: Bare URL used

(MD034, no-bare-urls)


6-6: Bare URL used

(MD034, no-bare-urls)


7-7: Bare URL used

(MD034, no-bare-urls)


8-8: Bare URL used

(MD034, no-bare-urls)


9-9: Bare URL used

(MD034, no-bare-urls)


10-10: Bare URL used

(MD034, no-bare-urls)


14-14: Bare URL used

(MD034, no-bare-urls)


18-18: Bare URL used

(MD034, no-bare-urls)


19-19: Bare URL used

(MD034, no-bare-urls)


20-20: Bare URL used

(MD034, no-bare-urls)


21-21: Bare URL used

(MD034, no-bare-urls)


22-22: Bare URL used

(MD034, no-bare-urls)


26-26: Bare URL used

(MD034, no-bare-urls)


27-27: Bare URL used

(MD034, no-bare-urls)


28-28: Bare URL used

(MD034, no-bare-urls)


29-29: Bare URL used

(MD034, no-bare-urls)


30-30: Bare URL used

(MD034, no-bare-urls)


31-31: Bare URL used

(MD034, no-bare-urls)


31-31: Bare URL used

(MD034, no-bare-urls)


31-31: Bare URL used

(MD034, no-bare-urls)


32-32: Bare URL used

(MD034, no-bare-urls)

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 0

🧹 Nitpick comments (6)
docs/changelogs/v0.32.1.md (3)

11-13: Add missing article for clarity

“The” is missing before the option name, which makes the sentence feel abrupt.

-* [kubernetes] Remove `useCustomSecretForPatchContainerd` option and enable it by default. (@kvaps in https://github.com/cozystack/cozystack/pull/1104)
+* [kubernetes] Remove **the** `useCustomSecretForPatchContainerd` option and enable it by default. (@kvaps in https://github.com/cozystack/cozystack/pull/1104)

28-33: Normalize wording and capitalisation in the Testing/CI section

A couple of list items use inconsistent abbreviations or lowercase product names. Keeping a uniform style improves readability.

-* [tests] Upd Kubernetes v1.33. (@kvaps in https://github.com/cozystack/cozystack/pull/1083)
-* [tests] increase postgres timeouts. (@kvaps in https://github.com/cozystack/cozystack/pull/1108)
-* [tests] don't wait for postgres ro service. (@kvaps in https://github.com/cozystack/cozystack/pull/1109)
+* [tests] Update Kubernetes to v1.33. (@kvaps in https://github.com/cozystack/cozystack/pull/1083)
+* [tests] Increase PostgreSQL timeouts. (@kvaps in https://github.com/cozystack/cozystack/pull/1108)
+* [tests] Don't wait for the PostgreSQL RO service. (@kvaps in https://github.com/cozystack/cozystack/pull/1109)

1-38: Optional: convert bare PR URLs to Markdown links

markdownlint flags every bare URL with MD034. Re-formatting them as Markdown links keeps the document linter-clean and shortens the lines:

(@kvaps in [#1104])

with a references section at the bottom:

[#1104]: https://github.com/cozystack/cozystack/pull/1104

Purely cosmetic, feel free to skip if the project intentionally ignores MD034.

docs/changelogs/v0.32.2.md (3)

8-10: Remove stray apostrophe in “README's”

Plural of README is usually “READMEs”; the apostrophe implies possession.

-* [apps] Give examples of new resource definitions in the managed app README's. (@NickVolynkin in https://github.com/cozystack/cozystack/pull/1120)
+* [apps] Provide examples of the new resource definitions in managed app READMEs. (@NickVolynkin in https://github.com/cozystack/cozystack/pull/1120)

1-34: Optional: address MD034 bare-URL warnings

As with the 0.32.1 changelog, every raw PR URL triggers markdownlint MD034. Converting them to reference-style links will silence the warnings and shorten bullets.

Same approach as outlined in the previous file.


33-34: Ensure file ends with a newline

Some editors/tools complain if a text file lacks a trailing newline. Adding one keeps Git diffs cleaner in future edits.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2404bf5 and a924ff2.

📒 Files selected for processing (3)
  • docs/changelogs/template.md (1 hunks)
  • docs/changelogs/v0.32.1.md (1 hunks)
  • docs/changelogs/v0.32.2.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/changelogs/template.md
🧰 Additional context used
🧠 Learnings (1)
docs/changelogs/v0.32.2.md (1)
Learnt from: NickVolynkin
PR: cozystack/cozystack#1120
File: packages/apps/ferretdb/README.md:35-37
Timestamp: 2025-07-02T09:58:11.385Z
Learning: In the cozystack repository, the maintainer NickVolynkin prefers to keep realistic-looking example credentials in README documentation rather than using generic placeholders like <ACCESS_KEY>, even though they are just examples and not real secrets.
🪛 LanguageTool
docs/changelogs/v0.32.1.md

[uncategorized] ~12-~12: You might be missing the article “the” here.
Context: ...ystack/pull/1076) * [kubernetes] Remove useCustomSecretForPatchContainerd optio...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

🪛 markdownlint-cli2 (0.17.2)
docs/changelogs/v0.32.1.md

5-5: Bare URL used

(MD034, no-bare-urls)


6-6: Bare URL used

(MD034, no-bare-urls)


7-7: Bare URL used

(MD034, no-bare-urls)


8-8: Bare URL used

(MD034, no-bare-urls)


9-9: Bare URL used

(MD034, no-bare-urls)


10-10: Bare URL used

(MD034, no-bare-urls)


14-14: Bare URL used

(MD034, no-bare-urls)


18-18: Bare URL used

(MD034, no-bare-urls)


19-19: Bare URL used

(MD034, no-bare-urls)


20-20: Bare URL used

(MD034, no-bare-urls)


21-21: Bare URL used

(MD034, no-bare-urls)


22-22: Bare URL used

(MD034, no-bare-urls)


23-23: Bare URL used

(MD034, no-bare-urls)


27-27: Bare URL used

(MD034, no-bare-urls)


28-28: Bare URL used

(MD034, no-bare-urls)


29-29: Bare URL used

(MD034, no-bare-urls)


30-30: Bare URL used

(MD034, no-bare-urls)


31-31: Bare URL used

(MD034, no-bare-urls)


32-32: Bare URL used

(MD034, no-bare-urls)


32-32: Bare URL used

(MD034, no-bare-urls)


32-32: Bare URL used

(MD034, no-bare-urls)


33-33: Bare URL used

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: pre-commit

@NickVolynkin Nick Volynkin (NickVolynkin) changed the title [docs] Changelogs for v0.32 series and changelog template [docs] Changelogs for v0.33.0, v0.32 series and changelog template Jul 4, 2025

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 0

🧹 Nitpick comments (3)
docs/changelogs/v0.33.0.md (3)

1-2: Add a top-level version heading for clarity & consistency

Other changelog files usually start with a heading that states the version (and often the release date). Without it, the rendered table-of-contents skips the version label, making navigation harder.

+# v0.33.0 – 2025-07-xx
+
 ## Features and Improvements

26-26: Grammar tweak: missing article before “enum”

-* [apps] Enable selecting `resourcePreset` from a drop-down list for all applications by adding enum of allowed values in the config scheme. (@NickVolynkin in https://github.com/cozystack/cozystack/pull/1117)
+* [apps] Enable selecting `resourcePreset` from a drop-down list for all applications by adding **an** enum of allowed values in the config scheme. (@NickVolynkin in https://github.com/cozystack/cozystack/pull/1117)

3-41: Bare URLs trigger markdownlint MD034

markdownlint flags every bare URL. Wrapping them in <…> or turning them into reference links silences the warning and improves consistency, but it’s optional because GitHub renders bare URLs fine.

Consider whether you want to appease the linter or ignore MD034 project-wide.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a924ff2 and 2c8e84e.

📒 Files selected for processing (1)
  • docs/changelogs/v0.33.0.md (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
docs/changelogs/v0.33.0.md (1)
Learnt from: NickVolynkin
PR: cozystack/cozystack#1120
File: packages/apps/ferretdb/README.md:35-37
Timestamp: 2025-07-02T09:58:11.385Z
Learning: In the cozystack repository, the maintainer NickVolynkin prefers to keep realistic-looking example credentials in README documentation rather than using generic placeholders like <ACCESS_KEY>, even though they are just examples and not real secrets.
🪛 LanguageTool
docs/changelogs/v0.33.0.md

[uncategorized] ~26-~26: You might be missing the article “an” here.
Context: ...own list for all applications by adding enum of allowed values in the config scheme....

(AI_EN_LECTOR_MISSING_DETERMINER_AN)

🪛 markdownlint-cli2 (0.17.2)
docs/changelogs/v0.33.0.md

3-3: Bare URL used

(MD034, no-bare-urls)


4-4: Bare URL used

(MD034, no-bare-urls)


4-4: Bare URL used

(MD034, no-bare-urls)


5-5: Bare URL used

(MD034, no-bare-urls)


6-6: Bare URL used

(MD034, no-bare-urls)


7-7: Bare URL used

(MD034, no-bare-urls)


8-8: Bare URL used

(MD034, no-bare-urls)


9-9: Bare URL used

(MD034, no-bare-urls)


10-10: Bare URL used

(MD034, no-bare-urls)


11-11: Bare URL used

(MD034, no-bare-urls)


12-12: Bare URL used

(MD034, no-bare-urls)


16-16: Bare URL used

(MD034, no-bare-urls)


20-20: Bare URL used

(MD034, no-bare-urls)


21-21: Bare URL used

(MD034, no-bare-urls)


22-22: Bare URL used

(MD034, no-bare-urls)


23-23: Bare URL used

(MD034, no-bare-urls)


24-24: Bare URL used

(MD034, no-bare-urls)


25-25: Bare URL used

(MD034, no-bare-urls)


26-26: Bare URL used

(MD034, no-bare-urls)


27-27: Bare URL used

(MD034, no-bare-urls)


28-28: Bare URL used

(MD034, no-bare-urls)


33-33: Bare URL used

(MD034, no-bare-urls)


34-34: Bare URL used

(MD034, no-bare-urls)


35-35: Bare URL used

(MD034, no-bare-urls)


36-36: Bare URL used

(MD034, no-bare-urls)


37-37: Bare URL used

(MD034, no-bare-urls)


38-38: Bare URL used

(MD034, no-bare-urls)


39-39: Bare URL used

(MD034, no-bare-urls)


39-39: Bare URL used

(MD034, no-bare-urls)


39-39: Bare URL used

(MD034, no-bare-urls)


39-39: Bare URL used

(MD034, no-bare-urls)


40-40: Bare URL used

(MD034, no-bare-urls)


41-41: Bare URL used

(MD034, no-bare-urls)


44-44: Bare URL used

(MD034, no-bare-urls)

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 0

🧹 Nitpick comments (4)
docs/changelogs/v0.33.0.md (4)

8-8: Insert missing article “a” before “tenant Kubernetes cluster”.

-* [kubernetes] Add an option to expose the Ingress-NGINX controller in tenant Kubernetes cluster via LoadBalancer. New configuration value `exposeMethod` offers a choice of `Proxied` and `LoadBalancer`. (@kvaps in https://github.com/cozystack/cozystack/pull/1114)
+* [kubernetes] Add an option to expose the Ingress-NGINX controller in a tenant Kubernetes cluster via a LoadBalancer. New configuration value `exposeMethod` offers a choice of `Proxied` and `LoadBalancer`. (@kvaps in https://github.com/cozystack/cozystack/pull/1114)

20-20: Remove stray space before period.

-* [platform] Always set resources for managed apps .
+* [platform] Always set resources for managed apps.

26-26: Add article “an” before “enum”.

-* [apps] Enable selecting `resourcePreset` from a drop-down list for all applications by adding enum of allowed values in the config scheme. (@NickVolynkin in https://github.com/cozystack/cozystack/pull/1117)
+* [apps] Enable selecting `resourcePreset` from a drop-down list for all applications by adding an enum of allowed values in the config scheme. (@NickVolynkin in https://github.com/cozystack/cozystack/pull/1117)

3-41: Consider replacing bare URLs with markdown links to satisfy MD034 lint rule.

For example:

-* [virtual-machine] Configure CPU sockets available to VMs with the `resources.cpu.sockets` configuration value. (@klinch0 in https://github.com/cozystack/cozystack/pull/1131)
+* [virtual-machine] Configure CPU sockets available to VMs with the `resources.cpu.sockets` configuration value. ([@klinch0](https://github.com/cozystack/cozystack/pull/1131))

Converting the GitHub PR references throughout the changelog will silence the markdown-lint warnings while improving readability.
[optional]

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2c8e84e and 37cdd08.

📒 Files selected for processing (1)
  • docs/changelogs/v0.33.0.md (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
docs/changelogs/v0.33.0.md (2)
Learnt from: NickVolynkin
PR: cozystack/cozystack#1120
File: packages/apps/ferretdb/README.md:35-37
Timestamp: 2025-07-02T09:58:11.385Z
Learning: In the cozystack repository, the maintainer NickVolynkin prefers to keep realistic-looking example credentials in README documentation rather than using generic placeholders like <ACCESS_KEY>, even though they are just examples and not real secrets.
Learnt from: NickVolynkin
PR: cozystack/cozystack#1120
File: packages/apps/clickhouse/README.md:60-67
Timestamp: 2025-07-03T05:54:50.989Z
Learning: The `cozy-lib.resources.sanitize` function in packages/library/cozy-lib/templates/_resources.tpl supports both standard Kubernetes resource format (with limits:/requests: sections) and flat format (direct resource specifications). The flat format takes priority over nested values. CozyStack apps include cozy-lib as a chart dependency through symlinks in packages/apps/*/charts/cozy-lib directories.
🪛 LanguageTool
docs/changelogs/v0.33.0.md

[grammar] ~8-~8: The singular proper name ‘Kubernetes’ must be used with a third-person or a past tense verb.
Context: ...s-NGINX controller in tenant Kubernetes cluster via LoadBalancer. New configuration val...

(HE_VERB_AGR)


[uncategorized] ~8-~8: A determiner appears to be missing. Consider inserting it.
Context: ...nt Kubernetes cluster via LoadBalancer. New configuration value exposeMethod offe...

(AI_EN_LECTOR_MISSING_DETERMINER)


[uncategorized] ~26-~26: You might be missing the article “an” here.
Context: ...own list for all applications by adding enum of allowed values in the config scheme....

(AI_EN_LECTOR_MISSING_DETERMINER_AN)

🪛 markdownlint-cli2 (0.17.2)
docs/changelogs/v0.33.0.md

3-3: Bare URL used

(MD034, no-bare-urls)


4-4: Bare URL used

(MD034, no-bare-urls)


4-4: Bare URL used

(MD034, no-bare-urls)


5-5: Bare URL used

(MD034, no-bare-urls)


6-6: Bare URL used

(MD034, no-bare-urls)


7-7: Bare URL used

(MD034, no-bare-urls)


8-8: Bare URL used

(MD034, no-bare-urls)


9-9: Bare URL used

(MD034, no-bare-urls)


10-10: Bare URL used

(MD034, no-bare-urls)


11-11: Bare URL used

(MD034, no-bare-urls)


12-12: Bare URL used

(MD034, no-bare-urls)


16-16: Bare URL used

(MD034, no-bare-urls)


20-20: Bare URL used

(MD034, no-bare-urls)


21-21: Bare URL used

(MD034, no-bare-urls)


22-22: Bare URL used

(MD034, no-bare-urls)


23-23: Bare URL used

(MD034, no-bare-urls)


24-24: Bare URL used

(MD034, no-bare-urls)


25-25: Bare URL used

(MD034, no-bare-urls)


26-26: Bare URL used

(MD034, no-bare-urls)


27-27: Bare URL used

(MD034, no-bare-urls)


28-28: Bare URL used

(MD034, no-bare-urls)


33-33: Bare URL used

(MD034, no-bare-urls)


34-34: Bare URL used

(MD034, no-bare-urls)


35-35: Bare URL used

(MD034, no-bare-urls)


36-36: Bare URL used

(MD034, no-bare-urls)


37-37: Bare URL used

(MD034, no-bare-urls)


38-38: Bare URL used

(MD034, no-bare-urls)


38-38: Bare URL used

(MD034, no-bare-urls)


38-38: Bare URL used

(MD034, no-bare-urls)


38-38: Bare URL used

(MD034, no-bare-urls)


39-39: Bare URL used

(MD034, no-bare-urls)


40-40: Bare URL used

(MD034, no-bare-urls)


43-43: Bare URL used

(MD034, no-bare-urls)

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 1

🧹 Nitpick comments (7)
docs/changelogs/v0.32.1.md (3)

1-2: Add a release heading for context

Consider starting the file with a top-level heading such as
# v0.32.1 – 2025-07-?? (date optional) so that readers immediately know which version they are reading about.


9-15: Minor wording tweaks

A couple of bullet titles could be clearer:

  1. “Escape users and database names” → “Escape PostgreSQL user and database names”
  2. “Increase default resource presets …” – “presets” is already plural; the “default” qualifier can be dropped to avoid repetition.

Not blocking, just polish.


18-21: Optional: replace bare GitHub URLs with markdown links

Many projects silence MD034 by wrapping bare URLs:

* Update cozy-proxy to v0.2.0 ([#1081])
…
[#1081]: https://github.com/cozystack/cozystack/pull/1081

If you do care about a clean markdownlint run, this is the quickest win.

docs/changelogs/v0.33.0.md (4)

1-2: Include the release date next to the version

For consistency with earlier changelogs, prepend the date, e.g.:

# Release v0.33.0 – 2025-07-??

56-57: Grammar: missing article before “tenant Kubernetes cluster”

“controller in tenant Kubernetes cluster”

Insert “the” for correctness:

- controller in tenant Kubernetes cluster
+ controller in the tenant Kubernetes cluster

68-69: Extraneous space before period

managed apps .managed apps.

-* [platform] Always set resources for managed apps .
+* [platform] Always set resources for managed apps.

47-48: Optional: silence markdownlint MD034

As with the previous file, swapping bare links for reference-style links will remove the warnings and improve readability.

Also applies to: 51-56, 81-88

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 37cdd08 and c1f9b3d.

📒 Files selected for processing (3)
  • docs/changelogs/template.md (1 hunks)
  • docs/changelogs/v0.32.1.md (1 hunks)
  • docs/changelogs/v0.33.0.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/changelogs/template.md
🧰 Additional context used
🧠 Learnings (1)
docs/changelogs/v0.33.0.md (1)
Learnt from: NickVolynkin
PR: cozystack/cozystack#1120
File: packages/apps/ferretdb/README.md:35-37
Timestamp: 2025-07-02T09:58:11.385Z
Learning: In the cozystack repository, the maintainer NickVolynkin prefers to keep realistic-looking example credentials in README documentation rather than using generic placeholders like <ACCESS_KEY>, even though they are just examples and not real secrets.
🪛 LanguageTool
docs/changelogs/v0.33.0.md

[grammar] ~56-~56: The singular proper name ‘Kubernetes’ must be used with a third-person or a past tense verb.
Context: ...s-NGINX controller in tenant Kubernetes cluster via LoadBalancer. New configuration val...

(HE_VERB_AGR)


[uncategorized] ~56-~56: A determiner appears to be missing. Consider inserting it.
Context: ...nt Kubernetes cluster via LoadBalancer. New configuration value exposeMethod offe...

(AI_EN_LECTOR_MISSING_DETERMINER)


[uncategorized] ~74-~74: You might be missing the article “an” here.
Context: ...own list for all applications by adding enum of allowed values in the config scheme....

(AI_EN_LECTOR_MISSING_DETERMINER_AN)

docs/changelogs/v0.32.1.md

[uncategorized] ~12-~12: You might be missing the article “the” here.
Context: ...ystack/pull/1076) * [kubernetes] Remove useCustomSecretForPatchContainerd optio...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

🪛 markdownlint-cli2 (0.17.2)
docs/changelogs/v0.33.0.md

47-47: Bare URL used

(MD034, no-bare-urls)


51-51: Bare URL used

(MD034, no-bare-urls)


52-52: Bare URL used

(MD034, no-bare-urls)


53-53: Bare URL used

(MD034, no-bare-urls)


54-54: Bare URL used

(MD034, no-bare-urls)


55-55: Bare URL used

(MD034, no-bare-urls)


56-56: Bare URL used

(MD034, no-bare-urls)


57-57: Bare URL used

(MD034, no-bare-urls)


58-58: Bare URL used

(MD034, no-bare-urls)


59-59: Bare URL used

(MD034, no-bare-urls)


60-60: Bare URL used

(MD034, no-bare-urls)


64-64: Bare URL used

(MD034, no-bare-urls)


68-68: Bare URL used

(MD034, no-bare-urls)


69-69: Bare URL used

(MD034, no-bare-urls)


70-70: Bare URL used

(MD034, no-bare-urls)


71-71: Bare URL used

(MD034, no-bare-urls)


72-72: Bare URL used

(MD034, no-bare-urls)


73-73: Bare URL used

(MD034, no-bare-urls)


74-74: Bare URL used

(MD034, no-bare-urls)


75-75: Bare URL used

(MD034, no-bare-urls)


76-76: Bare URL used

(MD034, no-bare-urls)


81-81: Bare URL used

(MD034, no-bare-urls)


82-82: Bare URL used

(MD034, no-bare-urls)


83-83: Bare URL used

(MD034, no-bare-urls)


84-84: Bare URL used

(MD034, no-bare-urls)


85-85: Bare URL used

(MD034, no-bare-urls)


86-86: Bare URL used

(MD034, no-bare-urls)


86-86: Bare URL used

(MD034, no-bare-urls)


86-86: Bare URL used

(MD034, no-bare-urls)


86-86: Bare URL used

(MD034, no-bare-urls)


87-87: Bare URL used

(MD034, no-bare-urls)


88-88: Bare URL used

(MD034, no-bare-urls)


91-91: Bare URL used

(MD034, no-bare-urls)

docs/changelogs/v0.32.1.md

3-3: Bare URL used

(MD034, no-bare-urls)


4-4: Bare URL used

(MD034, no-bare-urls)


5-5: Bare URL used

(MD034, no-bare-urls)


9-9: Bare URL used

(MD034, no-bare-urls)


10-10: Bare URL used

(MD034, no-bare-urls)


11-11: Bare URL used

(MD034, no-bare-urls)


12-12: Bare URL used

(MD034, no-bare-urls)


13-13: Bare URL used

(MD034, no-bare-urls)


13-13: Bare URL used

(MD034, no-bare-urls)


14-14: Bare URL used

(MD034, no-bare-urls)


18-18: Bare URL used

(MD034, no-bare-urls)


19-19: Bare URL used

(MD034, no-bare-urls)


19-19: Bare URL used

(MD034, no-bare-urls)


20-20: Bare URL used

(MD034, no-bare-urls)


24-24: Bare URL used

(MD034, no-bare-urls)


28-28: Bare URL used

(MD034, no-bare-urls)


29-29: Bare URL used

(MD034, no-bare-urls)


30-30: Bare URL used

(MD034, no-bare-urls)


31-31: Bare URL used

(MD034, no-bare-urls)


32-32: Bare URL used

(MD034, no-bare-urls)


33-33: Bare URL used

(MD034, no-bare-urls)


34-34: Bare URL used

(MD034, no-bare-urls)


35-35: Bare URL used

(MD034, no-bare-urls)


36-36: Bare URL used

(MD034, no-bare-urls)


38-38: Bare URL used

(MD034, no-bare-urls)

Comment thread docs/changelogs/v0.33.0.md Outdated
Comment on lines +14 to +16
```yaml
# resourcePrese
# resource definition in the configuration

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.

⚠️ Potential issue

Typo in comment label

# resourcePrese is truncated. Replace with # resourcePreset.

-# resourcePrese
+# resourcePreset
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
```yaml
# resourcePrese
# resource definition in the configuration
🤖 Prompt for AI Agents
In docs/changelogs/v0.33.0.md around lines 14 to 16, the comment label `#
resourcePrese` is truncated and should be corrected to `# resourcePreset`.
Update the comment to use the full and correct label `# resourcePreset`.

Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
@NickVolynkin Nick Volynkin (NickVolynkin) changed the title [docs] Changelogs for v0.33.0, v0.32 series and changelog template [docs] Changelogs for v0.32.1 and changelog template Jul 10, 2025

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 0

🧹 Nitpick comments (2)
docs/changelogs/v0.32.1.md (2)

3-36: Wrap bare URLs in Markdown links to silence MD034 and improve readability.

markdownlint flags every naked GitHub URL.
Converting them to proper link syntax keeps the list readable and makes the linter happy:

-* [postgres] Introduce new functionality for backup and restore in PostgreSQL. (@klinch0 in https://github.com/cozystack/cozystack/pull/1086)
+* [postgres] Introduce new functionality for backup and restore in PostgreSQL. \
+  ([@klinch0](https://github.com/klinch0) in \
+  [cozystack#1086](https://github.com/cozystack/cozystack/pull/1086))

Applying the same pattern to the remaining bullets will eliminate the 20+ MD034 warnings.


28-32: Align wording & casing for test-related bullets.

Two tiny inconsistencies make the list look uneven:

-* [tests] Upd Kubernetes v1.33.
+* [tests] Update Kubernetes to v1.33.
-* [tests] increase postgres timeouts.
+* [tests] Increase PostgreSQL time-outs.

(This keeps style consistent with neighbouring bullets that start with a capital verb.)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c1f9b3d and ef30e69.

📒 Files selected for processing (2)
  • docs/changelogs/template.md (1 hunks)
  • docs/changelogs/v0.32.1.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/changelogs/template.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/changelogs/v0.32.1.md

3-3: Bare URL used

(MD034, no-bare-urls)


4-4: Bare URL used

(MD034, no-bare-urls)


5-5: Bare URL used

(MD034, no-bare-urls)


9-9: Bare URL used

(MD034, no-bare-urls)


10-10: Bare URL used

(MD034, no-bare-urls)


11-11: Bare URL used

(MD034, no-bare-urls)


12-12: Bare URL used

(MD034, no-bare-urls)


13-13: Bare URL used

(MD034, no-bare-urls)


13-13: Bare URL used

(MD034, no-bare-urls)


14-14: Bare URL used

(MD034, no-bare-urls)


18-18: Bare URL used

(MD034, no-bare-urls)


19-19: Bare URL used

(MD034, no-bare-urls)


19-19: Bare URL used

(MD034, no-bare-urls)


20-20: Bare URL used

(MD034, no-bare-urls)


24-24: Bare URL used

(MD034, no-bare-urls)


28-28: Bare URL used

(MD034, no-bare-urls)


29-29: Bare URL used

(MD034, no-bare-urls)


30-30: Bare URL used

(MD034, no-bare-urls)


31-31: Bare URL used

(MD034, no-bare-urls)


32-32: Bare URL used

(MD034, no-bare-urls)


33-33: Bare URL used

(MD034, no-bare-urls)


34-34: Bare URL used

(MD034, no-bare-urls)


35-35: Bare URL used

(MD034, no-bare-urls)


36-36: Bare URL used

(MD034, no-bare-urls)


38-38: Bare URL used

(MD034, no-bare-urls)

🔇 Additional comments (1)
docs/changelogs/v0.32.1.md (1)

1-1: Consider adding a release title (version + date).

Most changelog entries in this repo start with something like
# v0.32.1 – 2025-07-18 (or similar) to make the file self-contained and “greppable”.
If another file does not already inject this heading, please add it here.

@lllamnyp
Timofei Larkin (lllamnyp) merged commit 6e96dd0 into main Jul 10, 2025
3 checks passed
@lllamnyp
Timofei Larkin (lllamnyp) deleted the changelogs-release-v0.32.x branch July 10, 2025 09:13
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.

2 participants