├── .github ├── ISSUE_TEMPLATE │ ├── bug_report.md │ └── feature_request.md ├── dependabot.yml └── workflows │ ├── pypi-publish.yml │ └── test.yml ├── .gitignore ├── .gitlint ├── .pre-commit-config.yaml ├── CONTRIBUTING.md ├── LICENSE ├── Pipfile ├── README.md ├── gitea_auto_update ├── __init__.py ├── lib │ ├── __init__.py │ ├── build.py │ ├── download.py │ ├── test_version.py │ └── version.py └── update.py ├── settings.ini └── setup.py /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Steps to reproduce the behavior: 15 | 1. Go to '...' 16 | 2. Click on '....' 17 | 3. Scroll down to '....' 18 | 4. See error 19 | 20 | **Expected behavior** 21 | A clear and concise description of what you expected to happen. 22 | 23 | **Additional context** 24 | Add any other context about the problem here. 25 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: pip 4 | directory: "/" 5 | schedule: 6 | interval: daily 7 | time: "04:00" 8 | open-pull-requests-limit: 10 9 | -------------------------------------------------------------------------------- /.github/workflows/pypi-publish.yml: -------------------------------------------------------------------------------- 1 | on: 2 | release: 3 | types: 4 | - created 5 | name: Publish Package 6 | jobs: 7 | deploy: 8 | runs-on: ubuntu-latest 9 | 10 | steps: 11 | - uses: actions/checkout@v2 12 | - uses: actions/setup-python@v2 13 | with: 14 | python-version: 3.8 15 | - name: "Installs and upgrades pip, installs other dependencies and installs the package from setup.py" 16 | run: | 17 | # Upgrade pip 18 | python3 -m pip install --upgrade pip 19 | # Install build deps 20 | python3 -m pip install pipenv setuptools wheel twine 21 | pipenv install 22 | # Install the package from setup.py 23 | python3 setup.py install 24 | - name: Build 25 | run: | 26 | python3 setup.py sdist bdist_wheel 27 | - name: Publish a Python distribution to PyPI 28 | uses: pypa/gh-action-pypi-publish@release/v1 29 | with: 30 | user: __token__ 31 | password: ${{ secrets.PYPI_API_TOKEN }} 32 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: Test Package 2 | 3 | on: [push] 4 | 5 | jobs: 6 | build: 7 | 8 | runs-on: ubuntu-latest 9 | strategy: 10 | matrix: 11 | python-version: [ "3.8", "3.9", "3.10"] 12 | 13 | steps: 14 | - uses: actions/checkout@v3 15 | - name: Set up Python ${{ matrix.python-version }} 16 | uses: actions/setup-python@v4 17 | with: 18 | python-version: ${{ matrix.python-version }} 19 | - name: "Tests the code" 20 | run: | 21 | pip install pipenv 22 | pipenv install 23 | pipenv run gitlint 24 | pipenv run pylint setup.py gitea_auto_update 25 | pipenv run python -m unittest -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | __pycache__ 2 | .pyc 3 | .idea 4 | Pipfile.lock 5 | dist 6 | build 7 | *.egg-info 8 | update.log -------------------------------------------------------------------------------- /.gitlint: -------------------------------------------------------------------------------- 1 | [general] 2 | contrib=contrib-title-conventional-commits 3 | 4 | [contrib-title-conventional-commits] 5 | types = build,ci,docs,feat,fix,perf,refactor,style,test -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | repos: 2 | - repo: https://github.com/pre-commit/pre-commit-hooks 3 | rev: v2.5.0 4 | hooks: 5 | - id: trailing-whitespace 6 | - id: end-of-file-fixer 7 | - id: check-yaml 8 | - id: check-added-large-files 9 | - repo: https://github.com/PyCQA/pylint 10 | rev: pylint-2.5.0 11 | hooks: 12 | - id: pylint 13 | additional_dependencies: ['packaging', 'requests'] 14 | - repo: https://github.com/jorisroovers/gitlint 15 | rev: v0.13.1 16 | hooks: 17 | - id: gitlint 18 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | Thank you for your interest to contribute to this repository. 4 | 5 | All good contributions which add a new feature or close a issue will be accepted, however there a few guidelines which should be followed: 6 | 7 | 1. Commit messages should follow the Angular Commit Message Format: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit 8 | 2. New features should be added with a new function, if a new function is possible. 9 | 3. Test-driven development (TDD) should be followed - this means you should always create unit tests for your function before you create the corresponding function. 10 | 4. You should use the linter -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /Pipfile: -------------------------------------------------------------------------------- 1 | [[source]] 2 | name = "pypi" 3 | url = "https://pypi.org/simple" 4 | verify_ssl = true 5 | 6 | [dev-packages] 7 | 8 | [packages] 9 | requests = "*" 10 | packaging = "*" 11 | fire = "*" 12 | configparser = "*" 13 | gitlint = "*" 14 | pylint = "*" 15 | pre-commit = "*" 16 | 17 | [requires] 18 | python_version = "3" 19 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Gitea Auto Update 2 | 3 | [![Build Status](https://github.com/CMiksche/gitea-auto-update/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/CMiksche/gitea-auto-update/actions/workflows/test.yml) 4 | [![Publish Package](https://github.com/CMiksche/gitea-auto-update/actions/workflows/pypi-publish.yml/badge.svg)](https://github.com/CMiksche/gitea-auto-update/actions/workflows/pypi-publish.yml) 5 | [![PyPI version](https://badge.fury.io/py/gitea-auto-update.svg)](https://badge.fury.io/py/gitea-auto-update) 6 | [![Downloads](https://pepy.tech/badge/gitea-auto-update)](https://pepy.tech/project/gitea-auto-update) 7 | ![GitHub](https://img.shields.io/github/license/cmiksche/gitea-auto-update?style=flat) 8 | [![Twitter Follow](https://img.shields.io/twitter/follow/cmiksche?style=social)](https://twitter.com/cmiksche) 9 | [![Mastodon Follow](https://img.shields.io/mastodon/follow/106336578279256330?domain=https%3A%2F%2Fmastodon.social&style=social)](https://mastodon.social/@cmiksche) 10 | 11 | Script for an automatic update of gitea. Should be run locally on the gitea server. Has options for updating via new binary file or build from source. 12 | 13 | This project is on life-support. I focus on bringing new features to my paid [Autoupdate](https://chapati.systems/autoupdate/) tool. 14 | 15 | ## Want to update more? 16 | 17 | > If you want to update Gitea and other software (like Drone, Caddy, Podman, Python, Zitadel and Kanboard), you should check out [Autoupdate](https://chapati.systems/autoupdate/). 18 | > 19 | > This new tool of mine was built as a single binary with a config file and tested on multiple Linux systems. 20 | 21 | ## Procedure 22 | * Get Gitea Version from the Gitea CLI and if that fails from the Gitea API 23 | * Get latest Release via GitHub API 24 | * Check if there is a newer Version 25 | * If there is a newer Version: 26 | * If binary file was selected: 27 | * Download new version 28 | * Check sha256 29 | * Overwrite old version 30 | * If build from source is active: 31 | * Checkout new release branch 32 | * Build binary 33 | * Overwrite old binary 34 | 35 | 36 | ## General Information 37 | License: GNU General Public License 38 | 39 | Author: Christoph Daniel Miksche (m5e.de) 40 | 41 | Uses python version 3 42 | 43 | 44 | ## Dependencies 45 | Ensure `pip3`, `setuptools`, `xz-utils` and `wheel` dependencies are installed on the system you are running this script in. (Most Linux OS like Ubuntu or Debian come with these pre-installed) 46 | 47 | ## Installation 48 | 49 | Create a settings.ini file on your system. Example: 50 | 51 | ```` 52 | [Gitea] 53 | site=https://your-gitea-instance.com/api/v1/version 54 | apiUrl=https://api.github.com/repos/go-gitea/gitea/releases/latest 55 | system=linux-amd64 56 | file=/usr/local/bin/gitea 57 | tmpDir=/tmp/ 58 | buildFromSource= 59 | sourceDir= 60 | logFile=update.log 61 | ```` 62 | 63 | Use the following command to install gitea-auto-update. 64 | 65 | ``` 66 | sudo pip3 install gitea-auto-update 67 | ``` 68 | 69 | Enter the command `gitea-auto-update --settings=/path/to/settings.ini` in your commandline. 70 | 71 | If you want to schedule your updates, edit your /etc/crontab file. 72 | 73 | ## Tutorials 74 | 75 | * English: http://blog.m5e.de/gitea/update/upgrade/bash/script/2018/11/26/gitea-auto-update-script.html 76 | * German: https://blog.wronnay.net/automatische-gitea-updates/ 77 | 78 | ## Development 79 | 80 | The following instructions help you for developing. 81 | 82 | * Check out the [Contribution Guidelines](CONTRIBUTING.md). 83 | * Clone this git repo 84 | * Install pipenv: `pip install pipenv` 85 | * Install all dependencies: `pipenv install` 86 | * Install git pre-commit hooks (for pylint and gitlint) with `pre-commit install` 87 | * You can run the tests with `python -m unittest` 88 | * After pushing, you should check the build status which currently checks the tests, pylint and the commit message format. 89 | 90 | ### Notes 91 | 92 | The following steps are automatically executed via pre-commit hooks. 93 | 94 | * You can run pylint with `pylint gitea_auto_update` 95 | * After changes and commit, you can check if your commit message follows the contribution guidelines with `gitlint`. If there is a problem, gitlint will show you a error message. 96 | 97 | ## Contributors 98 | 99 | See https://github.com/CMiksche/gitea-auto-update/graphs/contributors 100 | 101 | Thank you for your support! 102 | 103 | Interested in contributing to this project? Check out the [Contribution Guidelines](CONTRIBUTING.md). 104 | -------------------------------------------------------------------------------- /gitea_auto_update/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CMiksche/gitea-auto-update/9449498d49deba3e95734e4654b84bce79ebc035/gitea_auto_update/__init__.py -------------------------------------------------------------------------------- /gitea_auto_update/lib/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CMiksche/gitea-auto-update/9449498d49deba3e95734e4654b84bce79ebc035/gitea_auto_update/lib/__init__.py -------------------------------------------------------------------------------- /gitea_auto_update/lib/build.py: -------------------------------------------------------------------------------- 1 | ''' 2 | Gitea Auto Updater 3 | 4 | Copyright 2018, 2019, 2020 The Gitea-Auto-Update Authors 5 | All rights reserved. 6 | 7 | License: GNU General Public License 8 | ''' 9 | import os 10 | 11 | 12 | def build_from_source(tag, gt_file, source_dir): 13 | """Function to build the new version from source""" 14 | os.chdir(source_dir) 15 | os.system("git checkout main") 16 | os.system("git pull") 17 | os.system("git checkout " + tag) 18 | os.system('TAGS="bindata sqlite sqlite_unlock_notify" make generate build') 19 | os.system("cp gitea " + gt_file) 20 | os.system("rm -f gitea") 21 | -------------------------------------------------------------------------------- /gitea_auto_update/lib/download.py: -------------------------------------------------------------------------------- 1 | ''' 2 | Gitea Auto Updater 3 | 4 | Copyright 2018, 2019, 2020 The Gitea-Auto-Update Authors 5 | All rights reserved. 6 | 7 | License: GNU General Public License 8 | ''' 9 | import os 10 | import sys 11 | import logging 12 | from shutil import which # from whichcraft import which 13 | import requests 14 | 15 | 16 | def is_tool(name): 17 | """Function to check if tool is available""" 18 | # Check whether `name` is on PATH and marked as executable. 19 | return which(name) is not None 20 | 21 | 22 | def download(url, file_name): 23 | """Function to download a file""" 24 | # open in binary mode 25 | with open(file_name, "wb") as file: 26 | # get request 27 | response = requests.get(url, timeout=3600) 28 | # write to file 29 | file.write(response.content) 30 | 31 | 32 | def sha_check(): 33 | """Check sha for gitea file""" 34 | sha_path = 'gitea.xz.sha256' 35 | if os.path.exists(sha_path): 36 | return os.system("sha256sum -c "+sha_path+" > /dev/null") == 0 37 | # return true because we don't have a sha file to check 38 | return True 39 | 40 | 41 | class Download: 42 | """Class for downloading gitea""" 43 | 44 | def __init__(self, tmp_dir, github_version_tag, gt_system, gt_file): 45 | if not is_tool("xz"): 46 | logging.error('Download: missing dependency: xz') 47 | sys.exit() 48 | 49 | self.tmp_dir = tmp_dir 50 | self.github_version_tag = github_version_tag 51 | self.github_version = self.github_version_tag[1:] 52 | self.gt_system = gt_system 53 | self.gt_file = gt_file 54 | 55 | self.download_gitea_files() 56 | self.check_and_extract() 57 | 58 | def download_gitea_files(self): 59 | """Download gitea files""" 60 | # Set download url 61 | gt_download = 'https://github.com/go-gitea/gitea/releases/download/' \ 62 | + self.github_version_tag + '/gitea-' + self.github_version \ 63 | + '-' + self.gt_system + '.xz' 64 | logging.info('Download: Gitea file: %s', gt_download) 65 | sha_download = gt_download + '.sha256' 66 | logging.info('Download: SHA file: %s', sha_download) 67 | 68 | # Download file 69 | logging.info('Download: downloading sha256 hashsum') 70 | download(sha_download, self.tmp_dir + 'gitea.xz.sha256') 71 | logging.info('Download: downloading %s', self.github_version_tag + 'gitea.xz') 72 | self.tmp_xz = self.tmp_dir + 'gitea-' + self.github_version + '-' + self.gt_system + '.xz' 73 | download(gt_download, self.tmp_xz) 74 | 75 | def extract_file(self): 76 | """Extract gitea file""" 77 | logging.info('Download: sha ok, extracting file to location') 78 | # extracting download file 79 | cmd = "xz -d " + self.tmp_xz 80 | os.system(cmd) 81 | # copying temp file to gtfile location. 82 | # Copying preserves SELinux permissions, see issue #22 83 | cmd = 'cp ' + self.tmp_dir + 'gitea-' + self.github_version \ 84 | + '-' + self.gt_system + ' ' + self.gt_file 85 | os.system(cmd) 86 | # cleaning up tmp file 87 | cmd = 'rm -f ' + self.tmp_dir + 'gitea-' + self.github_version + '-' + self.gt_system 88 | os.system(cmd) 89 | cmd = 'chmod +x ' + self.gt_file 90 | os.system(cmd) 91 | 92 | def check_and_extract(self): 93 | """Check file and extract""" 94 | os.chdir(self.tmp_dir) 95 | if sha_check(): 96 | self.extract_file() 97 | else: 98 | logging.error('Download: error: sha256sum failed') 99 | sys.exit() 100 | -------------------------------------------------------------------------------- /gitea_auto_update/lib/test_version.py: -------------------------------------------------------------------------------- 1 | ''' 2 | Gitea Auto Updater 3 | 4 | Copyright 2019, 2020 The Gitea-Auto-Update Authors 5 | All rights reserved. 6 | 7 | License: GNU General Public License 8 | ''' 9 | import unittest 10 | import gitea_auto_update.lib.version 11 | 12 | VERSION = gitea_auto_update.lib.version 13 | 14 | 15 | class TestVersion(unittest.TestCase): 16 | """Test the version class""" 17 | 18 | def test_simple_version(self): 19 | """1.9.1 should be newer than 1.9.0""" 20 | self.assertTrue(VERSION.check_version('1.9.1', '1.9.0')) 21 | 22 | def test_two_int_version(self): 23 | """1.10.0 should be newer than 1.9.0""" 24 | self.assertTrue(VERSION.check_version('1.10.0', '1.9.0')) 25 | 26 | def test_false_version(self): 27 | """1.8.0 should be older than 1.9.0""" 28 | self.assertFalse(VERSION.check_version('1.8.0', '1.9.0')) 29 | 30 | def test_same_version(self): 31 | """1.9.7 should be the same as 1.9.7""" 32 | self.assertFalse(VERSION.check_version('1.9.7', '1.9.7')) 33 | 34 | def test_int(self): 35 | """9 should be newer than 8""" 36 | self.assertTrue(VERSION.check_version('9', '8')) 37 | 38 | def test_suffix(self): 39 | """1.9.0+dev-264-g8de76b6e6 should be newer than 1.8.0""" 40 | self.assertTrue(VERSION.check_version('1.9.0+dev-264-g8de76b6e6', '1.8.0')) 41 | 42 | def test_parse_file_version(self): 43 | """It should get the version from a string""" 44 | string = 'Gitea version 1.8.1 built with go1.12.2 : bindata, sqlite, sqlite_unlock_notify' 45 | self.assertEqual( 46 | VERSION.parse_file_version(string), 47 | '1.8.1' 48 | ) 49 | 50 | 51 | if __name__ == '__main__': 52 | unittest.main() 53 | -------------------------------------------------------------------------------- /gitea_auto_update/lib/version.py: -------------------------------------------------------------------------------- 1 | ''' 2 | Gitea Auto Updater 3 | 4 | Copyright 2018, 2019, 2020 The Gitea-Auto-Update Authors 5 | All rights reserved. 6 | 7 | License: GNU General Public License 8 | ''' 9 | import os 10 | import logging 11 | from packaging import version 12 | import requests 13 | 14 | 15 | def get_github_version_tag(api_url): 16 | """Get the version from github""" 17 | version_tag = requests.get(api_url, timeout=30).json()['tag_name'] 18 | logging.info('Version: github_version_tag = %s', version_tag) 19 | return version_tag 20 | 21 | 22 | def parse_file_version(string): 23 | """Get the version from a file""" 24 | return string.split(" ")[2] 25 | 26 | 27 | def check_version(new_version, old_version): 28 | """Function to check if there is a new version""" 29 | return version.parse(new_version) > version.parse(old_version) 30 | 31 | 32 | class Version: 33 | """Class to get and check the gitea version""" 34 | 35 | def __init__(self, gt_site, gt_file): 36 | self.gt_site = gt_site 37 | self.gt_file = gt_file 38 | 39 | def get_version_from_file(self): 40 | """Read the version from the gitea file""" 41 | version_string = os.popen(self.gt_file + " -v").read() 42 | return parse_file_version(version_string) 43 | 44 | def get_current_version(self): 45 | """Function to get the current version""" 46 | try: 47 | # Try to get the version from the file 48 | current_version = self.get_version_from_file() 49 | except IOError: 50 | # Get the version via the web api if the file does fail 51 | try: 52 | current_version = requests.get(self.gt_site, timeout=30).json()['version'] 53 | if current_version.status_code != 200: 54 | raise RuntimeError("Could not download version.") from None 55 | except RuntimeError: 56 | # To allow installation, return a default version of "0.0.0". 57 | current_version = "0.0.0" 58 | finally: 59 | logging.info('Version: current_version = %s', current_version) 60 | return current_version 61 | -------------------------------------------------------------------------------- /gitea_auto_update/update.py: -------------------------------------------------------------------------------- 1 | ''' 2 | Gitea Auto Updater 3 | 4 | Copyright 2018, 2019, 2020 The Gitea-Auto-Update Authors 5 | All rights reserved. 6 | 7 | License: GNU General Public License 8 | ''' 9 | import os 10 | import sys 11 | import logging 12 | import configparser 13 | import fire 14 | import gitea_auto_update.lib.version 15 | import gitea_auto_update.lib.download 16 | import gitea_auto_update.lib.build 17 | 18 | 19 | class Update: 20 | """ 21 | Main class to update gitea 22 | """ 23 | 24 | def __init__(self, 25 | config): 26 | self.config = config 27 | 28 | # Get version tag from github and remove first char (v) 29 | self.github_version_tag = gitea_auto_update.lib.version.get_github_version_tag( 30 | config.get('Gitea', 'apiUrl') 31 | ) 32 | # Get version from version tag 33 | self.github_version = self.github_version_tag[1:] 34 | 35 | self.check_and_update() 36 | 37 | def do_update(self): 38 | """Execute the update""" 39 | 40 | # Should the new version be build from source? 41 | if self.config.get('Gitea', 'buildFromSource'): 42 | gitea_auto_update.lib.build.build_from_source( 43 | self.github_version_tag, 44 | self.config.get('Gitea', 'file'), 45 | self.config.get('Gitea', 'sourceDir') 46 | ) 47 | else: 48 | gitea_auto_update.lib.download.Download( 49 | self.config.get('Gitea', 'tmpDir'), 50 | self.github_version_tag, 51 | self.config.get('Gitea', 'system'), 52 | self.config.get('Gitea', 'file') 53 | ) 54 | 55 | def check_and_update(self): 56 | """Check if a update is possible and do it if it is""" 57 | # Version from gitea site 58 | version = gitea_auto_update.lib.version.Version( 59 | self.config.get('Gitea', 'site'), 60 | self.config.get('Gitea', 'file') 61 | ) 62 | current_version = version.get_current_version() 63 | # Check if there is a new version 64 | if gitea_auto_update.lib.version.check_version(self.github_version, current_version): 65 | logging.info('Update: new version available, stopping service') 66 | os.system("systemctl stop gitea.service") 67 | self.do_update() 68 | logging.info('Update: starting gitea.service') 69 | os.system("systemctl start gitea.service") 70 | print("update successfully") 71 | else: 72 | print("current version is uptodate") 73 | print("Check out https://chapati.systems/autoupdate/ if you want to " 74 | "update Gitea and other software " 75 | "(like Drone, Caddy, Podman, Python, Zitadel and Kanboard)") 76 | 77 | 78 | def updater(settings='settings.ini'): 79 | """Get the config and set logging""" 80 | # Config 81 | config = configparser.ConfigParser() 82 | config.read(settings) 83 | # Create a log file 84 | logging.basicConfig(filename=config.get('Gitea', 'logFile'), level=logging.DEBUG) 85 | # Start update 86 | Update(config) 87 | 88 | 89 | def main(): 90 | """Main func""" 91 | if not sys.version_info[0] == 3: 92 | sys.exit("Sorry, Python 2 is not supported. Please update to Python 3.") 93 | fire.Fire(updater) 94 | 95 | 96 | if __name__ == '__main__': 97 | main() 98 | -------------------------------------------------------------------------------- /settings.ini: -------------------------------------------------------------------------------- 1 | [Gitea] 2 | site=https://your-gitea-instance.com/api/v1/version 3 | apiUrl=https://api.github.com/repos/go-gitea/gitea/releases/latest 4 | system=linux-amd64 5 | file=/usr/local/bin/gitea 6 | tmpDir=/tmp/ 7 | buildFromSource=None 8 | sourceDir=/home/git/go/src/code.gitea.io/gitea 9 | logFile=update.log -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | ''' 2 | Gitea Auto Updater 3 | 4 | Copyright 2018, 2019, 2020, 2021, 2022 The Gitea-Auto-Update Authors 5 | All rights reserved. 6 | 7 | License: GNU General Public License 8 | ''' 9 | import setuptools 10 | 11 | with open("README.md", "r", encoding='utf8') as fh: 12 | LONG_DESCRIPTION = fh.read() 13 | 14 | setuptools.setup( 15 | name='gitea_auto_update', 16 | version='2.0.13', 17 | description='A script which can update gitea to a new version.', 18 | long_description=LONG_DESCRIPTION, 19 | long_description_content_type="text/markdown", 20 | url='https://github.com/CMiksche/gitea-auto-update', 21 | author='Christoph Miksche', 22 | author_email='autoupdate@chapati.systems', 23 | license='GPLv3', 24 | classifiers=[ 25 | "Programming Language :: Python :: 3", 26 | "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", 27 | "Operating System :: Unix", 28 | ], 29 | keywords=['gitea', 'update', 'debian', 'linux'], 30 | python_requires='>=3', 31 | install_requires=[ 32 | 'requests', 33 | 'packaging', 34 | 'fire', 35 | 'configparser' 36 | ], 37 | packages=setuptools.find_packages(), 38 | entry_points={ 39 | 'console_scripts': ['gitea-auto-update=gitea_auto_update.update:main'], 40 | } 41 | ) 42 | --------------------------------------------------------------------------------