Merge remote-tracking branch 'upstream/master' into users/vagupta/custom_expansion_for_repeated_capability

Author: Vaishnavigupta1312

.github/workflows/check_latest_release.yml

@@ -25,24 +25,23 @@ jobs:
       - x64
       - rdss-nimibot-win-10-py32
     timeout-minutes: 30
-    strategy:
-      matrix:
-        module_name:
-          - nidigital
-          - nitclk
-          - nifgen
-          - nidcpower
-          - nidmm
-          - niscope
-          - nimodinst
-          - nise
-          - niswitch
     steps:
       - name: checkout repository
         uses: actions/checkout@v3
+
+      - name: Extract module name and version from release tag
+        id: extract_tag
+        run: |
+          # Extract module name and version from the release tag
+          # Assuming the tag format is <module_name>-<version>, e.g., nidigital-1.4.0
+          TAG="${{ github.event_name == 'workflow_dispatch' && inputs.release_tag || github.event.release.tag_name }}"
+          MODULE_NAME=$(echo "$TAG" | cut -d'-' -f1)
+          MODULE_VERSION=$(echo "$TAG" | cut -d'-' -f2-)
+          echo "module_name=$MODULE_NAME" >> "$GITHUB_OUTPUT"
+          echo "module_version=$MODULE_VERSION" >> "$GITHUB_OUTPUT"
       # NOTE: we don't upload test coverage for this
       - name: run examples using PyPI uploads
         uses: ./.github/actions/run_examples_using_pypi_uploads
         with:
-          module_name: ${{ matrix.module_name }}
-          module_version: ${{ github.event_name == 'workflow_dispatch' && inputs.release_tag || github.event.release.tag_name }}
+          module_name: ${{ steps.extract_tag.outputs.module_name }}
+          module_version: ${{ steps.extract_tag.outputs.module_version }}

CHANGELOG.md

@@ -7,6 +7,7 @@
 - [nifgen (NI-FGEN)](#nifgen-ni-fgen)
 - [nimodinst (NI-ModInst)](#nimodinst-ni-modinst)
 - [nirfsg (NI-RFSG)](#nirfsg-ni-rfsg)
+- [nirfsg (NI-RFSG)](#nirfsg-ni-rfsg)
 - [niscope (NI-SCOPE)](#niscope-ni-scope)
 - [nise (NI Switch Executive)](#nise-ni-switch-executive)
 - [niswitch (NI-SWITCH)](#niswitch-ni-switch)
@@ -1667,7 +1668,7 @@
 
 #### [nirfsg] Unreleased
 - Added
-  - Added metadata for selected public APIs
+  - Enabled selected public APIs
   - Basic example
   - Documentation for APIs (not final) 
 - Changed

CONTRIBUTING.md

@@ -149,6 +149,17 @@ Release Process
         ```
     1. Ensure no commits are made on ni/nimi-python/master until the release is complete
     1. Create and checkout a branch for release-related changes
+    1. Perform Version Bump (If Needed)
+        * If you need to upgrade the major or minor versions, include any of the following parameters:
+           * --increment-major-version - To increment the major version of package. This will update the version to (N+1).X.X.dev0
+           * --increment-minor-version - To increment the minor version of package. This will update the version to X.(N+1).X.dev0
+             * Example: `python3 tools/build_release.py --increment-minor-version`
+        * If you need to update the version for any specific driver(s), include the `drivers` parameter. By default, all drivers will be considered.
+          For example: 
+              ```bash
+              python3 tools/build_release.py --drivers nidcpower --increment-minor-version
+              ```
+        * Commit to branch
     1. Update [CHANGELOG.md](./CHANGELOG.md)
         * For packages that are releasing:
           * Delete empty (i.e. No changes) sub-sections under "Unreleased" section 
@@ -157,8 +168,13 @@ Release Process
           * Change [Unreleased] in TOC to the version of the release
         * Commit to branch
     1. Update release versions
-        * `python3 tools/build_release.py --update --release`
+        * `python3 tools/build_release.py --update-for-release`
             * For each module, this will drop the .devN from our versions in config_addon.py and update the LATEST_RELEASE versions to match.
+            * If you need to release any specific module(s), include the `drivers` parameter. 
+          For example: 
+              ```bash
+              python3 tools/build_release.py --drivers nidcpower --update-for-release
+              ```
         * Commit to branch
     1. Clean and build to update generated files with new version
         * `python3 tools/build_release.py --build`
@@ -170,19 +186,33 @@ Release Process
     1. Wait until the pull request has been approved
     1. Upload the releases to PyPI
         * `python3 tools/build_release.py --upload`
+        * If you need to upload any specific module(s), include the `drivers` parameter. 
+        For example: 
+             ```bash
+            python3 tools/build_release.py --drivers nidcpower --upload
+            ```
         * You will need to type in your PyPI credentials
     1. Merge the pull request to origin/master
-    1. Create a release on GitHub using the portion from the changelog for this release for the description
-        * Add the ZIP files under `generated/examples` for each module as a release artifact.
+    1. For each package released, create a release on GitHub using the module's portion from the changelog for this release for the description
+        * The release tag should be named as follows: `MODULE_NAME-version`.
+          * Example: `nidcpower-1.5.0`.
+          * This tag format allows the individual `Read the Docs` projects to determine whether a release applies to them.
+        * Add the ZIP files under `generated/examples` for each module (not just the releasing one) as a release artifact.
+          * Internal test code will only look for the latest release tag and expect it to have examples attached for any module
         * This should trigger the [check_latest_release](.github/workflows/check_latest_release.yml) workflow. Check the [results](https://github.com/ni/nimi-python/actions/workflows/check_latest_release.yml) before continuing.
 1. Post-Release Steps
     1. Create and checkout another branch for post-release changes
-    1. Update the module versions
-        * `python3 tools/build_release.py --update`
-            * This will update the version to X.X.(N+1).dev0
+    1. Update the module version for a patch version upgrade. This will update the version to X.X.(N+1).dev0
+        * `python3 tools/build_release.py --increment-patch-version`
+        * If you need to update any specific module(s), include the `drivers` parameter. 
+        For example: 
+             ```bash
+            python3 tools/build_release.py --drivers nidcpower --increment-patch-version
+            ```
         * Commit to branch
     1. Clean and build to update generated files with new version
         * `python3 tools/build_release.py --build`
+        * Ensure that all changes made as part of build command are specific to intended drivers.
         * Commit to branch
     1. Update changelog
         * Copy Unreleased section from the bottom of the changelog. Modify the package name in the example and TOC. Paste the modified section at the top of intended package's changelog and add a corresponding link to it in the package's TOC.

LICENSE

@@ -1,7 +1,7 @@
 This is the MIT license: http://www.opensource.org/licenses/mit-license.php
 
 Copyright (c) 2017-2022, National Instruments Corporation.
-NI-Digital Pattern Driver, NI-DMM, NI-DCPower, NI-FGEN, NI-SCOPE, NI-SWITCH, NI Switch Executive,
+NI-Digital Pattern Driver, NI-DMM, NI-DCPower, NI-FGEN, NI-RFSG, NI-SCOPE, NI-SWITCH, NI Switch Executive,
 NI-ModInst, NI-TClk are trademarks of National Instruments.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this

README.rst

@@ -298,7 +298,7 @@ NI-RFSG Python API Status
 +-------------------------------+-----------------------+
 | NI-RFSG (nirfsg)              |                       |
 +===============================+=======================+
-| Driver Version Tested Against | 2025 Q1               |
+| Driver Version Tested Against | 2025 Q2               |
 +-------------------------------+-----------------------+
 | PyPI Version                  | |nirfsgLatestVersion| |
 +-------------------------------+-----------------------+

build/templates/examples.rst.mako

@@ -27,13 +27,23 @@
 
     with open(f'./src/{module_name}/LATEST_RELEASE') as vf:
         latest_release_version = vf.read().strip()
-    released_zip_url = 'https://github.com/ni/nimi-python/releases/download/{}/{}_examples.zip'.format(latest_release_version, module_name)
-
-    example_url_base = 'https://github.com/ni/nimi-python/blob/'
 
     from packaging.version import Version
     v = Version(module_version)
 
+    # Check if the module name and version match the old tag formatting criteria
+    use_old_tag_format = (
+        module_name in ['nidcpower', 'nidigital', 'nidmm', 'nifake', 'niswitch', 'nimodinst', 'nifgen', 'niscope', 'nise', 'nitclk']
+        and latest_release_version == '1.4.9'
+    )
+
+    if not use_old_tag_format:
+        latest_release_version = module_name + '-' + latest_release_version
+    
+    released_zip_url = 'https://github.com/ni/nimi-python/releases/download/{}/{}_examples.zip'.format(latest_release_version, module_name)
+
+    example_url_base = 'https://github.com/ni/nimi-python/blob/'
+
     if v.dev is None and v.pre is None:
         examples_zip_url_text = '`You can download all {} examples here <{}>`_'.format(module_name, released_zip_url)
         example_url_base += latest_release_version
@@ -54,4 +64,4 @@ ${helper.get_rst_header_snippet(os.path.basename(e), '-')}
    :encoding: utf8
    :caption: `(${os.path.basename(e)}) <${example_url_base}/${e.replace('\\', '/')}>`_
 
-% endfor
+% endfor

build/templates/index.rst.mako

@@ -3,6 +3,10 @@
     doc_header    = f"{config['driver_name']} Python API Documentation"
     module_name   = config['module_name']
     driver_name   = config['driver_name']
+    mi_drivers = ['nidcpower', 'nidigital', 'nidmm', 'nifgen', 'nimodinst', 'niscope', 'niswitch', 'nise', 'nitclk']
+    read_the_docs_note = (
+        "Refer to the `nimi-python Read the Docs project <https://nimi-python.readthedocs.io/en/stable/>`_ for documentation of versions 1.4.4 of the module or earlier."
+    )
 %>\
 
 ${doc_header}
@@ -25,7 +29,9 @@ Additional Documentation
 
 Refer to your driver documentation for device-specific information and detailed API documentation.
 
-For drivers other than nirfsg, refer to the `nimi-python Read the Docs project <https://nimi-python.readthedocs.io/en/stable/>`_ for documentation of versions 1.4.4 of the module or earlier.
+% if module_name in mi_drivers:
+${read_the_docs_note}
+% endif
 
 .. include:: ../_static/license.inc
 

docs/nirfsg/about_nirfsg.inc

@@ -11,3 +11,5 @@ Support Policy
 
 It follows `Python Software Foundation <https://devguide.python.org/#status-of-python-branches>`_ support policy for different versions of CPython.
 
+NI created and supports **nirfsg**.
+

docs/nirfsg/examples.rst

@@ -1,7 +1,7 @@
 Examples
 ========
 
-`You can download all nirfsg examples here <https://github.com/ni/nimi-python/releases/download/0.2.0/nirfsg_examples.zip>`_
+`You can download all nirfsg examples here <https://github.com/ni/nimi-python/releases/download/nirfsg-0.2.0/nirfsg_examples.zip>`_
 
 nirfsg_cw.py
 ------------
@@ -10,5 +10,5 @@ nirfsg_cw.py
    :language: python
    :linenos:
    :encoding: utf8
-   :caption: `(nirfsg_cw.py) <https://github.com/ni/nimi-python/blob/0.2.0/src/nirfsg/examples/nirfsg_cw.py>`_
+   :caption: `(nirfsg_cw.py) <https://github.com/ni/nimi-python/blob/nirfsg-0.2.0/src/nirfsg/examples/nirfsg_cw.py>`_
 

docs/nirfsg/index.rst

@@ -19,7 +19,6 @@ Additional Documentation
 
 Refer to your driver documentation for device-specific information and detailed API documentation.
 
-For drivers other than nirfsg, refer to the `nimi-python Read the Docs project <https://nimi-python.readthedocs.io/en/stable/>`_ for documentation of versions 1.4.4 of the module or earlier.
 
 .. include:: ../_static/license.inc