Skip to content

Conversation

@wchung-ni
Copy link
Collaborator

What does this Pull Request accomplish?

Update nisync API version from 0.1 to 0.2 and add release message in CHANGELOG.md

Why should this Pull Request be merged?

To update the version before publish to Pypi

What testing has been done?

  1. Run 'pytest -v'
  2. Run command 'poetry run ni-python-styleguide lint' and 'poetry run ni-python-styleguide fix'
  3. Check the appearance of CHANGELOG.md and validate the link.
    image

Signed-off-by: wchung <wai.kin.chung@ni.com>
@wchung-ni
Copy link
Collaborator Author

@sjasonsmith I updated the CHANGELOG.md and version. Is this look good before we publish to pypi ?

@wchung-ni wchung-ni marked this pull request as ready for review November 14, 2024 05:35
@tkrebes
Copy link
Collaborator

tkrebes commented Nov 14, 2024

@sjasonsmith I updated the CHANGELOG.md and version. Is this look good before we publish to pypi ?

Yes, the types of changes seem reasonable. Once the first major release occurs, the version numbers are incremented for the following reasons

  • major - API compatibility breaking changes
  • minor - New features
  • update - Bug fixes, performance improvement, etc.

However, when the version is in the form 0.x.y, any changes to x the minor version may be seen as compatibility breaking changes. So, some decide to change y for new features instead of x. Anyway, I think it is fine to increase the minor version (i.e x) in this case.

@wchung-ni wchung-ni merged commit 0e253a2 into ni:main Nov 15, 2024
14 checks passed
@wchung-ni wchung-ni deleted the update-log-version branch April 23, 2025 06:07
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.

2 participants