ni / ni/measurement-plugin-python
Automation of stub generation in sample_measurement example
Open
Nobody has claimed this yet.
tech debt
- Dominant language
- Python
- Stars
- 21
- Forks
- 20
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 3
Description
Tech Debt
- Automate the stubs in sample_measurement in the example directory to prevent them from becoming outdated.
- update the build to check whether the protobuf codegen is out of date.
Refer,
- https://github.com/ni/measurement-plugin-python/blob/main/packages/service/scripts/generate_grpc_stubs.py
- https://github.com/ni/measurement-plugin-python/blob/main/.github/workflows/check_nims.yml#L82
Context
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with packages/service/scripts/generate_grpc_stubs.py and the sample_measurement files, then compare .github/workflows/check_examples.yml with the referenced check_nims.yml section. Confirm how stub generation is currently performed and make the example check detect outdated generated protobuf code; done means the workflow reliably reports stale stubs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, python
- Domain
- build-system, ci-cd
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100