ni / ni/measurement-plugin-python

Simplify release process for example measurements

Open
#978 0 comments 0 reactions 0 assignees View on GitHub

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

https://github.com/ni/measurement-plugin-python/wiki/Release-Process has manual pre/post-release steps dealing with example versioning. I think we can simplify this by leaving the path = "../../..." dev-dependencies uncommented in the Git repo and updating the publish workflow to comment them out before building the examples .zip file. This is basically what we have been doing with packages/generator for the 2.1.0 release.

The current process was established before we started building a separate examples .zip file. At that time, users were expected to obtain the examples by cloning the Git repo or downloading the per-release .zip file containing the entire Git repo checked out at the release tag. Now that we are building a separate examples .zip file, we can modify the examples before zipping them up.

Note that you can use poetry install --only main to ignore dev-dependencies.

Cc: @dixonjoel @rajatkumar87

AB#2903024

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the release-process wiki page and the publish workflow, then compare its example packaging with the packages/generator process used for 2.1.0. Use poetry install --only main to verify the examples work with development dependencies left in the repository; done means the workflow comments those dependencies before creating the examples .zip file.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
release
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.