Getting package version from file when building packages by rodrigobr-msft · Pull Request #261 · microsoft/Agents-for-python

rodrigobr-msft · 2025-11-26T22:26:31Z

This pull request updates the versioning mechanism for all Python libraries in the libraries/ directory. Instead of relying solely on an environment variable for the package version, the build process now writes the version to a VERSION.txt file in each library, and the setup.py scripts are updated to read the version from this file if it exists. This ensures consistent and explicit versioning across all packages during the build process.

Build process changes:

The CI pipeline (.azdo/ci-pr.yaml) now writes the current package version to a VERSION.txt file in each library directory before building the packages.

Library setup changes (applied to all libraries):

Each setup.py script is updated to first attempt to read the package version from a VERSION.txt file; if the file does not exist, it falls back to the PackageVersion environment variable. This change is applied to the following libraries:
- microsoft-agents-activity
- microsoft-agents-authentication-msal
- microsoft-agents-copilotstudio-client
- microsoft-agents-hosting-aiohttp
- microsoft-agents-hosting-core
- microsoft-agents-hosting-fastapi
- microsoft-agents-hosting-teams
- microsoft-agents-storage-blob
- microsoft-agents-storage-cosmos

Copilot

Pull request overview

This PR introduces a version management system that reads package version from VERSION.txt files with a fallback to environment variables. The changes enable more flexible versioning during build processes by allowing version information to be persisted in files rather than relying solely on environment variables.

Key Changes:

Updated setup.py files across all library packages to read version from VERSION.txt file first, then fall back to the PackageVersion environment variable
Added setuptools-scm dependency to the microsoft-agents-activity package's build requirements
Modified CI/CD pipeline to write version information to VERSION.txt files before building packages

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
libraries/microsoft-agents-storage-cosmos/setup.py	Added version file reading logic with environment variable fallback
libraries/microsoft-agents-storage-blob/setup.py	Added version file reading logic with environment variable fallback
libraries/microsoft-agents-hosting-fastapi/setup.py	Added version file reading logic with environment variable fallback
libraries/microsoft-agents-hosting-core/setup.py	Added version file reading logic with environment variable fallback
libraries/microsoft-agents-hosting-aiohttp/setup.py	Added version file reading logic with environment variable fallback
libraries/microsoft-agents-copilotstudio-client/setup.py	Added version file reading logic with environment variable fallback
libraries/microsoft-agents-authentication-msal/setup.py	Added version file reading logic with environment variable fallback
libraries/microsoft-agents-activity/setup.py	Added version file reading logic with environment variable fallback
libraries/microsoft-agents-activity/pyproject.toml	Added setuptools-scm dependency to build system requirements
.azdo/ci-pr.yaml	Added script to write PackageVersion to VERSION.txt files before package building

Comments suppressed due to low confidence (8)

libraries/microsoft-agents-hosting-core/setup.py:5

This assignment to 'package_version' is unnecessary as it is redefined before this value is used.
This assignment to 'package_version' is unnecessary as it is redefined before this value is used.

package_version = "0.0.0"

libraries/microsoft-agents-activity/setup.py:5

This assignment to 'package_version' is unnecessary as it is redefined before this value is used.
This assignment to 'package_version' is unnecessary as it is redefined before this value is used.

package_version = "0.0.0"

libraries/microsoft-agents-storage-blob/setup.py:5

This assignment to 'package_version' is unnecessary as it is redefined before this value is used.
This assignment to 'package_version' is unnecessary as it is redefined before this value is used.

package_version = "0.0.0"

libraries/microsoft-agents-storage-cosmos/setup.py:5

This assignment to 'package_version' is unnecessary as it is redefined before this value is used.
This assignment to 'package_version' is unnecessary as it is redefined before this value is used.

package_version = "0.0.0"

libraries/microsoft-agents-copilotstudio-client/setup.py:5

This assignment to 'package_version' is unnecessary as it is redefined before this value is used.
This assignment to 'package_version' is unnecessary as it is redefined before this value is used.

package_version = "0.0.0"

libraries/microsoft-agents-hosting-fastapi/setup.py:5

This assignment to 'package_version' is unnecessary as it is redefined before this value is used.
This assignment to 'package_version' is unnecessary as it is redefined before this value is used.

package_version = "0.0.0"

libraries/microsoft-agents-authentication-msal/setup.py:5

This assignment to 'package_version' is unnecessary as it is redefined before this value is used.
This assignment to 'package_version' is unnecessary as it is redefined before this value is used.

package_version = "0.0.0"

libraries/microsoft-agents-hosting-aiohttp/setup.py:5

This assignment to 'package_version' is unnecessary as it is redefined before this value is used.
This assignment to 'package_version' is unnecessary as it is redefined before this value is used.

package_version = "0.0.0"

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

libraries/microsoft-agents-storage-blob/setup.py

libraries/microsoft-agents-hosting-fastapi/setup.py

libraries/microsoft-agents-hosting-aiohttp/setup.py

libraries/microsoft-agents-authentication-msal/setup.py

libraries/microsoft-agents-storage-cosmos/setup.py

libraries/microsoft-agents-hosting-core/setup.py

libraries/microsoft-agents-copilotstudio-client/setup.py

libraries/microsoft-agents-activity/setup.py

.azdo/ci-pr.yaml

Copilot

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 10 comments.

Comments suppressed due to low confidence (1)

libraries/microsoft-agents-activity/setup.py:5

This assignment to 'package_version' is unnecessary as it is redefined before this value is used.
This assignment to 'package_version' is unnecessary as it is redefined before this value is used.

package_version = "0.0.0"

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

libraries/microsoft-agents-activity/setup.py

libraries/microsoft-agents-storage-cosmos/setup.py

libraries/microsoft-agents-storage-blob/setup.py

libraries/microsoft-agents-hosting-fastapi/setup.py

libraries/microsoft-agents-hosting-core/setup.py

libraries/microsoft-agents-hosting-aiohttp/setup.py

libraries/microsoft-agents-authentication-msal/setup.py

libraries/microsoft-agents-activity/setup.py

libraries/microsoft-agents-hosting-teams/setup.py

libraries/microsoft-agents-copilotstudio-client/setup.py

* Writing version to file and reading it when building * Fixing issue * Removed unnecessary declaration * Specifying encoding

* Getting package version from file when building packages (#261) * Writing version to file and reading it when building * Fixing issue * Removed unnecessary declaration * Specifying encoding * Adding MANIFEST.in file to include package version files in builds (#263) * Writing version to file and reading it when building * Fixing issue * Removed unnecessary declaration * Specifying encoding * Adding MANIFEST.in files to include VERSION.txt * Fixing _sign_in_state serialization/deserialization (#264) * Fixing _sign_in_state (de)serialization * Reformatting --------- Co-authored-by: Chris Mullins <cleemullins@users.noreply.github.com> --------- Co-authored-by: Chris Mullins <cleemullins@users.noreply.github.com>

Writing version to file and reading it when building

66e01f1

Copilot AI review requested due to automatic review settings November 26, 2025 22:26

Copilot started reviewing on behalf of rodrigobr-msft November 26, 2025 22:27 View session

Copilot finished reviewing on behalf of rodrigobr-msft November 26, 2025 22:29

Fixing issue

def232b

Copilot AI reviewed Nov 26, 2025

View reviewed changes

Removed unnecessary declaration

6047929

rodrigobr-msft marked this pull request as ready for review November 26, 2025 22:33

rodrigobr-msft requested a review from a team as a code owner November 26, 2025 22:33

Copilot AI review requested due to automatic review settings November 26, 2025 22:33

Copilot started reviewing on behalf of rodrigobr-msft November 26, 2025 22:34 View session

rodrigobr-msft linked an issue Nov 26, 2025 that may be closed by this pull request

Source distribution build fails due to missing PackageVersion environment variable #248

Closed

rodrigobr-msft changed the title ~~Writing version to file and reading it when building~~ Getting package version from file when building packages Nov 26, 2025

Copilot finished reviewing on behalf of rodrigobr-msft November 26, 2025 22:36

Copilot AI reviewed Nov 26, 2025

View reviewed changes

Specifying encoding

12ac429

axelsrz approved these changes Nov 26, 2025

View reviewed changes

rodrigobr-msft merged commit de0083f into main Nov 26, 2025
10 checks passed

rodrigobr-msft deleted the users/robrandao/package-version branch November 26, 2025 23:14

rodrigobr-msft added a commit that referenced this pull request Dec 1, 2025

Getting package version from file when building packages (#261)

e59e3d1

* Writing version to file and reading it when building * Fixing issue * Removed unnecessary declaration * Specifying encoding

Copilot AI mentioned this pull request Dec 2, 2025

Add 0.6.1 release notes #272

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Getting package version from file when building packages#261

Getting package version from file when building packages#261
rodrigobr-msft merged 4 commits intomainfrom
users/robrandao/package-version

rodrigobr-msft commented Nov 26, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

Conversation

rodrigobr-msft commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

rodrigobr-msft commented Nov 26, 2025 •

edited

Loading