-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtag.py
164 lines (145 loc) · 6.95 KB
/
tag.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# ***************************************************************************************
# Project: dcommon -> https://github.com/dezashibi-c/dcommon
# File: tag.py
# Date: 2024-09-08
# Author: Navid Dezashibi
# Contact: navid@dezashibi.com
# Website: https://www.dezashibi.com | https://github.com/dezashibi
# License:
# `tag.py` -> Simple Utility For Making Releases and Tags for github
# BSD 3-Clause License
#
# Copyright (c) 2024, Navid Dezashibi <navid@dezashibi.com> All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# 3. Neither the name of the copyright holder nor the names of its contributors
# may be used to endorse or promote products derived from this software
# without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
# OF THE POSSIBILITY OF SUCH DAMAGE.
# ***************************************************************************************
# Description: The idea is to run this simple script after a few modification to create
# tag and also release in case certain criteria are met.
#
# The script looks for `CHANGE_LOGS.md` in the current working directory
# it assumes the mentioned file has the following format
# 👉 Checkout `CHANGE_LOG.md` of this very repository (link at the top)
#
# ## vx.y.z[-beta|rc|stable] <- the `## ` sequence is mandatory
#
# <any text>
#
# ======= <-- this is mandatory, it's 7 equal signs
#
# ## vx.y.z[-beta|rc|stable]
#
# <any text>
#
# =======
#
# ## vx.y.z[-beta|rc|stable]
#
# <any text>
#
#
# The scripts opens the file, get the version from the first line, reads
# until it gets the 7 equal signs or EOF.
# if the version has no "rc", "beta", "stable" no release will be generated
# only a proper tag will be added. but in case it's "stable" a release with
# marked as latest will be generated otherwise a release marked as pre-
# production will be generated. and in case a release is make any files
# mentioned in "release_files" list will be added to the release too.
# ***************************************************************************************
# name of the folder to zip this path is relative to the current working directory
# it means if you run it from the root folder it looks for the folder to be zipped
# in the root folder
# leave it empty string `''` for disabling zip
folder_to_zip = ['src/dcommon']
# you can list name of file or files you would like to be added individually to github
# releases
release_files = ["src/dcommon.zip", "src/scripts/tag.py"]
#########################################################################################
## DO NOT MAKE ANY CHANGES BELOW
#########################################################################################
import subprocess
import zipfile
import os
def zip_folder(folder_path, output_filename):
folder_name = os.path.basename(folder_path.rstrip('/\\'))
folder_path = os.path.abspath(folder_path)
with zipfile.ZipFile(output_filename, 'w', zipfile.ZIP_DEFLATED) as zipf:
for root, dirs, files in os.walk(folder_path):
for file in files:
full_path = os.path.join(root, file)
arcname = os.path.join(folder_name, os.path.relpath(full_path, folder_path))
zipf.write(full_path, arcname)
def extract_version_and_description():
with open('CHANGE_LOGS.md', 'r') as file:
description = []
version = None
for line in file:
line = line.strip()
if not version and line.startswith('## '):
version = line.split('## ')[1]
if line == "=======":
break
description.append(line)
return version, "\n".join(description)
def create_and_push_tag(version, description):
try:
subprocess.run(['git', 'tag', '-a', version, '-m', description], check=True)
subprocess.run(['git', 'push', 'origin', version], check=True)
return True
except subprocess.CalledProcessError as e:
print(f"Error during git tag/push: {e}")
return False
def create_github_release(version, description):
if any(key in version for key in ["stable", "rc", "beta"]):
try:
if folder_to_zip != '':
for folder in folder_to_zip:
zip_folder(folder, f"{folder}.zip")
release_command = ['gh', 'release', 'create', version, *release_files, '--title', version, '--notes', description]
if "stable" not in version:
release_command.append('--prerelease')
else:
release_command.append('--latest')
subprocess.run(release_command, check=True)
return True
except subprocess.CalledProcessError as e:
print(f"Error during GitHub release creation: {e}")
return False
else:
print(f"Version {version} does not match criteria for release. No release will be created.")
return True
def main():
version, description = extract_version_and_description()
if not version:
print("Error: No version found in CHANGE_LOGS.md or invalid format.")
return
print(f"Extracted version: {version}")
print(f"Tag description:\n{description}")
if create_and_push_tag(version, description) and create_github_release(version, description):
print(f"Successfully created release for version {version}.")
else:
print(f"Failed to create or update release for version {version}.")
if __name__ == "__main__":
main()