eduNEXT / tutor-contrib-edunext-distro

A tool to facilitate the customization of an Openedx instance, adding commands and settings to have an easy-to-use and a ready-to-deploy in local or in development openedx distribution.
2 stars 1 forks source link

feat: add enable private package command #7

Closed Alec4r closed 2 years ago

Alec4r commented 2 years ago

Description

This is to add a new command that clones and adds the distro private package to the tutor private requirements file.

How it work?

New structure for git distro packages

DISTSRO_PRIVATE_PACKAGE_DPKG:
  index: git
  name: eox-private-package # directory name
  # ---- git package variables
  repo: eox-private-package # git repository name
  domain: github.com
  path: eduNEXT
  protocol: ssh
  # ---- end git package variables
  version: master
  private: true
  variables:
    development: {}
    production: {}

New command

tutor distro enable-private-packages

This command will clone all private distro packages in the tutor requirements directory and they will be added to private.txt file.

Notes

MaferMazu commented 2 years ago

For no private plugins, do we need to continue to use repository instead repo, path, domain, and protocol? Maybe it's a good idea to unify this (and correct it in the readme file).

Well, when I ran tutor distro enable-private-packages I have my private.txt and I can see the repo in my requirements file but I had this output: Screenshot from 2022-04-19 08-56-13 I used this in my config.yml:

DISTSRO_PRIVATE_PACKAGE_DPKG:
  index: git
  name: eox-support # directory name
  # ---- git package variables
  repo: eox-support # git repository name
  domain: github.com
  path: eduNEXT
  protocol: ssh
  # ---- end git package variables
  version: master
  private: true
  variables:
    development: {}
    production: {}

On the other hand: I ran the test using my stack-builder env and the test broke my env; it installs tutor v13 D: and my tvm is broken.

Then I try to run the test in clean env and the test in theme enabler is broken again D: for the "/" in the path (python test). Screenshot from 2022-04-19 09-06-01

In the quality tests: Screenshot from 2022-04-19 09-09-22

Acceptance: Screenshot from 2022-04-19 09-10-12

(Maybe for the path "/")

Note: I don't know if it's something only in my QA computer xD

And for clean architecture, code, and structure for me looks good

Henrrypg commented 2 years ago

For no private plugins, do we need to continue to use repository instead repo, path, domain, and protocol? Maybe it's a good idea to unify this (and correct it in the readme file).

Well, when I ran tutor distro enable-private-packages I have my private.txt and I can see the repo in my requirements file but I had this output: Screenshot from 2022-04-19 08-56-13 I used this in my config.yml:

DISTSRO_PRIVATE_PACKAGE_DPKG:
  index: git
  name: eox-support # directory name
  # ---- git package variables
  repo: eox-support # git repository name
  domain: github.com
  path: eduNEXT
  protocol: ssh
  # ---- end git package variables
  version: master
  private: true
  variables:
    development: {}
    production: {}

On the other hand: I ran the test using my stack-builder env and the test broke my env; it installs tutor v13 D: and my tvm is broken.

Then I try to run the test in clean env and the test in theme enabler is broken again D: for the "/" in the path (python test). Screenshot from 2022-04-19 09-06-01

In the quality tests: Screenshot from 2022-04-19 09-09-22

Acceptance: Screenshot from 2022-04-19 09-10-12

(Maybe for the path "/")

Note: I don't know if it's something only in my QA computer xD

And for clean architecture, code, and structure for me looks good

I reviewed with @Alec4r these erros and was maybe our interpretation of the PR, there it said "New structure for git distro packages" and we @MaferMazu was testing it adding a new package with the new structure without changing the old ones.

Further, i think that its a good idea update the README file @Alec4r