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: add picasso commands #1

Closed
wants to merge 1 commit into from
Closed

Conversation

MaferMazu
Copy link
Collaborator

@MaferMazu MaferMazu commented Jul 31, 2024

Description

This PR adds all the necessary files from tutor-contrib-edunext-distro to make the build functionalities.
The functionalities added:

# Validate the syntax and settings are properly set
tutor picasso syntax-validator

# Validate the repositories for packages are valid
tutor picasso repository-validator

# Enable themes
tutor picasso enable-themes

# Enable private packages
tutor picasso enable-private-packages

# Run Tutor commands
tutor picasso run-extra-commands

How to test

Set the env:

  1. Create a tvm project or an env with Tutor >= v18.0.0 (Redwood)
  2. Intall this plugin pip install git+https://github.com/eduNEXT/tutor-contrib-picasso.git@mfmz/add-picasso-commands
  3. Run tutor plugins enable picasso and tutor config save

Start your tests:

  • Run tutor picasso -h to have a list of the commands available.
  • An easy way to test the other commands is adding in the config.yml
PICASSO_EOX_MANAGE_DPKG:
  index: git
  name: eox-manage
  repo: eox-manage
  domain: github.com
  path: eduNEXT
  protocol: ssh
  private: true
  variables:
    development: {}
    production: {}
  version: v5.2.0
PICASSO_THEMES:
- domain: github.com
  name: ednx-saas-themes
  path: eduNEXT
  protocol: ssh
  repo: ednx-saas-themes
  version: edunext/redwood.master
PICASSO_THEMES_NAME:
- bragi
- css-runtime
PICASSO_THEMES_ROOT: /openedx/themes
PICASSO_THEME_DIRS:
- /openedx/themes/ednx-saas-themes/edx-platform
- /openedx/themes/ednx-saas-themes/edx-platform/bragi-generator
- /openedx/themes/ednx-saas-themes/edx-platform/bragi-children
PICASSO_EXTRA_COMMANDS:
- tutor plugins index add https://raw.githubusercontent.com/eduNEXT/tutor-plugin-indexes/main/
- tutor plugins install mfe mfe_extensions sentry aspects
- tutor plugins enable mfe mfe_extensions sentry aspects python-requirements
- tutor picasso enable-themes
- tutor picasso enable-private-packages
- tutor config save
  • Run tutor picasso repository-validator, expected result, no output.
  • Run tutor picasso syntax-validator, expected result, Success validation message.
  • Run tutor picasso run-extra-commands, expected result, installation of several tutor plugins and two picasso commands.
    • To verify themes, the expected result is to have a directory like this: env/build/openedx/themes/ednx-saas-themes in your env.
    • To verify private packages, you should have your private requirement cloned, like env/build/openedx/requirements/eox-manage, and in env/build/openedx/Dockerfile, you should have a line with the mount info of your plugin (Ctrl+F eox-manage).
    • To verify other extra commands, run tutor plugins list; you should be able to see all the plugins installed.
  • To review the readme https://github.com/eduNEXT/tutor-contrib-picasso/tree/mfmz/add-picasso-commands

Next steps

  • Using this to build images in Picasso
  • When this is merged, we need other branches to have v17 (quince), v16 (palm), v15 (olmo)

@MaferMazu MaferMazu force-pushed the mfmz/add-picasso-commands branch from 2117e28 to 91c0f8b Compare July 31, 2024 01:19
@MaferMazu MaferMazu force-pushed the mfmz/add-picasso-commands branch from 91c0f8b to 35a63da Compare July 31, 2024 01:28
@MaferMazu
Copy link
Collaborator Author

As we merged #2. This PR is no longer needed.

@MaferMazu MaferMazu closed this Aug 28, 2024
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.

1 participant