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

feat!: Drop sass support from problem/cappa xblocks #35811

Merged
merged 2 commits into from
Nov 13, 2024

Conversation

farhan
Copy link
Contributor

@farhan farhan commented Nov 8, 2024

feat!: Drop sass support from porblem/cappa xblocks

Parent story: #35300

Copy the following tasks into the PR description of the XBlock and update the status on PR.

Tasks:

  • Convert Sass variable into css variables

  • Compile the css file of the block following given steps.

    • Change this line to the following to avoid adding comments in the compiled css files
           source_comments: int = SASS_COMMENTS_NONE
    • Compile the sass to uncompressed CSS using following command
            npm run compile-sass-dev
    • Copy the compiled XBlock linked CSS (lms/static/css/*Display.css and lms/static/css/*Editor.css) into xmodule/static/css-builtin-blocks.
    • Format the CSS files using the editor.
    • Add those CSS files to version control.
  • Replace add_sass_to_fragment to add_css_to_fragment in blocks .py file

  • Remove all .scss files linked to the block under xmodule/assets.

    • Make sure to remove the .scss file in a separate alone commit so reviewer could review scss changes and they stay in history.
    • Don't remove the scss file if its linked to some other block.

Testing Notes:

  • Run npm run build to run webpack and compile sass files.
  • Run ./manage.py lms collectstatic in lms shell to re-collect static files.
  • Run ./manage.py cms collectstatic in cms shell to re-collect static files.
  • Verify the block's compiled css and the css global variables in the LMS
  • Verify the block's compiled css and the css global variables in the Studio
  • Test the XBlock rendering and User Experience in LMS
  • Test the XBlock rendering and User Experience in Studio

@farhan farhan changed the title feat!: Drop sass support from porblem/cappa xblocks feat!: Drop sass support from problem/cappa xblocks Nov 8, 2024
@farhan farhan force-pushed the farhan/problem-sass-to-css branch from 5111b21 to 3ea6a44 Compare November 8, 2024 11:06
@farhan farhan marked this pull request as ready for review November 8, 2024 12:18
@farhan farhan force-pushed the farhan/problem-sass-to-css branch from c2bd988 to 9b4e805 Compare November 8, 2024 12:22
@farhan farhan merged commit 421f28f into master Nov 13, 2024
51 checks passed
@farhan farhan deleted the farhan/problem-sass-to-css branch November 13, 2024 07:03
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

1 similar comment
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

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.

4 participants