Skip to content
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

add OCW_STUDIO_DELETABLE_CONTENT_TYPES #2995

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

pdpinch
Copy link
Member

@pdpinch pdpinch commented Feb 27, 2025

This env setting controls which types of objects can be deleted

What are the relevant tickets?

N/A, but related to mitodl/ocw-studio#2384

This env setting controls which types of objects can be deleted
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Hello @pdpinch, I'm Gemini Code Assist1! 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!

Summary of Changes

This pull request introduces a new environment variable, OCW_STUDIO_DELETABLE_CONTENT_TYPES, to control which types of objects can be deleted within the OCW Studio application. The change adds this variable to the default environment configuration in src/ol_infrastructure/applications/ocw_studio/__main__.py and sets its default value to 'external-resource,instructor,page,course-collection'. This is related to an existing pull request #2384.

Highlights

  • New Environment Variable: Introduces OCW_STUDIO_DELETABLE_CONTENT_TYPES to manage deletable object types.
  • Configuration: Sets a default value for the new environment variable in the application's configuration.

Changelog

  • src/ol_infrastructure/applications/ocw_studio/main.py
    • Added OCW_STUDIO_DELETABLE_CONTENT_TYPES environment variable.
    • Set default value to 'external-resource,instructor,page,course-collection'.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

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 issue 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 is currently in preview and 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 to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.


Trivia time!

What is YAML, and what is it commonly used for in software development?

Click here for the answer
YAML (YAML Ain't Markup Language) is a human-readable data-serialization language. It is commonly used for configuration files and in applications where data is being stored or transmitted.

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.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

The pull request introduces a new environment variable OCW_STUDIO_DELETABLE_CONTENT_TYPES to control which types of objects can be deleted in OCW Studio. The change itself is straightforward, adding the variable with a default value to the Heroku configuration. However, it's important to consider the implications of this change and ensure it's well-documented and tested.

Summary of Findings

Merge Readiness

The addition of the environment variable seems reasonable. Since there are no CRITICAL or HIGH severity issues, the pull request is likely ready to be merged, but I would recommend that the author add documentation to the README file. I am unable to approve this pull request, and recommend that users have others review and approve this code before merging.

@pdpinch
Copy link
Member Author

pdpinch commented Feb 27, 2025

I turned on the posthog feature flag for deleting items in Studio so I could delete a page in production, but it wasn't working -- even though it worked fine on RC. @pt2302 identified that this environment variable was set on RC in Heroku but not in production. I set it manually, but it should go into here for persistence.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants