Skip to content

Conversation

@fsbraun
Copy link
Member

@fsbraun fsbraun commented Dec 12, 2025

Summary by Sourcery

Enhancements:

  • Bump library version from 0.8.1 to 1.0.0 to mark the 1.0.0 release.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Dec 12, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Prepares the project for the 1.0.0 release by bumping the package version constant and touching the changelog file.

File-Level Changes

Change Details Files
Bump library version to 1.0.0 for the new release.
  • Update the version constant from 0.8.1 to 1.0.0.
djangocms_rest/__init__.py
Prepare the changelog file for the 1.0.0 release entry.
  • Modify the changelog file (content not shown in diff, likely to add or prepare a 1.0.0 section).
CHANGELOG.rst

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@codecov
Copy link

codecov bot commented Dec 12, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.98%. Comparing base (e5ef399) to head (c3defeb).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #89   +/-   ##
=======================================
  Coverage   91.98%   91.98%           
=======================================
  Files          19       19           
  Lines         886      886           
  Branches      100      100           
=======================================
  Hits          815      815           
  Misses         44       44           
  Partials       27       27           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes - here's some feedback:

  • The PR title contains a typo (Prepeare); consider correcting it to Prepare for clarity in release history.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The PR title contains a typo (`Prepeare`); consider correcting it to `Prepare` for clarity in release history.

## Individual Comments

### Comment 1
<location> `CHANGELOG.rst:25` </location>
<code_context>
+* fix: Respect ?preview for menu views by @fsbraun in https://github.com/django-cms/djangocms-rest/pull/70
+* fix: Check for toolbar attribute before setting preview mode on `?preview=1` request by @fsbraun in https://github.com/django-cms/djangocms-rest/pull/71
+* fix: try to fix the issue with coverage files not uploading by @vinitkumar in https://github.com/django-cms/djangocms-rest/pull/74
+* fix: readthedoc build by @fsbraun in https://github.com/django-cms/djangocms-rest/pull/76
+* fix: Add page path to node attributes by @fsbraun in https://github.com/django-cms/djangocms-rest/pull/78
+* fix: Add tests to verify caching behavior by @fsbraun in https://github.com/django-cms/djangocms-rest/pull/85
</code_context>

<issue_to_address>
**suggestion (typo):** Consider changing `readthedoc` to `readthedocs` for consistency with the earlier entry and the service name.

Using the plural form here ("readthedocs build") will match "readthedocs support" used earlier and align with the official service name, avoiding the appearance of a typo.

```suggestion
* fix: readthedocs build by @fsbraun in https://github.com/django-cms/djangocms-rest/pull/76
```
</issue_to_address>

### Comment 2
<location> `CHANGELOG.rst:18` </location>
<code_context>
+* feat: add package data configuration for static and template files by @metaforx in https://github.com/django-cms/djangocms-rest/pull/81
+* feat: Add page search endpoint by @fsbraun in https://github.com/django-cms/djangocms-rest/pull/64
+* feat: Preserve placeholder order by @metaforx in https://github.com/django-cms/djangocms-rest/pull/83
+* refactor: add distinct operationId in openapi schema for menu endpoin… by @metaforx in https://github.com/django-cms/djangocms-rest/pull/80
+* fix: OpenAPI schema for nested navigation by @metaforx in https://github.com/django-cms/djangocms-rest/pull/58
+* fix: Page serializer returned null for empty meta_description by @fsbraun in https://github.com/django-cms/djangocms-rest/pull/56
</code_context>

<issue_to_address>
**issue (typo):** The word `endpoin…` appears truncated; consider changing it to `endpoint`.

The trailing ellipsis makes this look like a mistakenly truncated `endpoint`, likely copied from a shortened title. Using the full word would read more clearly.

```suggestion
* refactor: add distinct operationId in openapi schema for menu endpoint by @metaforx in https://github.com/django-cms/djangocms-rest/pull/80
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

* fix: Respect ?preview for menu views by @fsbraun in https://github.com/django-cms/djangocms-rest/pull/70
* fix: Check for toolbar attribute before setting preview mode on `?preview=1` request by @fsbraun in https://github.com/django-cms/djangocms-rest/pull/71
* fix: try to fix the issue with coverage files not uploading by @vinitkumar in https://github.com/django-cms/djangocms-rest/pull/74
* fix: readthedoc build by @fsbraun in https://github.com/django-cms/djangocms-rest/pull/76
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion (typo): Consider changing readthedoc to readthedocs for consistency with the earlier entry and the service name.

Using the plural form here ("readthedocs build") will match "readthedocs support" used earlier and align with the official service name, avoiding the appearance of a typo.

Suggested change
* fix: readthedoc build by @fsbraun in https://github.com/django-cms/djangocms-rest/pull/76
* fix: readthedocs build by @fsbraun in https://github.com/django-cms/djangocms-rest/pull/76

* feat: add package data configuration for static and template files by @metaforx in https://github.com/django-cms/djangocms-rest/pull/81
* feat: Add page search endpoint by @fsbraun in https://github.com/django-cms/djangocms-rest/pull/64
* feat: Preserve placeholder order by @metaforx in https://github.com/django-cms/djangocms-rest/pull/83
* refactor: add distinct operationId in openapi schema for menu endpoin… by @metaforx in https://github.com/django-cms/djangocms-rest/pull/80
Copy link
Contributor

Choose a reason for hiding this comment

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

issue (typo): The word endpoin… appears truncated; consider changing it to endpoint.

The trailing ellipsis makes this look like a mistakenly truncated endpoint, likely copied from a shortened title. Using the full word would read more clearly.

Suggested change
* refactor: add distinct operationId in openapi schema for menu endpoin… by @metaforx in https://github.com/django-cms/djangocms-rest/pull/80
* refactor: add distinct operationId in openapi schema for menu endpoint by @metaforx in https://github.com/django-cms/djangocms-rest/pull/80

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