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

Create a top-level ni-measurement-plugin-sdk meta package #781

Merged
merged 34 commits into from
Jul 10, 2024

Conversation

dixonjoel
Copy link
Collaborator

@dixonjoel dixonjoel commented Jul 9, 2024

What does this Pull Request accomplish?

Creates a new ni-measurement-plugin-sdk top-level package that pulls in the service and generator packages as dependencies.

We're also reorganizing the repo to have a more consistent and clear package organization.

  • Make top-level packages directory with sdk, service, and generator sub-folder
  • Update workflow scripts with the new directories.

Why should this Pull Request be merged?

Makes installation simpler by providing a single package that brings in everything from the SDK and cleans up the organization of the packages so they're consistent.

What testing has been done?

Built locally.

Copy link

github-actions bot commented Jul 9, 2024

Test Results

   10 files   -    15     10 suites   - 15   31m 56s ⏱️ -3s
  653 tests ±    0    653 ✅ ±    0  0 💤 ±    0  0 ❌ ±0 
6 390 runs   - 6 625  6 390 ✅  - 5 565  0 💤  - 1 060  0 ❌ ±0 

Results for commit 9698408. ± Comparison against base commit f5dd491.

♻️ This comment has been updated with latest results.

@dixonjoel dixonjoel changed the title [RFC] First pass at a top-level package [DRAFT - Do Not Review] Create a top-level ni-measurement-plugin-sdk meta package Jul 9, 2024
@dixonjoel dixonjoel changed the title [DRAFT - Do Not Review] Create a top-level ni-measurement-plugin-sdk meta package Create a top-level ni-measurement-plugin-sdk meta package Jul 9, 2024
packages/sdk/README.md Outdated Show resolved Hide resolved
packages/service/_docs_source/conf.py Outdated Show resolved Hide resolved
packages/service/scripts/install_examples.py Outdated Show resolved Hide resolved
packages/service/README.md Outdated Show resolved Hide resolved
.github/workflows/check_nims.yml Outdated Show resolved Hide resolved
.github/workflows/run_system_tests.yml Outdated Show resolved Hide resolved
.github/workflows/check_nims.yml Show resolved Hide resolved
.github/workflows/check_nimg.yml Show resolved Hide resolved
.github/workflows/Publish_NIMS.yml Show resolved Hide resolved
@dixonjoel dixonjoel requested a review from bkeryan July 10, 2024 16:19
.github/workflows/run_system_tests.yml Outdated Show resolved Hide resolved
.readthedocs.yml Outdated Show resolved Hide resolved
packages/service/_docs_source/conf.py Outdated Show resolved Hide resolved
.github/workflows/check_nims.yml Show resolved Hide resolved
.github/workflows/run_unit_tests.yml Outdated Show resolved Hide resolved
docs/CNAME Outdated Show resolved Hide resolved
@dixonjoel dixonjoel requested a review from bkeryan July 10, 2024 20:06
@dixonjoel
Copy link
Collaborator Author

@bkeryan I looked over all the caching steps to ensure they had valid keys.

@dixonjoel dixonjoel merged commit 267ea0c into main Jul 10, 2024
17 checks passed
@dixonjoel dixonjoel deleted the users/jdixon/top-level-package branch July 10, 2024 21:27
dixonjoel added a commit that referenced this pull request Jul 11, 2024
* chore(deps): lock file maintenance

* Rename sequences to append _example (#776)

* chore(deps): update dependency tox to v4.16.0 (#777)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* chore(deps): lock file maintenance

* fix(deps): update dependency nidaqmx to v1 (#779)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* chore(deps): update dependency tomlkit to v0.13.0 (#783)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* Create a top-level ni-measurement-plugin-sdk meta package (#781)

* First pass at a top-level package

* Build and publish the SDK package

* Lint and fix some dependencies. Delete foo.py. Remove click and mako

* Reorganize the package hierarchy and pyproject.toml files

* Fix the docs configuration path

* Updated working directories

* Update working directory for nims

* Make a copy of color stubs

* Fix lint errors

* Working directory for docs

* Move scripts into service

* Working directory for docs build

* Move _docs_source into service

* Fix autoapi dir

* Fix docs directory

* Update proto path

* Update working directory for service

* Move README into sdk folder

* Update working directory for system tests

* Update SDK package version from tag during publish

* Fix copying of .env.simulation with working directory

* Add README to service so poetry install works

* Fix tox working directory

* Fix test_results path

* Fix typo

* Fix install_examples script

* Clean out docs/ directory after building

* Fix caching keys

* Use rm -rf docs

* Fix readthedocs configuration path

* Update CNAME for readthedocs

* Update caching keys and locations

* Update poetry version for readthedocs

* fix(deps): update dependency grpcio to v1.65.0 (#785)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
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