├── LICENSE ├── README.md ├── composer.json ├── composer.lock ├── git-artifact ├── logo.png └── src ├── Commands └── ArtifactCommand.php ├── Git └── ArtifactGitRepository.php ├── Traits ├── FilesystemTrait.php ├── LoggerTrait.php └── TokenTrait.php └── app.php /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 | 635 | Copyright (C) 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 | Copyright (C) 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 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | 3 | Git Artifact logo 4 |

5 | 6 |

Package and push files to a remote repository

7 | 8 |
9 | 10 | [![GitHub Issues](https://img.shields.io/github/issues/drevops/git-artifact.svg)](https://github.com/drevops/git-artifact/issues) 11 | [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/drevops/git-artifact.svg)](https://github.com/drevops/git-artifact/pulls) 12 | ![GitHub release (latest by date)](https://img.shields.io/github/v/release/drevops/git-artifact) 13 | [![codecov](https://codecov.io/gh/drevops/git-artifact/branch/main/graph/badge.svg?token=QNBXCIBK5J)](https://codecov.io/gh/drevops/git-artifact) 14 | [![Total Downloads](https://poser.pugx.org/drevops/behat-screenshot/downloads)](https://packagist.org/packages/drevops/git-artifact) 15 | ![LICENSE](https://img.shields.io/github/license/drevops/git-artifact) 16 | ![Renovate](https://img.shields.io/badge/renovate-enabled-green?logo=renovatebot) 17 | 18 | [![Test PHP](https://github.com/drevops/git-artifact/actions/workflows/test-php.yml/badge.svg)](https://github.com/drevops/git-artifact/actions/workflows/test-php.yml) 19 | [![CircleCI](https://circleci.com/gh/drevops/git-artifact.svg?style=shield)](https://circleci.com/gh/drevops/git-artifact) 20 | 21 |
22 | 23 | --- 24 | 25 | ## 🌟 With Git Artifact, you can: 26 | 27 | 📦 Assemble a code artifact locally or in CI
28 | 🧹 Exclude any unwanted files using a deployment `.gitignore`
29 | 📤 Transfer the final artifact to a destination Git repository for deployment
30 | 🔁 Choose between `force-push` or `branch` modes to fit your workflow
31 | 32 | See example of deployed artifact 33 | in [Artifact branches](https://github.com/drevops/git-artifact-destination/branches). 34 | 35 | ## 🔀 Workflow 36 | 37 | 1️⃣ 🧑‍💻 Develop in the _source_ repository
38 | 2️⃣ 📦 CI installs dependencies and runs **git-artifact** to package and push code to _destination_ repository
39 | 3️⃣ 🚀 Deployment triggered whan code received
40 | 41 | ## 🎚️ Modes 42 | 43 | ### `force-push` mode (default) 44 | 45 | Push the packaged artifact to the **same branch** in the _destination_ repository. 46 | This will carry over the branch history from the _source_ repository and will overwrite 47 | the existing branch history in the _destination_ repository. 48 | 49 | ``` 50 | ================================================== 51 | 🏃 Run 1 52 | ================================================== 53 | 54 | Local repo Remote repo 55 | +------------------+ 56 | | Artifact commit | 💥 New commit 57 | +------------------+ 58 | +-----------+ +------------------+ 59 | | Commit 2 | | Commit 2 | \ 60 | +-----------+ == 📦 ==> +------------------+ ) 👍 Source commit 61 | | Commit 1 | | Commit 1 | / history preserved 62 | +-----------+ +------------------+ 63 | `mybranch` `mybranch` 64 | 65 | 👆 66 | Branch name identical to source 67 | 68 | ================================================== 69 | 🏃 Run 2 70 | ================================================== 71 | 72 | Local repo Remote repo 73 | +------------------+ 74 | | Artifact commit | 💥 New commit 75 | +------------------+ 76 | +-----------+ +------------------+ 77 | | Commit 4 | | Commit 4 | \ 78 | +-----------+ +------------------+ \ 79 | | Commit 3 | | Commit 3 | \ 80 | +-----------+ == 📦 ==> +------------------+ ) 👍 Source commit 81 | | Commit 2 | | Commit 2 | / history preserved 82 | +-----------+ +------------------+ / 83 | | Commit 1 | | Commit 1 | / 84 | +-----------+ +------------------+ 85 | `mybranch` `mybranch` 86 | 87 | 👆 88 | Branch name identical to source 89 | 90 | ``` 91 | 92 | #### Use case 93 | 94 | Forwarding all changes in the _source_ repository to the _destination_ 95 | repository **as-is** for **every branch**: for example, a commit in the _source_ 96 | repository branch `feature/123` would create a commit in the _destination_ 97 | repository branch `feature/123`. The next commit to the _source_ repository 98 | branch `feature/123` would update the _destination_ repository branch 99 | `feature/123` with the changes, but would overwrite the last "artifact commit". 100 | 101 | ### `branch` mode 102 | 103 | Push the packaged artifact to the **new branch** in the _destination_ repository. 104 | This will carry over the branch history from the _source_ repository to a 105 | dedicated branch in the _destination_ repository. The follow-up pushes to the 106 | branch in the _destination_ repository will be blocked. 107 | 108 | ``` 109 | ================================================== 110 | 🏃 Run 1 111 | ================================================== 112 | 113 | Local repo Remote repo 114 | +------------------+ 115 | | Artifact commit | 💥 New commit 116 | +------------------+ 117 | +-----------+ +------------------+ 118 | | Commit 2 | | Commit 2 | \ 119 | +-----------+ == 📦 ==> +------------------+ ) 👍 Source commit 120 | | Commit 1 | | Commit 1 | / history preserved 121 | +-----------+ +------------------+ 122 | 123 | `mybranch` `deployment/1.2.3` 124 | tagged with 125 | `1.2.3` 126 | 127 | 👆 👆 128 | Tagged branch New branch based on tag 129 | 130 | ================================================== 131 | 🏃 Run 2 132 | ================================================== 133 | 134 | Local repo Remote repo 135 | +------------------+ 136 | | Artifact commit | 💥 New commit 137 | +------------------+ 138 | +-----------+ +------------------+ 139 | | Commit 4 | | Commit 4 | \ 140 | +-----------+ +------------------+ \ 141 | | Commit 3 | | Commit 3 | \ 142 | +-----------+ == 📦 ==> +------------------+ ) 👍 Source commit 143 | | Commit 2 | | Commit 2 | / history preserved 144 | +-----------+ +------------------+ / 145 | | Commit 1 | | Commit 1 | / 146 | +-----------+ +------------------+ 147 | 148 | `mybranch` `deployment/1.2.4` 149 | tagged with 150 | `1.2.4` 👈 New tag 1.2.4 151 | 152 | 👆 👆 153 | Tagged branch New branch based on a new tag 154 | with a new tag 155 | 156 | ``` 157 | 158 | #### Use case 159 | 160 | Creating a **new branch** in the _destination_ repository for every **tag** 161 | created in the _source_ repository: for example, a tag `1.2.3` in the source 162 | repository would create a branch `deployment/1.2.3` in the destination 163 | repository. The addition of the new tags would create new unique branches in the 164 | destination repository. 165 | 166 | ## 📥 Installation 167 | 168 | This package is intended to be used as a standalone binary. You will need to 169 | have PHP installed on your system to run the binary. 170 | 171 | Download the latest release from the [GitHub releases page](https://github.com/drevops/git-artifact/releases/latest). 172 | 173 | You may also install the package globally using Composer: 174 | ```shell 175 | composer global require --dev drevops/git-artifact 176 | ``` 177 | 178 | ## ▶️ Usage 179 | 180 | ```shell 181 | ./git-artifact git@github.com:yourorg/your-repo-destination.git 182 | ``` 183 | 184 | This will create an artifact from current directory and will send it to the 185 | specified remote repository into the same branch as a current one. 186 | 187 | Avoid including development dependencies in your artifacts. Instead, configure 188 | your CI to build with production-only dependencies, export the resulting code, 189 | and use that as the artifact source. See our CI examples below. 190 | 191 | Call from the CI configuration or deployment script: 192 | 193 | ```shell 194 | export DEPLOY_BRANCH= 195 | ./git-artifact git@github.com:yourorg/your-repo-destination.git \ 196 | --branch="${DEPLOY_BRANCH}" \ 197 | --push 198 | ``` 199 | 200 | CI providers may report branches differently when running builds triggered by tags. 201 | We encourage you to explore our continuously and automatically tested examples: 202 | 203 | - [GitHub Actions](.github/workflows/test-php.yml) 204 | - [CircleCI](.circleci/config.yml) 205 | 206 | See extended and 207 | fully-configured [example in the Vortex project](https://github.com/drevops/vortex/blob/develop/scripts/vortex/deploy-artifact.sh). 208 | 209 | 210 | ## 🎛️ Options 211 | 212 | | Name | Default value | Description | 213 | |------------------------|---------------------|------------------------------------------------------------------------------------------------| 214 | | `--mode` | `force-push` | Mode of artifact build: `branch`, `force-push` | 215 | | `--branch` | `[branch]` | Destination branch with optional tokens (see below) | 216 | | `--gitignore` | | Path to the `.gitignore` file to replace the current `.gitignore` | 217 | | `--src` | | Directory where source repository is located. Uses root directory if not specified | 218 | | `--root` | | Path to the root for file path resolution. Uses current directory if not specified | 219 | | `--message` | `Deployment commit` | Commit message with optional tokens (see below) | 220 | | `--no-cleanup` | | Do not cleanup after run | 221 | | `--log` | | Path to the log file | 222 | | `--show-changes` | | Show changes made to the repo by the build in the output | 223 | | `--dry-run` | | Run without pushing to the remote repository | 224 | | `--now` | | Internal value used to set internal time | 225 | | `-h, --help` | | Display help for the given command | 226 | | `-q, --quiet` | | Do not output any messages | 227 | | `-V, --version` | | Display this application version | 228 | | `--ansi` | | Force ANSI output. Use `--no-ansi` to disable | 229 | | `-n, --no-interaction` | | Do not ask any interactive question | 230 | | `-v, --verbose` | | Increase the verbosity of messages: 1 for normal, 2 for more verbose, 3 for debug | 231 | 232 | ## 🧹 Modifying artifact content 233 | 234 | `--gitignore` option allows to specify the path to the artifact's `.gitignore` 235 | file that replaces existing `.gitignore` (if any) during the build. Any files no 236 | longer ignored by the replaced artifact's `.gitignore` are added into the 237 | deployment commit. If there are no no-longer-excluded files, the deployment 238 | commit is still created, to make sure that the deployment timestamp is 239 | captured. 240 | 241 | ## 🏷️ Token support 242 | 243 | Tokens are pre-defined strings surrounded by `[` and `]` and may contain 244 | optional formatter. For example, `[timestamp:Y-m-d]` is 245 | replaced with the current timestamp in format `Y-m-d` (token formatter), which 246 | is PHP [`date()`](https://www.php.net/manual/en/function.date.php) expected format. 247 | 248 | Both `--branch` and `--message` option values support token replacement. 249 | 250 | Available tokens: 251 | 252 | - `[timestamp:FORMAT]` - current time with a PHP [`date()`](https://www.php.net/manual/en/function.date.php)-compatible `FORMAT`. 253 | - `[branch]` - current branch in the source repository. 254 | - `[safebranch]` - current branch in the source repository with with all non-alphanumeric characters replaced with `-` and lowercased. 255 | - `[tags:DELIMITER]` - tags from the latest commit in the source repository 256 | separated by a `DELIMITER`. 257 | 258 | ## Maintenance 259 | 260 | ### 🧪 Testing 261 | 262 | Packaging and deployment of artifacts is a mission-critical process, so we maintain 263 | a set of unit, functional and integration tests to make sure that everything works 264 | as expected. 265 | 266 | You can see examples of the branches created by the Git Artifact in the [example _destination_ repository](https://github.com/drevops/git-artifact-destination/branches). 267 | 268 | ### Lint and fix code 269 | 270 | ```bash 271 | composer lint 272 | composer lint-fix 273 | ``` 274 | 275 | ### Run tests 276 | 277 | ```bash 278 | composer test 279 | ``` 280 | 281 | --- 282 | _Repository created using https://getscaffold.dev/ project scaffold template_ 283 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "drevops/git-artifact", 3 | "description": "Build artifact from your codebase in CI and push it to a separate git repo.", 4 | "license": "GPL-2.0-or-later", 5 | "type": "package", 6 | "authors": [ 7 | { 8 | "name": "Alex Skrypnyk", 9 | "email": "alex@drevops.com" 10 | } 11 | ], 12 | "homepage": "https://github.com/drevops/git-artifact", 13 | "support": { 14 | "issues": "https://github.com/drevops/git-artifact/issues", 15 | "source": "https://github.com/drevops/git-artifact" 16 | }, 17 | "require": { 18 | "php": ">=8.2", 19 | "czproject/git-php": "^4.3", 20 | "monolog/monolog": "^3.5", 21 | "symfony/console": "^7", 22 | "symfony/filesystem": "^7", 23 | "symfony/finder": "^7", 24 | "symfony/monolog-bridge": "^7", 25 | "symfony/process": "^7" 26 | }, 27 | "require-dev": { 28 | "bamarni/composer-bin-plugin": "^1.8", 29 | "dealerdirect/phpcodesniffer-composer-installer": "^1.0", 30 | "drupal/coder": "^8.3", 31 | "ergebnis/composer-normalize": "^2.43", 32 | "phpstan/phpstan": "^2", 33 | "phpunit/phpunit": "^11", 34 | "rector/rector": "^2" 35 | }, 36 | "autoload": { 37 | "psr-4": { 38 | "DrevOps\\GitArtifact\\": "src" 39 | } 40 | }, 41 | "autoload-dev": { 42 | "psr-4": { 43 | "DrevOps\\GitArtifact\\Tests\\": "tests" 44 | } 45 | }, 46 | "bin": [ 47 | "git-artifact" 48 | ], 49 | "config": { 50 | "allow-plugins": { 51 | "bamarni/composer-bin-plugin": true, 52 | "dealerdirect/phpcodesniffer-composer-installer": true, 53 | "ergebnis/composer-normalize": true 54 | } 55 | }, 56 | "scripts": { 57 | "build": [ 58 | "@composer bin box require --dev humbug/box", 59 | "box validate", 60 | "box compile" 61 | ], 62 | "lint": [ 63 | "phpcs", 64 | "phpstan --memory-limit=-1", 65 | "rector --clear-cache --dry-run" 66 | ], 67 | "lint-fix": [ 68 | "rector --clear-cache", 69 | "phpcbf" 70 | ], 71 | "reset": "rm -Rf vendor vendor-bin", 72 | "test": "phpunit --no-coverage", 73 | "test-coverage": "phpunit" 74 | } 75 | } 76 | -------------------------------------------------------------------------------- /git-artifact: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env php 2 | fs = is_null($fs) ? new Filesystem() : $fs; 137 | } 138 | 139 | /** 140 | * Configure command. 141 | */ 142 | protected function configure(): void { 143 | $this->setName('artifact'); 144 | 145 | $this->setDescription('Assemble a code artifact from your codebase, remove unnecessary files, and push it into a separate Git repository.'); 146 | 147 | $this->addArgument('remote', InputArgument::REQUIRED, 'Path to the remote git repository.'); 148 | 149 | // @formatter:off 150 | // phpcs:disable Generic.Functions.FunctionCallArgumentSpacing.TooMuchSpaceAfterComma 151 | // phpcs:disable Drupal.WhiteSpace.Comma.TooManySpaces 152 | $this 153 | ->addOption('branch', NULL, InputOption::VALUE_REQUIRED, 'Destination branch with optional tokens.', '[branch]') 154 | ->addOption('dry-run', NULL, InputOption::VALUE_NONE, 'Run without pushing to the remote repository.') 155 | ->addOption('gitignore', NULL, InputOption::VALUE_REQUIRED, 'Path to gitignore file to replace current .gitignore. Leave empty to use current .gitignore.') 156 | ->addOption('message', NULL, InputOption::VALUE_REQUIRED, 'Commit message with optional tokens.', 'Deployment commit') 157 | ->addOption('mode', NULL, InputOption::VALUE_REQUIRED, 'Mode of artifact build: branch, force-push. Defaults to force-push.', static::MODE_FORCE_PUSH) 158 | ->addOption('no-cleanup', NULL, InputOption::VALUE_NONE, 'Do not cleanup after run.') 159 | ->addOption('now', NULL, InputOption::VALUE_REQUIRED, 'Internal value used to set internal time.') 160 | ->addOption('log', NULL, InputOption::VALUE_REQUIRED, 'Path to the log file.') 161 | ->addOption('root', NULL, InputOption::VALUE_REQUIRED, 'Path to the root for file path resolution. If not specified, current directory is used.') 162 | ->addOption('show-changes', NULL, InputOption::VALUE_NONE, 'Show changes made to the repo by the build in the output.') 163 | ->addOption('src', NULL, InputOption::VALUE_REQUIRED, 'Directory where source repository is located. If not specified, root directory is used.'); 164 | // @formatter:on 165 | // phpcs:enable Generic.Functions.FunctionCallArgumentSpacing.TooMuchSpaceAfterComma 166 | // phpcs:enable Drupal.WhiteSpace.Comma.TooManySpaces 167 | } 168 | 169 | /** 170 | * Perform actual command. 171 | * 172 | * @param \Symfony\Component\Console\Input\InputInterface $input 173 | * Input. 174 | * @param \Symfony\Component\Console\Output\OutputInterface $output 175 | * Output. 176 | * 177 | * @return int 178 | * Status code. 179 | * 180 | * @throws \Exception 181 | */ 182 | protected function execute(InputInterface $input, OutputInterface $output): int { 183 | $this->output = $output; 184 | 185 | $this->loggerInit((string) $this->getName(), $input, $output); 186 | 187 | $remote = $input->getArgument('remote'); 188 | if (!is_string($remote) || empty(trim($remote))) { 189 | throw new \RuntimeException('Remote argument must be a non-empty string'); 190 | } 191 | 192 | try { 193 | $this->checkRequirements(); 194 | 195 | $this->resolveOptions($remote, $input->getOptions()); 196 | 197 | $this->doExecute(); 198 | } 199 | catch (\Exception $exception) { 200 | $this->output->writeln([ 201 | 'Processing failed with an error:', 202 | '' . $exception->getMessage() . '', 203 | ]); 204 | 205 | return Command::FAILURE; 206 | } 207 | 208 | $this->output->writeln('Deployment finished successfully.'); 209 | 210 | return Command::SUCCESS; 211 | } 212 | 213 | /** 214 | * Assemble a code artifact from your codebase. 215 | */ 216 | protected function doExecute(): void { 217 | $error = NULL; 218 | 219 | try { 220 | $this->repo->addRemote($this->remoteName, $this->remoteUrl); 221 | 222 | $this->showInfo(); 223 | 224 | // Do not optimize this into a chained call to make it easier to debug. 225 | $repo = $this->repo; 226 | $repo->switchToBranch($this->artifactBranch, TRUE); 227 | $repo->removeSubRepositories(); 228 | $repo->disableLocalExclude(); 229 | $repo->replaceGitignoreFromCustom(); 230 | // Custom .gitignore may contain rules that will change the list of 231 | // ignored files. We need to add these files as changes so that they 232 | // could be reported as excluded by the command below. 233 | $repo->addAllChanges(); 234 | $repo->removeIgnoredFiles(); 235 | $repo->removeOtherFiles(); 236 | $changes = $repo->commitAllChanges($this->commitMessage); 237 | 238 | if ($this->showChanges) { 239 | $this->output->writeln(sprintf('Added changes: %s', implode("\n", $changes))); 240 | $this->logger->notice(sprintf('Added changes: %s', implode("\n", $changes))); 241 | } 242 | 243 | if ($this->isDryRun) { 244 | $this->output->writeln('Cowardly refusing to push to remote. Use without --dry-run to perform an actual push.'); 245 | } 246 | else { 247 | $ref = sprintf('refs/heads/%s:refs/heads/%s', $this->artifactBranch, $this->destinationBranch); 248 | 249 | if ($this->mode === self::MODE_FORCE_PUSH) { 250 | $this->repo->push([$this->remoteName, $ref], ['--force']); 251 | } 252 | else { 253 | $this->repo->push([$this->remoteName, $ref]); 254 | } 255 | 256 | $this->output->writeln(sprintf('Pushed branch "%s" with commit message "%s"', $this->destinationBranch, $this->commitMessage)); 257 | } 258 | } 259 | catch (GitException $exception) { 260 | $result = $exception->getRunnerResult(); 261 | if (!$result) { 262 | // @codeCoverageIgnoreStart 263 | throw new \Exception('Unknown error occurred', $exception->getCode(), $exception); 264 | // @codeCoverageIgnoreEnd 265 | } 266 | 267 | $error = $result->getOutputAsString(); 268 | if (!empty($result->hasErrorOutput())) { 269 | $error .= PHP_EOL . $result->getErrorOutputAsString(); 270 | } 271 | } 272 | catch (\Exception $exception) { 273 | // Capture message to allow showing a report. 274 | $error = $exception->getMessage(); 275 | } 276 | 277 | $this->showReport(is_null($error)); 278 | 279 | if ($this->needCleanup && is_null($error)) { 280 | $this->logger->notice('Cleaning up'); 281 | $this->repo->resetToPreviousCommit(); 282 | $this->repo->restoreGitignoreToCustom(); 283 | $this->repo->restoreLocalExclude(); 284 | $this->repo->unstageAllChanges(); 285 | $this->repo->switchToBranch($this->originalBranch); 286 | $this->repo->removeBranch($this->artifactBranch, TRUE); 287 | $this->repo->removeRemote($this->remoteName); 288 | } 289 | 290 | // Dump log to a file. 291 | if (!empty($this->logFile)) { 292 | $this->loggerDump($this->logFile); 293 | } 294 | 295 | if (!is_null($error)) { 296 | $error = empty($error) ? 'Unknown error occurred' : $error; 297 | throw new \Exception($error); 298 | } 299 | } 300 | 301 | /** 302 | * Resolve and validate CLI options values into internal values. 303 | * 304 | * @param string $url 305 | * Remote URL. 306 | * @param array $options 307 | * Array of CLI options. 308 | */ 309 | protected function resolveOptions(string $url, array $options): void { 310 | if (!empty($options['root']) && is_scalar($options['root'])) { 311 | $this->fsSetRootDir(strval($options['root'])); 312 | } 313 | 314 | $this->remoteUrl = $url; 315 | $this->now = empty($options['now']) ? time() : (int) $options['now']; 316 | $this->remoteName = sprintf('%s-%s-%s', self::GIT_REMOTE_NAME, $this->now, rand(1000, 9999)); 317 | $this->showChanges = !empty($options['show-changes']); 318 | $this->needCleanup = empty($options['no-cleanup']); 319 | $this->isDryRun = !empty($options['dry-run']); 320 | $this->logFile = empty($options['log']) ? '' : $this->fsGetAbsolutePath($options['log']); 321 | 322 | $this->setMode($options['mode'], $options); 323 | 324 | $this->sourceDir = empty($options['src']) ? $this->fsGetRootDir() : $this->fsGetAbsolutePath($options['src']); 325 | 326 | // Setup Git repository from source path. 327 | $this->repo = new ArtifactGitRepository($this->sourceDir, NULL, $this->logger); 328 | 329 | // Set original, destination, artifact branch names. 330 | $this->originalBranch = $this->repo->getOriginalBranch(); 331 | 332 | $branch = $this->tokenProcess($options['branch']); 333 | if (!ArtifactGitRepository::isValidBranchName($branch)) { 334 | throw new \RuntimeException(sprintf('Incorrect value "%s" specified for git remote branch', $branch)); 335 | } 336 | $this->destinationBranch = $branch; 337 | 338 | $this->artifactBranch = $this->destinationBranch . '-artifact'; 339 | 340 | $this->commitMessage = $this->tokenProcess($options['message']); 341 | 342 | if (!empty($options['gitignore'])) { 343 | $gitignore = $this->fsGetAbsolutePath($options['gitignore']); 344 | $this->fsAssertPathsExist($gitignore); 345 | 346 | $contents = file_get_contents($gitignore); 347 | if (!$contents) { 348 | // @codeCoverageIgnoreStart 349 | throw new \Exception('Unable to load contents of ' . $gitignore); 350 | // @codeCoverageIgnoreEnd 351 | } 352 | 353 | $this->logger->debug('-----Custom .gitignore---------'); 354 | $this->logger->debug($contents); 355 | $this->logger->debug('-----.gitignore---------'); 356 | 357 | $this->gitignoreFile = $gitignore; 358 | $this->repo->setGitignoreCustom($this->gitignoreFile); 359 | } 360 | } 361 | 362 | /** 363 | * Show artifact build information. 364 | */ 365 | protected function showInfo(): void { 366 | $lines[] = ('----------------------------------------------------------------------'); 367 | $lines[] = (' Artifact information'); 368 | $lines[] = ('----------------------------------------------------------------------'); 369 | $lines[] = (' Build timestamp: ' . date('Y/m/d H:i:s', $this->now)); 370 | $lines[] = (' Mode: ' . $this->mode); 371 | $lines[] = (' Source repository: ' . $this->sourceDir); 372 | $lines[] = (' Remote repository: ' . $this->remoteUrl); 373 | $lines[] = (' Remote branch: ' . $this->destinationBranch); 374 | $lines[] = (' Gitignore file: ' . ($this->gitignoreFile ?: 'No')); 375 | $lines[] = (' Will push: ' . ($this->isDryRun ? 'No' : 'Yes')); 376 | $lines[] = ('----------------------------------------------------------------------'); 377 | 378 | $this->output->writeln($lines); 379 | 380 | foreach ($lines as $line) { 381 | $this->logger->notice($line); 382 | } 383 | } 384 | 385 | /** 386 | * Dump artifact report to a file. 387 | */ 388 | protected function showReport(bool $result): void { 389 | $lines[] = '----------------------------------------------------------------------'; 390 | $lines[] = ' Artifact report'; 391 | $lines[] = '----------------------------------------------------------------------'; 392 | $lines[] = ' Build timestamp: ' . date('Y/m/d H:i:s', $this->now); 393 | $lines[] = ' Mode: ' . $this->mode; 394 | $lines[] = ' Source repository: ' . $this->sourceDir; 395 | $lines[] = ' Remote repository: ' . $this->remoteUrl; 396 | $lines[] = ' Remote branch: ' . $this->destinationBranch; 397 | $lines[] = ' Gitignore file: ' . ($this->gitignoreFile ?: 'No'); 398 | $lines[] = ' Commit message: ' . $this->commitMessage; 399 | $lines[] = ' Push result: ' . ($result ? 'Success' : 'Failure'); 400 | $lines[] = '----------------------------------------------------------------------'; 401 | 402 | foreach ($lines as $line) { 403 | $this->logger->notice($line); 404 | } 405 | } 406 | 407 | /** 408 | * Set build mode. 409 | * 410 | * @param string $mode 411 | * Mode to set. 412 | * @param array $options 413 | * Array of CLI options. 414 | */ 415 | protected function setMode(string $mode, array $options): void { 416 | switch ($mode) { 417 | case self::MODE_FORCE_PUSH: 418 | // Intentionally empty. 419 | break; 420 | 421 | case self::MODE_BRANCH: 422 | if (is_scalar($options['branch'] ?? NULL) && !self::tokenExists(strval($options['branch']))) { 423 | $this->output->writeln('WARNING! Provided branch name does not have a token. 424 | Pushing of the artifact into this branch will fail on second and follow-up pushes to remote. 425 | Consider adding tokens with unique values to the branch name.'); 426 | } 427 | break; 428 | 429 | default: 430 | throw new \RuntimeException(sprintf('Invalid mode provided. Allowed modes are: %s', implode(', ', [ 431 | self::MODE_FORCE_PUSH, 432 | self::MODE_BRANCH, 433 | ]))); 434 | } 435 | 436 | $this->mode = $mode; 437 | } 438 | 439 | /** 440 | * Check that there all requirements are met in order to to run this command. 441 | */ 442 | protected function checkRequirements(): void { 443 | $this->logger->notice('Checking requirements'); 444 | 445 | if (!$this->fsIsCommandAvailable('git')) { 446 | // @codeCoverageIgnoreStart 447 | throw new \RuntimeException('Git command is not available'); 448 | // @codeCoverageIgnoreEnd 449 | } 450 | 451 | $this->logger->notice('All requirements were met'); 452 | } 453 | 454 | /** 455 | * Token callback to get current branch. 456 | * 457 | * @return string 458 | * Branch name. 459 | * 460 | * @throws \Exception 461 | */ 462 | protected function getTokenBranch(): string { 463 | return $this->repo->getCurrentBranchName(); 464 | } 465 | 466 | /** 467 | * Token callback to get current branch as a safe string. 468 | * 469 | * @return string 470 | * Branch name. 471 | * 472 | * @throws \Exception 473 | */ 474 | protected function getTokenSafebranch(): string { 475 | $name = $this->repo->getCurrentBranchName(); 476 | 477 | $replacement = preg_replace('/[^a-z0-9-]/i', '-', strtolower($name)); 478 | 479 | if (empty($replacement)) { 480 | // @codeCoverageIgnoreStart 481 | throw new \Exception('Safe branch name is empty'); 482 | // @codeCoverageIgnoreEnd 483 | } 484 | 485 | return $replacement; 486 | } 487 | 488 | /** 489 | * Token callback to get tags. 490 | * 491 | * @param string|null $delimiter 492 | * Token delimiter. Defaults to '-'. 493 | * 494 | * @return string 495 | * String of tags. 496 | * 497 | * @throws \Exception 498 | */ 499 | protected function getTokenTags(?string $delimiter): string { 500 | $delimiter = $delimiter ?? '-'; 501 | 502 | return implode($delimiter, $this->repo->listTagsPointingToHead()); 503 | } 504 | 505 | /** 506 | * Token callback to get current timestamp. 507 | * 508 | * @param string $format 509 | * Date format suitable for date() function. 510 | * 511 | * @return string 512 | * Date string. 513 | */ 514 | protected function getTokenTimestamp(string $format = 'Y-m-d_H-i-s'): string { 515 | return date($format, $this->now); 516 | } 517 | 518 | } 519 | -------------------------------------------------------------------------------- /src/Git/ArtifactGitRepository.php: -------------------------------------------------------------------------------- 1 | fs = new Filesystem(); 42 | 43 | if ($logger instanceof LoggerInterface) { 44 | $this->logger = $logger; 45 | } 46 | 47 | $this->gitignore = $this->getRepositoryPath() . DIRECTORY_SEPARATOR . '.gitignore'; 48 | } 49 | 50 | /** 51 | * {@inheritdoc} 52 | */ 53 | public function run(...$args): RunnerResult { 54 | $command = reset($args); 55 | 56 | $no_pager = [ 57 | 'add', 58 | 'commit', 59 | 'checkout', 60 | 'clone', 61 | 'init', 62 | 'status', 63 | 'config', 64 | 'push', 65 | 'pull', 66 | 'fetch', 67 | 'merge', 68 | 'rebase', 69 | 'reset', 70 | ]; 71 | if (!in_array($command, $no_pager)) { 72 | array_unshift($args, '--no-pager'); 73 | } 74 | 75 | return parent::run(...$args); 76 | } 77 | 78 | /** 79 | * Set gitignore file. 80 | */ 81 | public function setGitignoreCustom(string $filename): static { 82 | $this->gitignoreCustom = $filename; 83 | 84 | return $this; 85 | } 86 | 87 | /** 88 | * {@inheritdoc} 89 | */ 90 | public function addRemote($name, $url, ?array $options = NULL): static { 91 | if (!self::isValidRemote($url)) { 92 | throw new \InvalidArgumentException(sprintf('Invalid remote URL provided: %s', $url)); 93 | } 94 | 95 | return parent::addRemote($name, $url, $options); 96 | } 97 | 98 | /** 99 | * {@inheritdoc} 100 | */ 101 | public function removeRemote($name): static { 102 | if (in_array($name, $this->listRemotes())) { 103 | $this->run('remote', 'remove', $name); 104 | } 105 | 106 | return $this; 107 | } 108 | 109 | /** 110 | * Switch to new branch. 111 | * 112 | * @param string $branch 113 | * Branch name. 114 | * @param bool $create_new 115 | * Optional flag to also create a branch before switching. Default false. 116 | * 117 | * @return static 118 | * The git repository. 119 | */ 120 | public function switchToBranch(string $branch, bool $create_new = FALSE): static { 121 | if (!$create_new) { 122 | return $this->checkout($branch); 123 | } 124 | 125 | return $this->createBranch($branch, TRUE); 126 | } 127 | 128 | /** 129 | * Remove branch. 130 | * 131 | * @param string $name 132 | * Branch name. 133 | * @param bool $force 134 | * Force remove or not. 135 | * 136 | * @return static 137 | * Git repository 138 | */ 139 | public function removeBranch($name, bool $force = FALSE): static { 140 | if (empty($name)) { 141 | return $this; 142 | } 143 | 144 | $branches = $this->getBranches(); 145 | 146 | if (empty($branches)) { 147 | return $this; 148 | } 149 | 150 | if (!in_array($name, $branches)) { 151 | return $this; 152 | } 153 | 154 | if (!$force) { 155 | return parent::removeBranch($name); 156 | } 157 | 158 | $this->run('branch', ['-D' => $name]); 159 | 160 | return $this; 161 | } 162 | 163 | /** 164 | * Commit all files to git repo. 165 | * 166 | * @param string $message 167 | * The commit message. 168 | * 169 | * @return array 170 | * The changes. 171 | */ 172 | public function commitAllChanges(string $message): array { 173 | $this->addAllChanges(); 174 | 175 | // We do not use the commit method because we need return the output. 176 | return $this->execute('commit', '--allow-empty', [ 177 | '-m' => $message, 178 | ]); 179 | } 180 | 181 | /** 182 | * Disable local exclude file (.git/info/exclude). 183 | */ 184 | public function disableLocalExclude(): static { 185 | $filename = $this->getRepositoryPath() . DIRECTORY_SEPARATOR . '.git' . DIRECTORY_SEPARATOR . 'info' . DIRECTORY_SEPARATOR . 'exclude'; 186 | 187 | if ($this->fs->exists($filename)) { 188 | $this->logger->debug('Disabling local exclude'); 189 | $this->fs->rename($filename, $filename . '.bak'); 190 | } 191 | 192 | return $this; 193 | } 194 | 195 | /** 196 | * Restore previously disabled local exclude file. 197 | */ 198 | public function restoreLocalExclude(): static { 199 | $filename = $this->getRepositoryPath() . DIRECTORY_SEPARATOR . '.git' . DIRECTORY_SEPARATOR . 'info' . DIRECTORY_SEPARATOR . 'exclude'; 200 | 201 | if ($this->fs->exists($filename . '.bak')) { 202 | $this->logger->debug('Restoring local exclude'); 203 | $this->fs->rename($filename . '.bak', $filename); 204 | } 205 | 206 | return $this; 207 | } 208 | 209 | /** 210 | * List remotes. 211 | * 212 | * @return array 213 | * Remotes. 214 | */ 215 | protected function listRemotes(): array { 216 | return $this->extractFromCommand(['remote']) ?: []; 217 | } 218 | 219 | /** 220 | * Get tag pointing to HEAD. 221 | * 222 | * @return string[] 223 | * Array of tags from the latest commit. 224 | * 225 | * @throws \Exception 226 | * If no tags found in the latest commit. 227 | */ 228 | public function listTagsPointingToHead(): array { 229 | $tags = $this->extractFromCommand(['tag', ['--points-at', 'HEAD']]); 230 | 231 | if (empty($tags)) { 232 | throw new \Exception('No tags found in the latest commit.'); 233 | } 234 | 235 | return $tags; 236 | } 237 | 238 | /** 239 | * Ger original branch, accounting for detached repository state. 240 | * 241 | * Usually, repository become detached when a tag is checked out. 242 | * 243 | * @return string 244 | * Branch or detachment source. 245 | * 246 | * @throws \Exception 247 | * If neither branch nor detachment source is not found. 248 | */ 249 | public function getOriginalBranch(): string { 250 | $branch = $this->getCurrentBranchName(); 251 | 252 | // Repository could be in detached state. If this the case - we need to 253 | // capture the source of detachment, if it exists. 254 | if (str_contains($branch, 'HEAD detached')) { 255 | $branch = NULL; 256 | $branch_list = $this->getBranches(); 257 | if ($branch_list) { 258 | $branch_list = array_filter($branch_list); 259 | foreach ($branch_list as $branch) { 260 | if (preg_match('/\(.*detached .* ([^)]+)\)/', $branch, $matches)) { 261 | $branch = $matches[1]; 262 | break; 263 | } 264 | } 265 | } 266 | 267 | if (empty($branch)) { 268 | throw new \Exception('Unable to determine a detachment source'); 269 | } 270 | } 271 | 272 | return $branch; 273 | } 274 | 275 | /** 276 | * Remove ignored files. 277 | */ 278 | public function removeIgnoredFiles(): static { 279 | $files = []; 280 | 281 | if ($this->gitignore !== NULL && file_exists($this->gitignore)) { 282 | $files = $this->extractFromCommand(['ls-files', '-i', '-c', '--exclude-from=' . $this->gitignore]) ?: []; 283 | $files = array_merge($files, array_filter($files)); 284 | } 285 | 286 | if ($this->gitignore !== NULL && file_exists($this->gitignore)) { 287 | $files = $this->extractFromCommand(['ls-files', '-i', '-c', '--exclude-from=' . $this->gitignore]) ?: []; 288 | $files = array_merge($files, array_filter($files)); 289 | } 290 | 291 | // Symlinks are not returned by the command above. We need to find them 292 | // manually and check if they are ignored. 293 | $symlinks_iterator = (new Finder()) 294 | ->ignoreDotFiles(FALSE) 295 | ->ignoreVCS(TRUE) 296 | ->in($this->getRepositoryPath()) 297 | ->filter(fn($file) => $file->isLink()) 298 | ->getIterator(); 299 | 300 | foreach ($symlinks_iterator as $file) { 301 | $path = $file->getRelativePathname(); 302 | if ($this->isFileIgnored($path)) { 303 | $files[] = $path; 304 | } 305 | } 306 | 307 | foreach ($files as $file) { 308 | $filename = $this->getRepositoryPath() . DIRECTORY_SEPARATOR . $file; 309 | if ($this->fs->exists($filename) || is_link($filename)) { 310 | $this->logger->debug(sprintf('Removing ignored file %s', $filename)); 311 | $this->fs->remove($filename); 312 | } 313 | } 314 | 315 | return $this; 316 | } 317 | 318 | /** 319 | * Remove 'other' files. 320 | * 321 | * 'Other' files are files that are neither staged nor tracked in git. 322 | */ 323 | public function removeOtherFiles(): static { 324 | $files = $this->extractFromCommand(['ls-files', '--other', '--exclude-standard']) ?: []; 325 | $files = array_filter($files); 326 | 327 | foreach ($files as $file) { 328 | $filename = $this->getRepositoryPath() . DIRECTORY_SEPARATOR . $file; 329 | if ($this->fs->exists($filename)) { 330 | $this->logger->debug(sprintf('Removing other file %s', $filename)); 331 | $this->fs->remove($filename); 332 | } 333 | } 334 | 335 | return $this; 336 | } 337 | 338 | /** 339 | * Remove any repositories within current repository. 340 | */ 341 | public function removeSubRepositories(): static { 342 | $finder = new Finder(); 343 | $dirs = $finder 344 | ->directories() 345 | ->name('.git') 346 | ->ignoreDotFiles(FALSE) 347 | ->ignoreVCS(FALSE) 348 | ->depth('>0') 349 | ->in($this->getRepositoryPath()); 350 | 351 | $dirs = iterator_to_array($dirs->directories()); 352 | 353 | foreach ($dirs as $dir) { 354 | $dir = $dir->getPathname(); 355 | $this->fs->remove($dir); 356 | $this->logger->debug(sprintf('Removing sub-repository "%s"', $this->fsGetAbsolutePath((string) $dir))); 357 | } 358 | 359 | // After removing sub-repositories, the files that were previously tracked 360 | // in those repositories are now become a part of the current repository. 361 | // We need to add them as changes. 362 | $this->addAllChanges(); 363 | 364 | return $this; 365 | } 366 | 367 | /** 368 | * Check if provided branch name can be used in Git. 369 | * 370 | * @param string $name 371 | * Branch name to check. 372 | * 373 | * @return bool 374 | * TRUE if it is a valid Git branch, FALSE otherwise. 375 | */ 376 | public static function isValidBranchName(string $name): bool { 377 | return preg_match('/^(?!\/|.*(?:[\/\.]\.|\/\/|\\|@\{))[^\040\177\s\~\^\:\?\*\[]+(?exists($uri); 400 | $is_external = (bool) preg_match('/^(?:git|ssh|https?|[\d\w\.\-_]+@[\w\.\-]+):(?:\/\/)?[\w\.@:\/~_-]+\.git(?:\/?|\#[\d\w\.\-_]+?)$/', $uri); 401 | 402 | return match ($type) { 403 | 'any' => $is_local || $is_external, 404 | 'local' => $is_local, 405 | 'external' => $is_external, 406 | default => throw new \InvalidArgumentException(sprintf('Invalid argument "%s" provided', $type)), 407 | }; 408 | } 409 | 410 | /** 411 | * Reset to the previous commit. 412 | */ 413 | public function resetToPreviousCommit(): static { 414 | $this->run('reset', '--soft', 'HEAD~1'); 415 | 416 | return $this; 417 | } 418 | 419 | /** 420 | * Replace .gitignore with content from custom .gitignore file. 421 | */ 422 | public function replaceGitignoreFromCustom(): static { 423 | if ($this->gitignoreCustom !== NULL && !empty($this->gitignoreCustom) && $this->gitignore !== NULL) { 424 | $this->logger->debug(sprintf('Copying custom .gitignore file from %s to %s', $this->gitignoreCustom, $this->gitignore)); 425 | $this->fs->rename($this->gitignoreCustom, $this->gitignore, TRUE); 426 | } 427 | 428 | return $this; 429 | } 430 | 431 | /** 432 | * Restore .gitignore content to custom .gitignore file if it existed. 433 | */ 434 | public function restoreGitignoreToCustom(): static { 435 | if ($this->gitignoreCustom !== NULL && $this->gitignore !== NULL && file_exists($this->gitignore)) { 436 | $this->logger->debug(sprintf('Restoring custom .gitignore file from %s to %s', $this->gitignore, $this->gitignoreCustom)); 437 | $this->fs->rename($this->gitignore, $this->gitignoreCustom, TRUE); 438 | } 439 | 440 | return $this; 441 | } 442 | 443 | /** 444 | * Unstage all changes. 445 | */ 446 | public function unstageAllChanges(): static { 447 | $this->run('reset', 'HEAD'); 448 | 449 | return $this; 450 | } 451 | 452 | /** 453 | * Check if file is ignored. 454 | * 455 | * @param string $file 456 | * File to check. 457 | * 458 | * @return bool 459 | * TRUE if file is ignored, FALSE otherwise. 460 | */ 461 | public function isFileIgnored(string $file): bool { 462 | try { 463 | $this->extractFromCommand(['check-ignore', '-v', $file]); 464 | } 465 | catch (GitException $exception) { 466 | if ($exception->getCode() === 1) { 467 | return FALSE; 468 | } 469 | 470 | throw $exception; 471 | } 472 | 473 | return TRUE; 474 | } 475 | 476 | } 477 | -------------------------------------------------------------------------------- /src/Traits/FilesystemTrait.php: -------------------------------------------------------------------------------- 1 | 33 | */ 34 | protected array $fsOriginalCwdStack = []; 35 | 36 | /** 37 | * Set root directory path. 38 | * 39 | * @param string|null $path 40 | * The path of the root directory. 41 | * 42 | * @return static 43 | * The called object. 44 | */ 45 | protected function fsSetRootDir(?string $path = NULL): static { 46 | $path = empty($path) ? $this->fsGetRootDir() : $this->fsGetAbsolutePath($path); 47 | $this->fsAssertPathsExist($path); 48 | $this->fsRootDir = $path; 49 | 50 | return $this; 51 | } 52 | 53 | /** 54 | * Get root directory. 55 | * 56 | * @return string 57 | * Get value of the root directory, the directory where the 58 | * script was started from or current working directory. 59 | */ 60 | protected function fsGetRootDir(): string { 61 | if (!isset($this->fsRootDir)) { 62 | if (isset($_SERVER['PWD']) && is_string($_SERVER['PWD']) && !empty($_SERVER['PWD'])) { 63 | $this->fsRootDir = $_SERVER['PWD']; 64 | } 65 | else { 66 | $this->fsRootDir = (string) getcwd(); 67 | } 68 | } 69 | 70 | return $this->fsRootDir; 71 | } 72 | 73 | /** 74 | * Check that a command is available in current session. 75 | * 76 | * @param string $command 77 | * Command to check. 78 | * 79 | * @return bool 80 | * TRUE if command is available, FALSE otherwise. 81 | */ 82 | protected function fsIsCommandAvailable(string $command): bool { 83 | $process = new Process(['which', $command]); 84 | $process->run(); 85 | 86 | return $process->isSuccessful(); 87 | } 88 | 89 | /** 90 | * Get absolute path for provided file. 91 | * 92 | * @param string $file 93 | * File to resolve. If absolute, no resolution will be performed. 94 | * @param string|null $root 95 | * Optional path to root dir. If not provided, internal root path is used. 96 | * 97 | * @return string 98 | * Absolute path for provided file. 99 | */ 100 | protected function fsGetAbsolutePath(string $file, ?string $root = NULL): string { 101 | if ($this->fs->isAbsolutePath($file)) { 102 | return static::fsRealpath($file); 103 | } 104 | 105 | $root = $root ? $root : $this->fsGetRootDir(); 106 | $root = static::fsRealpath($root); 107 | $file = $root . DIRECTORY_SEPARATOR . $file; 108 | 109 | return static::fsRealpath($file); 110 | } 111 | 112 | /** 113 | * Check that path exists. 114 | * 115 | * @param string|array $paths 116 | * File name or array of file names to check. 117 | * @param bool $strict 118 | * If TRUE and the file does not exist, an exception will be thrown. 119 | * Defaults to TRUE. 120 | * 121 | * @return bool 122 | * TRUE if file exists and FALSE if not, but only if $strict is FALSE. 123 | * 124 | * @throws \Exception 125 | * If at least one file does not exist. 126 | */ 127 | protected function fsAssertPathsExist($paths, bool $strict = TRUE): bool { 128 | $paths = is_array($paths) ? $paths : [$paths]; 129 | 130 | if (!$this->fs->exists($paths)) { 131 | if ($strict) { 132 | throw new \Exception(sprintf('One of the files or directories does not exist: %s', implode(', ', $paths))); 133 | } 134 | 135 | return FALSE; 136 | } 137 | 138 | return TRUE; 139 | } 140 | 141 | /** 142 | * Replacement for PHP's `realpath` resolves non-existing paths. 143 | * 144 | * The main deference is that it does not return FALSE on non-existing 145 | * paths. 146 | * 147 | * @param string $path 148 | * Path that needs to be resolved. 149 | * 150 | * @return string 151 | * Resolved path. 152 | * 153 | * @see https://stackoverflow.com/a/29372360/712666 154 | */ 155 | protected static function fsRealpath(string $path): string { 156 | // Whether $path is unix or not. 157 | $is_unix_path = $path === '' || $path[0] !== '/'; 158 | $unc = str_starts_with($path, '\\\\'); 159 | 160 | // Attempt to detect if path is relative in which case, add cwd. 161 | if (!str_contains($path, ':') && $is_unix_path && !$unc) { 162 | $path = getcwd() . DIRECTORY_SEPARATOR . $path; 163 | if ($path[0] === '/') { 164 | $is_unix_path = FALSE; 165 | } 166 | } 167 | 168 | // Resolve path parts (single dot, double dot and double delimiters). 169 | $path = str_replace(['/', '\\'], DIRECTORY_SEPARATOR, $path); 170 | $parts = array_filter(explode(DIRECTORY_SEPARATOR, $path), static function ($part): bool { 171 | return strlen($part) > 0; 172 | }); 173 | 174 | $absolutes = []; 175 | foreach ($parts as $part) { 176 | if ('.' === $part) { 177 | continue; 178 | } 179 | if ('..' === $part) { 180 | array_pop($absolutes); 181 | } 182 | else { 183 | $absolutes[] = $part; 184 | } 185 | } 186 | 187 | $path = implode(DIRECTORY_SEPARATOR, $absolutes); 188 | // Put initial separator that could have been lost. 189 | $path = $is_unix_path ? $path : '/' . $path; 190 | $path = $unc ? '\\\\' . $path : $path; 191 | 192 | // Resolve any symlinks. 193 | if (function_exists('readlink') && file_exists($path) && is_link($path) > 0) { 194 | $path = readlink($path); 195 | 196 | if (!$path) { 197 | // @codeCoverageIgnoreStart 198 | throw new \Exception(sprintf('Could not resolve symlink for path: %s', $path)); 199 | // @codeCoverageIgnoreEnd 200 | } 201 | } 202 | 203 | if (str_starts_with($path, sys_get_temp_dir())) { 204 | $tmp_realpath = realpath(sys_get_temp_dir()); 205 | if ($tmp_realpath) { 206 | $path = str_replace(sys_get_temp_dir(), $tmp_realpath, $path); 207 | } 208 | } 209 | 210 | return $path; 211 | } 212 | 213 | } 214 | -------------------------------------------------------------------------------- /src/Traits/LoggerTrait.php: -------------------------------------------------------------------------------- 1 | getOption('log')) { 42 | $output->setVerbosity(OutputInterface::VERBOSITY_DEBUG); 43 | } 44 | 45 | $this->loggerDumpFile = sys_get_temp_dir() . DIRECTORY_SEPARATOR . time() . '-artifact-log.log'; 46 | 47 | $this->logger = new Logger($name); 48 | 49 | $console_handler = new ConsoleHandler($output); 50 | $this->logger->pushHandler($console_handler); 51 | 52 | if (!empty($this->loggerDumpFile)) { 53 | $map = [ 54 | OutputInterface::VERBOSITY_QUIET => Level::Error, 55 | OutputInterface::VERBOSITY_NORMAL => Level::Warning, 56 | OutputInterface::VERBOSITY_VERBOSE => Level::Notice, 57 | OutputInterface::VERBOSITY_VERY_VERBOSE => Level::Info, 58 | OutputInterface::VERBOSITY_DEBUG => Level::Debug, 59 | ]; 60 | 61 | $stream_handler = new StreamHandler($this->loggerDumpFile, $map[$output->getVerbosity()] ?? Level::Debug); 62 | $this->logger->pushHandler($stream_handler); 63 | } 64 | 65 | $this->logger->debug('Debug messages enabled'); 66 | } 67 | 68 | /** 69 | * Dump logger to file. 70 | * 71 | * @param string $filename 72 | * Filename to dump the logger to. 73 | */ 74 | protected function loggerDump(string $filename): void { 75 | if ($this->fs->exists($this->loggerDumpFile)) { 76 | $this->fs->copy($this->loggerDumpFile, $filename); 77 | $this->fs->remove($this->loggerDumpFile); 78 | } 79 | } 80 | 81 | } 82 | -------------------------------------------------------------------------------- /src/Traits/TokenTrait.php: -------------------------------------------------------------------------------- 1 | $method($argument); 37 | } 38 | } 39 | } 40 | 41 | return $replacement; 42 | }, $string); 43 | 44 | return $processed ?? $string; 45 | } 46 | 47 | /** 48 | * Check if the string has at least one token. 49 | * 50 | * @param string $string 51 | * String to check. 52 | * 53 | * @return bool 54 | * TRUE if there is at least one token present, FALSE otherwise. 55 | */ 56 | protected static function tokenExists(string $string): bool { 57 | return (bool) preg_match('/\[[^]]+]/', $string); 58 | } 59 | 60 | } 61 | -------------------------------------------------------------------------------- /src/app.php: -------------------------------------------------------------------------------- 1 | add($command); 18 | $application->setDefaultCommand((string) $command->getName(), TRUE); 19 | 20 | $application->run(); 21 | // @codeCoverageIgnoreEnd 22 | --------------------------------------------------------------------------------