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

feat! Create a script to build adaptor package artifacts #85

Merged
merged 1 commit into from
Feb 14, 2024

Conversation

mwiebe
Copy link
Contributor

@mwiebe mwiebe commented Feb 9, 2024

  • The breaking change is due to updating the adaptor runtime dependency to 0.4

What was the problem/requirement? (What/Why)

We have designed a new structure for how we lay out application interface adaptors into packages. In order to simplify the packaging step, we'll put a script that generates an artifact with that layout into each adaptor git repo.

In order to perform the layout we wanted, I needed to modify the adaptor runtime. Those changes are in OpenJobDescription/openjd-adaptor-runtime-for-python#69

The adaptor runtime dependency was out of date, After updating, it required changes from a socket_path to a server_path parameter.

What was the solution? (How)

  • Create a script to build adaptor packaging artifacts that follow the structure we designed
  • Also deprecate the binary name NukeAdaptor, and add the name nuke-openjd
  • Update the adaptor runtime dependency to 0.4, and fix up socket path into server path
  • Update the submitter to provide both Rez and Conda packages metadata. The Rez package names are the same for now to keep backwards compatibility.

What is the impact of this change?

The repo has a script that can generate a .tar archive containing a prefix layout of the adaptor python library and its dependencies, along with an entry point.

How was this change tested?

The generated .tar archive was used to create a package, and that was tested on a Deadline Cloud farm.

Did you run the "Job Bundle Output Tests"? If not, why not? If so, paste the test results here.

Yes.


Timestamp: 2024-02-09T13:02:36.991298-08:00
Running job bundle output test: D:\deadline-clients\deadline-cloud-for-nuke\job_bundle_output_tests\cwd-path

cwd-path
Test succeeded

Timestamp: 2024-02-09T13:02:38.047223-08:00
Running job bundle output test: D:\deadline-clients\deadline-cloud-for-nuke\job_bundle_output_tests\group-read

group-read
Test succeeded

Timestamp: 2024-02-09T13:02:38.939765-08:00
Running job bundle output test: D:\deadline-clients\deadline-cloud-for-nuke\job_bundle_output_tests\multi-load-save

multi-load-save
Test succeeded

Timestamp: 2024-02-09T13:02:40.019139-08:00
Running job bundle output test: D:\deadline-clients\deadline-cloud-for-nuke\job_bundle_output_tests\noise-saver

noise-saver
Test succeeded

Timestamp: 2024-02-09T13:02:41.064548-08:00
Running job bundle output test: D:\deadline-clients\deadline-cloud-for-nuke\job_bundle_output_tests\ocio

ocio
Test succeeded

All tests passed, ran 5 total.
Timestamp: 2024-02-09T13:02:44.283227-08:00

Was this change documented?

No

Is this a breaking change?

Yes, it updates the openjd adaptor runtime dependency which had a breaking change.

@mwiebe mwiebe requested a review from a team as a code owner February 9, 2024 21:09
@mwiebe mwiebe force-pushed the markw/packaging-artifact branch from 34282a2 to d5733aa Compare February 9, 2024 21:10
Copy link
Contributor

@jericht jericht left a comment

Choose a reason for hiding this comment

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

LGTM! Just a couple typos or copy/paste misses

@mwiebe mwiebe force-pushed the markw/packaging-artifact branch 2 times, most recently from f51f824 to ca95f2d Compare February 14, 2024 01:48
The breaking change is due to updating the adaptor runtime dependency to
0.4

- Also deprecate the binary name NukeAdaptor, and add the name
  nuke-openjd
- Update the adaptor runtime dependency to 0.4, and fix up socket
  path into server path
- Update the submitter to provide both Rez and Conda packages metadata.
  The Rez package names are the same for now to keep backwards
  compatibility.
- Fix up the adaptor to not require the deadline-cloud library
- Remove the TelemetryOptOut job parameter. This clutters the UI by
  putting it as a job parameter, and we should add a config file that a
  Queue Environment can control for this instead.
- Fix some corner cases in the job bundle output test normalization, so
  that it passes on Windows.
- Reduced the test coverage requirement from 73 to 72. It rounded off
  to being equal to 73 but still failed.

Signed-off-by: Mark Wiebe <[email protected]>
@mwiebe mwiebe force-pushed the markw/packaging-artifact branch from ca95f2d to 3ca4a41 Compare February 14, 2024 01:51
@epmog epmog merged commit 0039d36 into mainline Feb 14, 2024
9 checks passed
@epmog epmog deleted the markw/packaging-artifact branch February 14, 2024 02:58
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.

3 participants