Release 0.181.0

[odlbot]

pt2302

• Add documentation on cloning data from production for local development (Add documentation on cloning data from production for local development #2940) (b13ef9fd)
• Verify Google Drive credentials and fix command errors (Verify Google Drive credentials and fix command errors #2941) (4abe8bad)

renovate[bot]

• chore(deps): lock file maintenance (chore(deps): lock file maintenance #2466) (01142490)
• fix(deps): update dependency mathjax to v4 (fix(deps): update dependency mathjax to v4 #2938) (259e05d3)
• chore(deps): update astral-sh/setup-uv digest to 37802ad (chore(deps): update astral-sh/setup-uv digest to 37802ad #2936) (d85599fe)
• chore(deps): update dependency pytest-env to v1.6.0 (chore(deps): update dependency pytest-env to v1.6.0 #2937) (2a6948e4)
• chore(deps): update actions/setup-node digest to 53b8394 (chore(deps): update actions/setup-node digest to 53b8394 #2933) (a32ccb21)
• fix(deps): update dependency sentry-sdk to v2.54.0 (fix(deps): update dependency sentry-sdk to v2.54.0 #2935) (024a974f)
• fix(deps): update dependency boto3 to v1.42.68 (fix(deps): update dependency boto3 to v1.42.68 #2934) (4518999b)
• fix(deps): update dependency social-auth-app-django to v5.6.0 [security] (fix(deps): update dependency social-auth-app-django to v5.6.0 [security] #2752) (bbbf7d4a)

Umar Hassan

• feat: added django-removals for checking deprecations (feat: added django-removals for checking deprecations #2927) (cec0730b)

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request prepares for the release of version 0.181.0, bringing a suite of updates focused on enhancing developer experience, improving system stability through dependency upgrades, and introducing tools for better code quality. It includes critical documentation for local development setup and ensures the project remains current with its underlying technologies.

Highlights

• Dependency Updates: Numerous Python and JavaScript dependencies have been updated to their latest versions, including mathjax, boto3, sentry-sdk, social-auth-app-django, and pytest-env, ensuring the project uses up-to-date and secure libraries.
• New Feature: Deprecation Checking: The django-removals package has been integrated to facilitate checking for deprecations within the Django application, improving code maintainability and future compatibility.
• Improved Local Development Documentation: New documentation has been added to guide developers on how to clone production data for local development, streamlining the setup process for new environments.
• Test Refinements: Test cases for Hugo Markdown file serialization were refactored to use temporary paths and override settings, enhancing test isolation and reliability.
• Version Increment: The project version has been updated to 0.181.0, reflecting the collection of new features, bug fixes, and dependency upgrades included in this release.

Ignored Files

• Ignored by pattern: .github/workflows/** (1)
  • .github/workflows/ci.yml

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request updates the OCW Studio to release version 0.181.0, which includes documentation for cloning production data for local development, verification of Google Drive credentials, and various dependency updates. The review focuses on identifying potential issues and improvement opportunities, particularly in the areas of code correctness and maintainability, with some comments enhanced to reference established repository rules for modern testing practices.

I am having trouble creating individual review comments. Click here to see my feedback.

content_sync/serializers_test.py (112)

The settings fixture is being replaced with tmp_path. It's better to explicitly pass the fixtures that a test needs as arguments, rather than relying on implicit access via settings. This makes the test more readable and maintainable.

def test_hugo_file_serialize(tmp_path, markdown, exp_sections):

References

1. When adding new tests to a file containing a mix of unittest.TestCase and pytest styles, prefer the modern pytest-style (fixtures, standalone functions) as it is more consistent with the rest of the codebase. Explicitly passing fixtures aligns with modern pytest-style.

content_sync/serializers_test.py (114)

The mock_aws decorator is being removed and settings.OCW_STUDIO_USE_S3 = True is being replaced with override_settings(MEDIA_ROOT=str(tmp_path)). It's better to use override_settings to mock settings within a specific context, as it ensures that the setting is properly reset after the test, preventing unintended side effects on other tests.

    with override_settings(MEDIA_ROOT=str(tmp_path)):

References

1. When adding new tests to a file containing a mix of unittest.TestCase and pytest styles, prefer the modern pytest-style (fixtures, standalone functions) as it is more consistent with the rest of the codebase. Using override_settings for context-specific mocking aligns with robust, modern testing practices.

gdrive_sync/management/commands/create_missing_gdrive_folders.py (46-52)

The conditional check if settings.DRIVE_SHARED_ID and settings.DRIVE_SERVICE_ACCOUNT_CREDS: is being changed to if not settings.DRIVE_SHARED_ID or not settings.DRIVE_SERVICE_ACCOUNT_CREDS:. It's better to check for the inverse condition to raise the CommandError early, making the code more readable and easier to follow.

        if not settings.DRIVE_SHARED_ID or not settings.DRIVE_SERVICE_ACCOUNT_CREDS:
            msg = "DRIVE_SHARED_ID and DRIVE_SERVICE_ACCOUNT_CREDS must both be set"
            raise CommandError(msg)

gdrive_sync/management/commands/create_missing_gdrive_folders.py (78-80)

The conditional check if set(result) != {True}: is being changed to if error_lists:. It's better to check for the existence of errors directly, rather than comparing the set of results to {True}. This makes the code more readable and easier to understand.

        error_lists = [r for r in result if r is not True]
        if error_lists:
            failed_ids = list(chain.from_iterable(error_lists))
            msg = f"Some errors occurred for sites: {failed_ids}"
            raise CommandError(msg)

static/js/lib/ckeditor/turndown.ts (79)

The type of node is being cast to HTMLElement. It's better to use a more specific type if possible, to avoid potential runtime errors. In this case, it is known that the node should be an HTMLElement.

    return rule.replacement?.(content, node as HTMLElement, options)