search

AcademySoftwareFoundation / rez

An integrated package configuration, build and deployment system for software
https://rez.readthedocs.io
Apache License 2.0
920 stars 329 forks source link

Add releasing packages documentation #1689

Closed BryceGattis closed 3 months ago

BryceGattis commented 4 months ago

Added a new page for releasing packages since there doesn't seem to be any for the rez-release workflow yet.

BryceGattis commented 4 months ago

I don't believe the release_vcs configuration setting is documented at all yet on the "configuring Rez" page. Can someone sanity check me here...?

BryceGattis commented 4 months ago

Once the release_vcs setting is documented, I think it'd be nice to split out package build and package release configuration settings into 2 different sections, rather than just the single section as it is now for clarity.

BryceGattis commented 4 months ago

@JeanChristopheMorinPerso Also, is it possible to actually get hyper links to source code? There's one reference that doesn't have a hyper link related to this PR that could be nice to get working. It's the rezplugins/release_hook at the bottom of the paragraph.

JeanChristopheMorinPerso commented 4 months ago

I don't believe the release_vcs configuration setting is documented at all yet on the "configuring Rez" page. Can someone sanity check me here...?

Plugins settings are not yet documented. Doing so would require some work since settings are right now documented in multiple places. For example, technically the canonical source should be in https://github.com/AcademySoftwareFoundation/rez/blob/main/src/rezplugins/release_vcs/rezconfig, but it only documents and sets one default value and the rest is in https://github.com/AcademySoftwareFoundation/rez/blob/main/src/rez/rezconfig.py#L1201-L1242.

At the very least, if you want to have plugins shown as a section in https://rez.readthedocs.io/en/stable/configuring_rez.html#configuration-settings, you would have to remove this empty line. I didn't do it because the result is ugly and not accurate.

If you are curious, the code that generates https://rez.readthedocs.io/en/stable/configuring_rez.html#configuration-settings is at https://github.com/AcademySoftwareFoundation/rez/blob/1d18bc267fb6e237b56e0297952be95d8e325542/docs/rez_sphinxext.py#L19-L173

codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 58.25%. Comparing base (c216f9d) to head (4ec22b7). Report is 5 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #1689 +/- ## ========================================== + Coverage 58.05% 58.25% +0.20% ========================================== Files 126 126 Lines 17035 17157 +122 Branches 3490 3504 +14 ========================================== + Hits 9889 9995 +106 - Misses 6482 6496 +14 - Partials 664 666 +2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.