Skip to content

disable "show+verbose" code blocks in "ocpidev/assets/project.py"

Robert Tracy requested to merge 3509-ocpidev-verbose-fixes into develop

What this MR does / why we need it:

This MR disables some code blocks that are only executed for the "show" verb if "verbose" is specified. This is not necessarily the correct fix, but it is an expedient one. The disabled code blocks have been left in place because they are helpful in discovering legacy <name>-spec.xml files that have no matching components by the same name. Legacy spec files will not be supported in v3.0.0.

Two legacy spec files are being modernized in this MR: drc-spec.xml and emulator-spec.xml. The modernization consists of creating drc and emulator components, then relocating and renaming the spec files to drc.comp/drc-comp.xml and emulator.comp/emulator-comp.xml respectively. Workers that depend on these OCS files now require the spec=<name> syntax for that attribute, e.g., spec="drc-spec" becomes spec="drc". Note this new syntax works fine with legacy spec files.

An "unfortunate" side effect of creating the new drc and emulator components is the associated creation of skeleton documents and example applications for the components. Adding documentation for the components is beyond the scope of this MR, but should be done at some point. Accordingly, the skeleton files are being left in place by this MR.

Steps to complete before submitting MR:

  • I have read Contribution guidelines

  • I have ensured I have a changelog written in the imperative form that is meaningful and accurately summarizes the work done

  • I have added the release notes label if applicable (more information below)

  • I have ensured the workflow labels are up to date and will continue to do so up until this work is merged into develop

  • I have added a category, type, and target release label along with all other labels as need be

  • My branch is up to date with develop. If it is not, then I have ensured my work does not conflict with other work

  • I agree my bugfix MR does not include new features/enhancements

  • I represent that bugfixes have been locally tested against the most recent major.minor release in which the bug exists

  • (REVIEWER ONLY) I have thoroughly gone through the above steps to ensure that they have been followed

Release Notes

N/A

Changelog

  • bug(tools): disable show+verbose code blocks in ocpidev/assets/project.py
  • task(comp): fix spec= attributes in XML files
  • task(tools): delete obsolete and undocumented makeProject.sh script
  • task(comp): modernize legacy drc-spec.xml and emulator-spec.xml OCS files
  • task(tools): minor ocpidev refactoring to resolve **kwargs vs. kwargs vs. args usage

Which issue(s) this MR closes

Closes #3509 (closed), #3544 (closed), #3545 (closed), #3546 (closed)

Edited by Robert Tracy

Merge request reports