Skip to content

Make command polaris reports for displaying of reports

The aim of this server to make polaris reports command to start server to show interactive web reports generated by polaris behave.

How it's done?

  • There is now one new folder inside polaris/ called reports which has everything in .gitignore except of server.py and init.py file.

  • In the gitlab CI Now there is another stage called reports_build which clones the polaris-reports repository and builds the latest version of reports and then when deploy stage is performed then the build folder is added in wheel file through MANIFEST.in file.

For developers

  • If the build folder is not there in your local repo then you can do pip install -e . to install polaris once again. and if it's still not there then you can manually clone polaris repository by following steps in .gitlab-ci.yml

  • I am adding the cloning instructions below also:

    • git pull --recurse-submodules

Note: the name of the command is debatable.

WorkFlow of Merge Request

Generation of build Folder and deployment Here is the link for pipeline containing generating build folder and dummy deploy stage here: https://gitlab.com/ayu023ban/polaris/-/pipelines/347901294

Flow of new user in the new polaris package Here is the link to the pastebin of how new user will interact with polaris after this MR will be merged. https://pastebin.com/zW35iVEY

Flow of starting polaris reports server for developers Here is the link to the pastebin of how we developers will now have to do to use polaris reports in main repository. https://pastebin.com/1PecT6UV

Contents

  • Make server to serve build folders
  • Add build folder to MANIFEST.in to incorporate build folder
  • Add build folder to pip package automatically through gitlab ci

Signed-off-by: Ayush Bansal ayu023ban@gmail.com

Edited by Ayush Bansal

Merge request reports