Skip to content

Commit

Permalink
refactor: address the feedback given
Browse files Browse the repository at this point in the history
* refactor: improve & update method of compiling themes
* refactor: enhance extra command logs
* docs: Clarify & complement changelog entry
  • Loading branch information
bra-i-am committed Jul 8, 2024
1 parent e186537 commit 30aecc3
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 8 deletions.
6 changes: 4 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

#### ⚠ BREAKING CHANGES

* Add support to Redwood ([885e0b9](https://github.com/eduNEXT/tutor-contrib-edunext-distro/commit/885e0b955722e4d86f89547764537ee74f707cf9)); the main change
* [Feature] Add support to Redwood ([885e0b9](https://github.com/eduNEXT/tutor-contrib-edunext-distro/commit/885e0b955722e4d86f89547764537ee74f707cf9))

* Fix when 'tutor distro enable-themes' was executed before, a new execution hung when it tried to overwrite the existing theme folder. The process requires confirmation ('yes') to proceed with the overwrite, but it did not receive this input automatically, leading to a freeze ([1924007](https://github.com/eduNEXT/tutor-contrib-edunext-distro/commit/1924007d121b46c9dc5949810f1e7f89fdf0fad2))
* [Bugfix] Adapt the inline Tutor plugin `openedx-dockerfile-pre-assets` to stop using the deprecated command [openedx-assets](https://github.com/overhangio/tutor/blob/master/CHANGELOG.md#v1800-2024-06-19:~:text=%F0%9F%92%A5%5BFeature%5D%20The%20openedx,or%20cms%20container%3A) for setting the pre-assets of the custom themes added with Distro ([885e0b9](https://github.com/eduNEXT/tutor-contrib-edunext-distro/commit/885e0b955722e4d86f89547764537ee74f707cf9#diff-d32c8a1ee8b6076c6fb3375498a9d455d41cad3104464e9b1e3900fd4265160a))

* [Bugfix] 'tutor distro enable-themes' command would hang when trying to overwrite an existing theme folder due to not being able to read the confirmation input ('yes') to perform the overwrite ([1924007](https://github.com/eduNEXT/tutor-contrib-edunext-distro/commit/1924007d121b46c9dc5949810f1e7f89fdf0fad2)).

## v17.2.0 - 2024-04-05

Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,14 +237,16 @@ tutor distro enable-themes
> tutor images build openedx-dev
> tutor dev do init
> tutor dev start
> tutor dev run lms openedx-assets themes --theme-dirs [THEME_DIRS] --themes [THEME_NAMES]
> tutor dev exec lms bash
> npm run compile-saas -- theme_dirs [THEME_DIRS] themes [THEME_NAMES]
> ```
>
> or
>
> ```bash
> tutor dev launch
> tutor dev run lms openedx-assets themes --theme-dirs [THEME_DIRS] --themes [THEME_NAMES]
> tutor dev exec lms bash
> npm run compile-saas -- theme_dirs [THEME_DIRS] themes [THEME_NAMES]
> ```

# Commands
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,6 @@ def run_command(self, command: str):
command (str): Tutor command.
"""
try:
print(f'Running "{command}"')

with subprocess.Popen(
command,
shell=True,
Expand All @@ -81,12 +79,16 @@ def run_command(self, command: str):
text=True,
) as process:

# It is sent a 'y' to say 'yes' on overriding the existing folders
stdout, stderr = process.communicate(input="y")

if process.returncode != 0 or "error" in stderr.lower():
raise subprocess.CalledProcessError(
process.returncode, command, output=stdout, stderr=stderr
)

# This print is left on purpose to show the command output
print(stdout)

except subprocess.CalledProcessError as error:
raise CommandError(f"\n{error.stderr}") from error
4 changes: 2 additions & 2 deletions tutordistro/patches/openedx-dockerfile-pre-assets
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ COPY --chown=app:app ./themes/ {{ DISTRO_THEMES_ROOT }}
{% endif %}
{% if DISTRO_THEME_DIRS is defined and DISTRO_THEMES_NAME is defined %}
RUN npm run compile-sass -- \
--theme-dir {{ DISTRO_THEME_DIRS | join(' --theme-dir ') }} \
--theme {{ DISTRO_THEMES_NAME | join(' --theme ') }} \
theme_dirs {{ DISTRO_THEME_DIRS | join(' ') }} \
themes {{ DISTRO_THEMES_NAME | join(' ') }} \
&& ./manage.py lms collectstatic --noinput --settings=tutor.assets \
&& rdfind -makesymlinks true -followsymlinks true /openedx/staticfiles/
{% endif %}

0 comments on commit 30aecc3

Please sign in to comment.