-
Notifications
You must be signed in to change notification settings - Fork 56
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add release_utils.py that automaticlaly updates the version.txt (#101)
Summary: Pull Request resolved: #101 Use fairseq/release_utils.py (https://github.com/facebookresearch/fairseq/blob/main/release_utils.py) as a reference to update version.txt programatically. In the next diff, I'll add .github/workflow/release.yml to use this functionality Reviewed By: georges-berenger Differential Revision: D41759248 fbshipit-source-id: 7ad4df52eeacbbbee462cb24d5e935a27920031b
- Loading branch information
1 parent
e17e304
commit c7b0ff1
Showing
1 changed file
with
80 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
# Copyright (c) Meta Platforms, Inc. and affiliates. | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
import argparse | ||
from typing import Tuple | ||
|
||
|
||
def get_next_version(release_type) -> Tuple[Tuple[int, int, int], str, str]: | ||
current_version = open("version.txt", "r").read().strip() | ||
version_list = [int(x) for x in current_version.strip("'").split(".")] | ||
major, minor, patch = version_list[0], version_list[1], version_list[2] | ||
if release_type == "patch": | ||
patch += 1 | ||
elif release_type == "minor": | ||
minor += 1 | ||
patch = 0 | ||
elif release_type == "major": | ||
major += 1 | ||
minor = patch = 0 | ||
else: | ||
raise ValueError( | ||
"Incorrect release type specified. Acceptable types are major, minor and patch." | ||
) | ||
|
||
new_version_tuple = (major, minor, patch) | ||
new_version_str = ".".join([str(x) for x in new_version_tuple]) | ||
new_tag_str = "v" + new_version_str | ||
return new_version_tuple, new_version_str, new_tag_str | ||
|
||
|
||
def update_version(new_version_tuple) -> None: | ||
""" | ||
given the current version, update the version to the | ||
next version depending on the type of release. | ||
""" | ||
|
||
with open("version.txt", "w") as writer: | ||
writer.write(".".join([str(x) for x in new_version_tuple])) | ||
|
||
|
||
def main(args): | ||
if args.release_type in ["major", "minor", "patch"]: | ||
new_version_tuple, new_version, new_tag = get_next_version(args.release_type) | ||
else: | ||
raise ValueError("Incorrect release type specified") | ||
|
||
if args.update_version: | ||
update_version(new_version_tuple) | ||
|
||
print(new_version, new_tag) | ||
|
||
|
||
if __name__ == "__main__": | ||
parser = argparse.ArgumentParser(description="Versioning utils") | ||
parser.add_argument( | ||
"--release-type", | ||
type=str, | ||
required=True, | ||
help="type of release = major/minor/patch", | ||
) | ||
parser.add_argument( | ||
"--update-version", | ||
action="store_true", | ||
required=False, | ||
help="updates the version in version.txt", | ||
) | ||
|
||
args = parser.parse_args() | ||
main(args) |