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

Migrate plugin type settings to plugin rez configs #1746

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

BryceGattis
Copy link
Contributor

Migrate plugin type settings to plugin rez configs so we can more easily add plugin settings to our documentation.

This change is based on JC's suggestion here.

…ily add plugin settings to our documentation

Signed-off-by: BryceGattis <brycegattis@yahoo.com>
@BryceGattis BryceGattis requested a review from a team as a code owner May 8, 2024 13:05
src/rezplugins/release_vcs/rezconfig.py Outdated Show resolved Hide resolved
src/rezplugins/release_vcs/rezconfig.py Outdated Show resolved Hide resolved
@@ -1212,46 +1212,7 @@
# common to all plugins of that type.

plugins = {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm curious to know what would happen if we removed this entirely from here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Running rez config plugins is how I've been verifying that my changes are working. Removing this line and attempting to run rez config plugins causes an error:

Traceback (most recent call last):
  File "e:\code\rez\venv\Lib\site-packages\rez\cli\config.py", line 53, in command
    data = data[key]
           ~~~~^^^^^
KeyError: 'plugins'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "<frozen runpy>", line 198, in _run_module_as_main
  File "<frozen runpy>", line 88, in _run_code
  File "E:\Code\rez\venv\Scripts\rez\rez.exe\__main__.py", line 7, in <module>
  File "e:\code\rez\venv\Lib\site-packages\rez\cli\_entry_points.py", line 69, in run_rez
    return run()
           ^^^^^
  File "e:\code\rez\venv\Lib\site-packages\rez\cli\_main.py", line 189, in run
    returncode = run_cmd()
                 ^^^^^^^^^
  File "e:\code\rez\venv\Lib\site-packages\rez\cli\_main.py", line 181, in run_cmd
    return func(opts, opts.parser, extra_arg_groups)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "e:\code\rez\venv\Lib\site-packages\rez\cli\config.py", line 55, in command
    raise ValueError("no such setting: %r" % opts.FIELD)
ValueError: no such setting: 'plugins'

@JeanChristopheMorinPerso
Copy link
Member

Tests should pass if you rebase your branch.

Co-authored-by: Jean-Christophe Morin <38703886+JeanChristopheMorinPerso@users.noreply.github.com>
Signed-off-by: BryceGattis <36783788+BryceGattis@users.noreply.github.com>
Copy link

linux-foundation-easycla bot commented May 20, 2024

CLA Missing ID CLA Not Signed

BryceGattis and others added 2 commits May 20, 2024 07:01
Co-authored-by: Jean-Christophe Morin <38703886+JeanChristopheMorinPerso@users.noreply.github.com>
Signed-off-by: BryceGattis <36783788+BryceGattis@users.noreply.github.com>
Signed-off-by: BryceGattis <brycegattis@yahoo.com>
Copy link

codecov bot commented May 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 58.39%. Comparing base (36e0537) to head (090578a).
Report is 12 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1746      +/-   ##
==========================================
+ Coverage   58.29%   58.39%   +0.10%     
==========================================
  Files         126      126              
  Lines       17159    17163       +4     
  Branches     3505     3506       +1     
==========================================
+ Hits        10002    10023      +21     
+ Misses       6493     6474      -19     
- Partials      664      666       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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.

None yet

2 participants