[CDRIVER-4809] Add a default VERSION_CURRENT file to source Created: 04/Jan/24 Updated: 25/Jan/24 Resolved: 25/Jan/24 |
|
| Status: | Closed |
| Project: | C Driver |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | 1.26.0, 1.25.5 |
| Type: | Improvement | Priority: | Unknown |
| Reporter: | Kevin Albertson | Assignee: | Kevin Albertson |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||||||
| Description |
ProposalAdd a VERSION_CURRENT file to the source, to serve as the default version when a version cannot be computed. Update the release process to update VERSION_CURRENT when tagging and on the subsequent commits. Background & MotivationThe version is required to build the C driver. The C driver build attempts to compute the version and stores in a file named VERSION_CURRENT. The version is computed with calc_release_version.py. calc_release_version_selftest.sh includes expected outputs. On a tagged commit, calc_release_version.py prints the tag:
On an untagged commit, calc_release_version.py includes the date and git hash:
Running calc_release_version.py requires Python be available and compatible.
Running calc_release_version.py requires the git history be available. The git history is not available if using a shallow clone:
or downloading the release tarball from GitHub:
This comment notes difficulties encountered building after the source archive was removed in favor of a regular Git archive in Updating the release processAdding VERSION_CURRENT to the source contradicts the motivation of Extra care may be needed to ensure the VERSION_CURRENT is updated on the master branch and a release branch when releasing. Here is a possible set of steps for updating VERSION_CURRENT on a minor release. This example uses 1.26.0 as the minor release:
Here is a possible set of steps for updating VERSION_CURRENT on a patch release. This example uses 1.26.1 as the minor release:
|
| Comments |
| Comment by Githook User [ 25/Jan/24 ] |
|
Author: {'name': 'Kevin Albertson', 'email': 'kevin.albertson@mongodb.com', 'username': 'kevinAlbs'}Message: |