From 64f5ade10b41b487aa971515c60d74ec55622e62 Mon Sep 17 00:00:00 2001 From: Bryce Gattis Date: Sun, 17 Mar 2024 11:36:22 -0500 Subject: [PATCH 1/7] Improve README for doc building Signed-off-by: Bryce Gattis --- docs/README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 5c94e70ae..453bf77ae 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,9 @@ # Build instructions -To build the docs you must use Python 3.11. +To build the docs you must install the following requirements: + +- GNU Make +- Python 3.11 To create a build environment run the following commands: ```python From 3b315c4e121f5028cc1ee535acf41fca5b7d5d4d Mon Sep 17 00:00:00 2001 From: Bryce Gattis Date: Sun, 17 Mar 2024 11:59:42 -0500 Subject: [PATCH 2/7] Add new releasing packages doc page since releasing packages wasn't really documented Signed-off-by: Bryce Gattis --- docs/source/index.rst | 1 + docs/source/releasing_packages.rst | 13 +++++++++++++ 2 files changed, 14 insertions(+) create mode 100644 docs/source/releasing_packages.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index 12196b605..e75e6cf2c 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -28,6 +28,7 @@ Welcome to rez's documentation! context_bundles suites managing_packages + releasing_packages caching pip diff --git a/docs/source/releasing_packages.rst b/docs/source/releasing_packages.rst new file mode 100644 index 000000000..a1f03bad1 --- /dev/null +++ b/docs/source/releasing_packages.rst @@ -0,0 +1,13 @@ +================== +Releasing packages +================== + +Rez packages can be built and deployed to the :data:`release_packages_path` +using the :ref:`rez-release` tool. This tool performs the following actions: + +* All :doc:`actions ` that the `rez-build` tool performs. +* Executes all configured :data:`release_hooks`. +* Executes all configured `release_vcs`. + +This tool generally runs the same as :ref:`rez-build` otherwise. For more +information, see the :doc:`Building Packages ` documentation. \ No newline at end of file From d456a6e8f34e7e7459adbdcd2ba6be86172b2b0c Mon Sep 17 00:00:00 2001 From: Bryce Gattis Date: Mon, 18 Mar 2024 07:53:40 -0500 Subject: [PATCH 3/7] Add new hyperlink in rezconfig.py Signed-off-by: Bryce Gattis --- src/rez/rezconfig.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/rez/rezconfig.py b/src/rez/rezconfig.py index ca1f14b15..50749f1c4 100644 --- a/src/rez/rezconfig.py +++ b/src/rez/rezconfig.py @@ -824,7 +824,7 @@ # a plugin listed here is not present, a warning message is printed. Note that a # release hook plugin being loaded does not mean it will run. It needs to be # listed here as well. Several built-in release hooks are available, see -# rezplugins/release_hook. +# :gh-rez:`src/rezplugins/release_hook`. release_hooks = [] # Prompt for release message using an editor. If set to False, there will be From 575881ca706fb522835c133f0af16918e25bc99e Mon Sep 17 00:00:00 2001 From: Bryce Gattis Date: Mon, 18 Mar 2024 08:01:37 -0500 Subject: [PATCH 4/7] Fixup GNU Make requirements info Signed-off-by: Bryce Gattis --- docs/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index 453bf77ae..aba4ad4da 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,7 +2,7 @@ To build the docs you must install the following requirements: -- GNU Make +- GNU Make (Linux + Mac only) - Python 3.11 To create a build environment run the following commands: @@ -12,7 +12,7 @@ source .venv/bin/activate pip install -r docs/requirements.txt cd docs -make html +make html # .\make html on Windows ``` # Example Headers From e5416f52520f8cdc5aa5917021b0b1d6f80604a3 Mon Sep 17 00:00:00 2001 From: Bryce Gattis Date: Mon, 18 Mar 2024 08:05:09 -0500 Subject: [PATCH 5/7] Move releasing_packages under General tab Signed-off-by: Bryce Gattis --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index e75e6cf2c..676021b0f 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -15,6 +15,7 @@ Welcome to rez's documentation! getting_started basic_concepts building_packages + releasing_packages context variants guides/index @@ -28,7 +29,6 @@ Welcome to rez's documentation! context_bundles suites managing_packages - releasing_packages caching pip From df852703031c6c9a8f89f1d4e52c59c1d73936f1 Mon Sep 17 00:00:00 2001 From: Bryce Gattis Date: Mon, 18 Mar 2024 23:10:19 -0500 Subject: [PATCH 6/7] Add section on when to release vs build Signed-off-by: Bryce Gattis --- docs/source/releasing_packages.rst | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/docs/source/releasing_packages.rst b/docs/source/releasing_packages.rst index a1f03bad1..602d902bb 100644 --- a/docs/source/releasing_packages.rst +++ b/docs/source/releasing_packages.rst @@ -5,9 +5,23 @@ Releasing packages Rez packages can be built and deployed to the :data:`release_packages_path` using the :ref:`rez-release` tool. This tool performs the following actions: -* All :doc:`actions ` that the `rez-build` tool performs. +* All :doc:`actions ` that the ``rez-build`` tool performs. * Executes all configured :data:`release_hooks`. * Executes all configured `release_vcs`. -This tool generally runs the same as :ref:`rez-build` otherwise. For more -information, see the :doc:`Building Packages ` documentation. \ No newline at end of file +When to release vs build +============================ +Packages *can* be installed to the :data:`release_packages_path` manually +by running ``rez-build ``, so why would you use +``rez-release``? + +Well, here are a few benefits of ``rez-release``: + +* The package will automatically go to the configured :data:`release_packages_path`, whereas :ref:`rez-build` will go to the :data:`local_packages_path` by default. +* Tests being run by with the :ref:`rez-test` tool can run specifically prior to release, ensuring that releases pass any configured tests first. +* Automatic sanity checks to ensure local repo is ready for release. +* Automatic VCS tagging. +* Many :ref:`helpful package attributes ` added to the released `package.py` at build time. + +If you're working locally, it these additional steps and checks may slow you +down, so it may be better to stick with :ref:`rez-build`. From 4ec22b76113c5baf0eac86d9271a53b2f466e5f9 Mon Sep 17 00:00:00 2001 From: Jean-Christophe Morin <38703886+JeanChristopheMorinPerso@users.noreply.github.com> Date: Fri, 29 Mar 2024 12:27:09 -0400 Subject: [PATCH 7/7] Apply suggestions from code review Signed-off-by: Jean-Christophe Morin <38703886+JeanChristopheMorinPerso@users.noreply.github.com> --- docs/source/releasing_packages.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/releasing_packages.rst b/docs/source/releasing_packages.rst index 602d902bb..a75ad5f1d 100644 --- a/docs/source/releasing_packages.rst +++ b/docs/source/releasing_packages.rst @@ -7,12 +7,12 @@ using the :ref:`rez-release` tool. This tool performs the following actions: * All :doc:`actions ` that the ``rez-build`` tool performs. * Executes all configured :data:`release_hooks`. -* Executes all configured `release_vcs`. +* Executes all configured :gh-rez:`src/rezplugins/release_vcs` plugins. When to release vs build ============================ Packages *can* be installed to the :data:`release_packages_path` manually -by running ``rez-build ``, so why would you use +by running :option:`rez-build -i --prefix /path/to/repo `, so why would you use ``rez-release``? Well, here are a few benefits of ``rez-release``: @@ -21,7 +21,7 @@ Well, here are a few benefits of ``rez-release``: * Tests being run by with the :ref:`rez-test` tool can run specifically prior to release, ensuring that releases pass any configured tests first. * Automatic sanity checks to ensure local repo is ready for release. * Automatic VCS tagging. -* Many :ref:`helpful package attributes ` added to the released `package.py` at build time. +* Many :ref:`helpful package attributes ` are automatically added to the released package definition file. If you're working locally, it these additional steps and checks may slow you down, so it may be better to stick with :ref:`rez-build`.