├── .github └── workflows │ └── build.yml ├── .gitignore ├── Dockerfile ├── LICENSE ├── Makefile ├── README.md ├── doc └── README.md ├── go.mod └── main.go /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: build 2 | 3 | on: 4 | release: 5 | types: [created] 6 | 7 | jobs: 8 | build-go-binary: 9 | runs-on: ubuntu-latest 10 | strategy: 11 | matrix: 12 | goos: [linux, windows, darwin] 13 | goarch: [amd64, arm64] 14 | exclude: 15 | - goarch: arm64 16 | goos: windows 17 | steps: 18 | - uses: actions/checkout@v3 19 | - uses: wangyoucao577/go-release-action@v1.30 20 | with: 21 | github_token: ${{ secrets.GITHUB_TOKEN }} 22 | goos: ${{ matrix.goos }} 23 | goarch: ${{ matrix.goarch }} 24 | goversion: 1.18 25 | binary_name: "hello" 26 | extra_files: LICENSE README.md 27 | 28 | build-docker-image: 29 | runs-on: ubuntu-latest 30 | steps: 31 | - uses: actions/checkout@v3 32 | - uses: docker/metadata-action@v4 33 | id: meta 34 | with: 35 | images: leslieleung/hello 36 | - uses: actions/setup-go@v3 37 | with: 38 | go-version: 1.18 39 | - uses: docker/setup-qemu-action@v2 40 | - uses: docker/setup-buildx-action@v2 41 | - uses: docker/login-action@v2 42 | with: 43 | username: ${{ secrets.DOCKERHUB_USERNAME }} 44 | password: ${{ secrets.DOCKERHUB_PASSWORD }} 45 | - run: go install github.com/mitchellh/gox@latest # setup gox 46 | - run: make gox-linux 47 | - uses: docker/build-push-action@v3 48 | with: 49 | context: . 50 | platforms: linux/arm64,linux/amd64 51 | push: true 52 | tags: ${{ steps.meta.outputs.tags }} 53 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .idea 2 | build 3 | dist/ 4 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM alpine:3.15.5 2 | ARG TARGETOS 3 | ARG TARGETARCH 4 | COPY build/hello_${TARGETOS}_${TARGETARCH} /usr/local/bin/hello 5 | RUN chmod +x /usr/local/bin/hello 6 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | all: build-darwin-amd64 build-darwin-arm64 build-linux-amd64 build-linux-arm64 build-windows-amd64 2 | 3 | build-darwin-amd64: 4 | mkdir -p build 5 | CGO_ENABLED=0 GOOS=darwin GOARCH=amd64 go build -o build/hello_darwin_amd64 main.go 6 | 7 | build-darwin-arm64: 8 | mkdir -p build 9 | CGO_ENABLED=0 GOOS=darwin GOARCH=arm64 go build -o build/hello_darwin_arm64 main.go 10 | 11 | build-linux-amd64: 12 | mkdir -p build 13 | CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o build/hello_linux_amd64 main.go 14 | 15 | build-linux-arm64: 16 | mkdir -p build 17 | CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build -o build/hello_linux_arm64 main.go 18 | 19 | build-windows-amd64: 20 | mkdir -p build 21 | CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -o build/hello_windows_amd64.exe main.go 22 | 23 | build-docker-image: 24 | docker buildx build --platform linux/amd64,linux/arm64 -t leslieleung/hello . --push 25 | 26 | gox-linux: 27 | gox -osarch="linux/amd64 linux/arm64" -output="build/hello_{{.OS}}_{{.Arch}}" 28 | 29 | gox-all: 30 | gox -osarch="darwin/amd64 darwin/arm64 linux/amd64 linux/arm64 windows/amd64" -output="build/hello_{{.OS}}_{{.Arch}}" 31 | 32 | clean: 33 | rm -f build/hello_* -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # go-multiplatform-docker 2 | 3 | [![build](https://github.com/LeslieLeung/go-multiplatform-docker/actions/workflows/build.yml/badge.svg)](https://github.com/LeslieLeung/go-multiplatform-docker/actions/workflows/build.yml) 4 | 5 | English | [简体中文](doc/README.md) 6 | 7 | > For a updated version that uses GoReleaser, you should checkout [LeslieLeung/gin-application-template](https://github.com/LeslieLeung/gin-application-template). 8 | 9 | A demo on how to build go multiplatform binaries and publish to release and DockerHub with GitHub Actions. 10 | 11 | ## Why this exists? 12 | 13 | As a software developer, it is not necessary to spend a lot of time repeating the same labor. This should be a high-level automation process. 14 | In the process of releasing software, there are some points that could be a pain in the ass: 15 | 16 | - build binaries for multiple OSs and architectures 17 | - might have to build a suitable build environment for cross-platform compiling 18 | - complicated release procedures 19 | 20 | Sure, some of these inconveniences have been eliminated 21 | 22 | - Golang supports cross-platform compiling out-of-the-box 23 | - use Docker or VM 24 | - use scripts 25 | 26 | However, it's not "automatic" enough. Using GitHub Actions, it can gracefully solve these problems, making developers more focus on the actual development. 27 | 28 | ## Prerequisites 29 | 30 | This passage assumes you are familiar with Golang,git and Docker, and know a little about GitHub Actions. 31 | 32 | ## Let's begin! 33 | 34 | There are two goals in this passage 35 | 36 | - Build multiplatform binaries for a Golang Program and release it to GitHub Releases 37 | - Build multiplatform binaries for a Golang Program and release it to DockerHub 38 | 39 | ### Writing a simple Golang program 40 | 41 | The Golang program is just for testing on different OSs and architectures, so a very simple program should do the trick. We will use a Hello World here. 42 | 43 | ```go 44 | package main 45 | 46 | import "fmt" 47 | 48 | func main() { 49 | fmt.Println("Hello, World!") 50 | } 51 | ``` 52 | 53 | Run it in the terminal, and you will see the following. 54 | 55 | ```bash 56 | > go run main.go 57 | Hello, World! 58 | ``` 59 | 60 | Looking good, now let's build an executable binary. 61 | 62 | ```bash 63 | > go build -o hello main.go 64 | 65 | ``` 66 | 67 | This command outputs nothing, means it ran successfully without any errors. In the world of command lines, no news is good news. 68 | 69 | We shall see a `hello` executable file under current directory（In Windows, it might look like `hello.exe`）。Let's run it. 70 | 71 | ```bash 72 | > ./hello 73 | Hello, World! 74 | ``` 75 | 76 | Great, it has the same result as `go run main.go`. 77 | 78 | > ### Takeaways： 79 | > Using `go build`, you can build an executable binary for a Golang program. 80 | 81 | ### Building multiplatform binary executables 82 | 83 | Remember that on Windows, `go build` would produce a `.exe` file? It's worth mentioning that Golang's support for multiplatform compiling ability. 84 | It can produce binary executables for different platforms without any extra efforts. 85 | 86 | Assuming you are using macOS for development, you can build a binary executable for Windows with the following command 87 | 88 | ```bash 89 | > CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -o hello_windows_amd64.exe main.go 90 | 91 | ``` 92 | 93 | There would be a `hello_windows_amd64.exe` file under current directory, copy it to a Windows machine a run it. 94 | 95 | ### Build multiplatform binaries for a Golang Program and release it to GitHub Releases 96 | 97 | Before you start, you might have a look at this repo's [Releases](https://github.com/LeslieLeung/go-multiplatform-docker/releases) 98 | 99 | ![](http://img.ameow.xyz/20220724180813.png) 100 | 101 | You might find for each target platform, there is a corresponding `tar.gz` or `zip` file with a `md5` checksum. Inside the compressed file, there is a binary executable file, `LISENCE` and `README.md`. 102 | 103 | This is quite simple with GitHub Actions, an action would do all the trick. See [wangyoucao577/go-release-action](https://github.com/wangyoucao577/go-release-action) . 104 | 105 | It's really easy to use. 106 | 107 | ```yaml 108 | name: build 109 | 110 | on: 111 | release: 112 | types: [created] # trigger when a release is created 113 | 114 | jobs: 115 | build-go-binary: 116 | runs-on: ubuntu-latest 117 | strategy: 118 | matrix: 119 | goos: [linux, windows, darwin] # the required OSs 120 | goarch: [amd64, arm64] # the required architectures 121 | exclude: # exclude some OSs and architectures 122 | - goarch: arm64 123 | goos: windows 124 | steps: 125 | - uses: actions/checkout@v3 126 | - uses: wangyoucao577/go-release-action@v1.30 127 | with: 128 | github_token: ${{ secrets.GITHUB_TOKEN }} # a pre-defined secret to add files to Release 129 | goos: ${{ matrix.goos }} 130 | goarch: ${{ matrix.goarch }} 131 | goversion: 1.18 # the required Go version 132 | binary_name: "hello" # the name of the binary executable 133 | extra_files: LICENSE README.md # the extra files to add to the release 134 | ``` 135 | 136 | When you finish writing a version and ready to release, all you have to do is to tag the commit, say `v0.0.2`, the push it to GitHub. 137 | In `Releases` page, click `Draft a new release`, choose the tag, then click on `Publish release` in the bottom. 138 | 139 | Then we can dive into `Actions` page, we should see a `workflow` running. When it's done, go back to `Releases` , and there is your release files. 140 | 141 | > ### Takeaway： 142 | > With GitHub Actions, you can automate compiling, packaging and releasing binary executables to Release. 143 | 144 | ### Build multiplatform binaries for a Golang Program and release it to DockerHub 145 | 146 | As mentioned before, the easiest way to run a Golang program is to compile it to a binary executable file, then run it. 147 | This doesn't even need a Golang environment on the actual machine. 148 | 149 | Therefore, if you are to pack a Golang program into a Docker image, you only need a minimal Linux system and copy the binary executable into it. 150 | 151 | With that in mind, we should be able to write this Dockerfile. 152 | 153 | ```dockerfile 154 | FROM alpine:3.15.5 155 | COPY hello /usr/local/bin/hello 156 | RUN chmod +x /usr/local/bin/hello 157 | ``` 158 | 159 | We should validate our idea. (Notice: The following code only works on Linux. On macOS and Windows it would not run for the 160 | compiled binary doesn't match the Docker image's target system and architecture.) 161 | 162 | ```bash 163 | > docker build -t hello . 164 | ...(a lot of logs) 165 | > docker run -it --rm hello 166 | > hello 167 | Hello, world! 168 | ``` 169 | 170 | There it goes! (Or you might fail if you didn't bother to look at the notice before.) 171 | 172 | Success or not, you should learn that we should just compile binary executables for different platforms, and then we can build the 173 | corresponding Docker images. 174 | 175 | #### Makefile Magic 176 | 177 | As is mentioned earlier, a `go build` with arguments can produce binary executables for different platforms. But we might have various platforms and 178 | architectures, that's where `Makefile` comes into play. 179 | 180 | Let's write a simple `Makefile` assigning different commands to build different platforms. Considering that we only need 181 | `linux/amd64` and `linux/arm64` for our Docker image, we only need the following lines. 182 | If you need a makefile that can run locally and build all the possible platforms, you can refer to the `Makefile` in this repo. 183 | 184 | ```makefile 185 | all: build-linux-amd64 build-linux-arm64 186 | 187 | build-linux-amd64: 188 | mkdir -p build 189 | CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o build/hello_linux_amd64 main.go 190 | 191 | build-linux-arm64: 192 | mkdir -p build 193 | CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build -o build/hello_linux_arm64 main.go 194 | ``` 195 | 196 | It's worth mentioning that the fist rule `all` is the default rule. When you run `make`, it will run the targets it assigned. 197 | `mkdir -p build` ensures that the output directory exists. 198 | 199 | If you use macOS or Linux, you can try running `make`, it would create a `build` directory and put the binary executables into it. 200 | 201 | #### Environment Variables in Dockerfile 202 | 203 | If you failed in the former test, it is because that the wrong binary executable was packaged into the docker file. Therefore, 204 | our dockerfile should know which version of binary executable it should grab. 205 | 206 | You might find in the previous Makefile, I used different suffixes for different platforms and architectures, like `hello_linux_amd64`. 207 | Now, we should make Dockerfile grab the correct binary executable judging from its target platform and architecture. 208 | 209 | Let's modify the former Dockerfile to make it look like this. 210 | 211 | ```dockerfile 212 | FROM alpine:3.15.5 213 | ARG TARGETOS 214 | ARG TARGETARCH 215 | COPY build/hello_${TARGETOS}_${TARGETARCH} /usr/local/bin/hello 216 | RUN chmod +x /usr/local/bin/hello 217 | ``` 218 | 219 | `TARGETOS` and `TARGETARCH` is Automatic platform ARGs, but you have to use the `ARG` command to claim that you need them. 220 | With `COPY`, we copied the corresponding binary executable to /usr/local/bin and gave it executes permission. So user can run our program with `hello`. 221 | 222 | If you failed in the former test, you might try it now. 223 | 224 | #### Writing GitHub Actions 225 | 226 | To this point, we've cleared all the hurdles, but we still have to write a GitHub Actions workflow to automate the process. 227 | 228 | There is no need to create a new Action, we can just add a job to the former one. 229 | 230 | ```yaml 231 | build-docker-image: 232 | runs-on: ubuntu-latest 233 | steps: 234 | - uses: actions/checkout@v3 235 | - uses: docker/metadata-action@v4 236 | id: meta 237 | with: 238 | images: leslieleung/hello 239 | - uses: actions/setup-go@v3 240 | with: 241 | go-version: 1.18 242 | - uses: docker/setup-qemu-action@v2 243 | - uses: docker/setup-buildx-action@v2 244 | - uses: docker/login-action@v2 245 | with: 246 | username: ${{ secrets.DOCKERHUB_USERNAME }} # REMEMBER to add the secret in secrets 247 | password: ${{ secrets.DOCKERHUB_PASSWORD }} 248 | - run: make 249 | - uses: docker/build-push-action@v3 250 | with: 251 | context: . 252 | platforms: linux/arm64,linux/amd64 # required platforms 253 | push: true 254 | tags: ${{ steps.meta.outputs.tags }} 255 | ``` 256 | 257 | Release a version as mentioned before, then you can see your images on Dockerhub. You shall see `linux/amd64` and `linux/arm64`. 258 | 259 | ![](http://img.ameow.xyz/20220724185319.png) 260 | 261 | There you go, well done! 262 | 263 | ## Other good stuffs 264 | 265 | According to the replies on my post on v2ex (see [关于 Golang 多平台打包发布这件事..](https://v2ex.com/t/868435) ), there are two 266 | other solutions. 267 | 268 | - [GoReleaser](https://goreleaser.com/) : Provides the ability to compile cross-platform and build Docker images. Super cool tool with a free and a paid Pro version. 269 | - [gox](https://github.com/mitchellh/gox) : Provides the ability to compile cross-platform in parallel. 270 | 271 | gox can provide us a parallel compile, so let's look into it here. 272 | 273 | ### Accelerate your release with gox 274 | 275 | Upon checking out gox's documentation, it's quite easy-to-use. Let's add the following lines to the Makefile. 276 | 277 | ```makefile 278 | gox-linux: 279 | gox -osarch="linux/amd64 linux/arm64" -output="build/hello_{{.OS}}_{{.Arch}}" 280 | 281 | gox-all: 282 | gox -osarch="darwin/amd64 darwin/arm64 linux/amd64 linux/arm64 windows/amd64" -output="build/hello_{{.OS}}_{{.Arch}}" 283 | ``` 284 | 285 | Now, run `make gox-linux` or `make gox-all` should do all the magic. 286 | 287 | Also, we have to modify our `build.yml`. 288 | 289 | ```yaml 290 | build-docker-image: 291 | runs-on: ubuntu-latest 292 | steps: 293 | - uses: actions/checkout@v3 294 | - uses: docker/metadata-action@v4 295 | id: meta 296 | with: 297 | images: leslieleung/hello 298 | - uses: actions/setup-go@v3 299 | with: 300 | go-version: 1.18 301 | - uses: docker/setup-qemu-action@v2 302 | - uses: docker/setup-buildx-action@v2 303 | - uses: docker/login-action@v2 304 | with: 305 | username: ${{ secrets.DOCKERHUB_USERNAME }} 306 | password: ${{ secrets.DOCKERHUB_PASSWORD }} 307 | - run: go install github.com/mitchellh/gox@latest # setup gox 308 | - run: make gox-linux 309 | - uses: docker/build-push-action@v3 310 | with: 311 | context: . 312 | platforms: linux/arm64,linux/amd64 313 | push: true 314 | tags: ${{ steps.meta.outputs.tags }} 315 | ``` 316 | 317 | ## FAQ 318 | 319 | ### Failed to publish to Release due to permission issue 320 | 321 | See [link](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)。 322 | 323 | Solution: add the following to `build.yml` . 324 | 325 | ```yaml 326 | name: build 327 | 328 | on: 329 | release: 330 | types: [created] 331 | 332 | permissions: # ADD ME 333 | contents: write # ADD ME 334 | 335 | jobs: 336 | build-go-binary: 337 | runs-on: ubuntu-latest 338 | ... 339 | ``` 340 | 341 | ## References 342 | 343 | [GitHub Action - Build and push Docker images](https://github.com/marketplace/actions/build-and-push-docker-images) 344 | 345 | [GNU make](https://www.gnu.org/software/make/manual/make.html) 346 | 347 | [Dockerfile reference](https://docs.docker.com/engine/reference/builder/#arg) 348 | 349 | [wangyoucao577/go-release-action](https://github.com/wangyoucao577/go-release-action) 350 | -------------------------------------------------------------------------------- /doc/README.md: -------------------------------------------------------------------------------- 1 | # go-multiplatform-docker 2 | 3 | [![build](https://github.com/LeslieLeung/go-multiplatform-docker/actions/workflows/build.yml/badge.svg)](https://github.com/LeslieLeung/go-multiplatform-docker/actions/workflows/build.yml) 4 | 5 | [English](README.md) | 简体中文 6 | 7 | > 如果要使用 GoReleaser 进行发布，建议查看新版 [LeslieLeung/gin-application-template](https://github.com/LeslieLeung/gin-application-template)。 8 | 9 | 一个演示如何使用 GitHub Actions 将一个 Golang 项目打包成多平台的二进制文件并发布到 GitHub Releases 和 DockerHub 的例子。 10 | 11 | ## 由来 12 | 13 | 作为软件开发者，在软件发布上浪费大量重复劳动是极其没有必要的，这应该是一个高度自动化的过程。在发布软件的过程中，有以下几个痛点： 14 | 15 | - 构建多个系统和架构的二进制文件 16 | - 跨平台编译时，可能需要搭建适当的编译环境 17 | - 发布过程繁琐 18 | 19 | 当然了，这些痛点或多或少已经被解决 20 | 21 | - Golang 本身就支持跨平台的编译 22 | - 使用 Docker 或虚拟机等 23 | - 编写发布脚本等 24 | 25 | 然而，这样还不够"自动化"，如果使用 GitHub Actions 来自动化发布过程，就能更优雅地解决这些问题，使软件开发者更加专注于软件的开发上。 26 | 27 | ## 前提 28 | 29 | 本文假设你已经熟悉 Golang、git 和 Docker， 并对 GitHub Actions 有一定了解。 30 | 31 | ## 让我们开始吧 32 | 33 | 这篇文章共有两个目标，分别是 34 | 35 | - 将一个 Golang 项目打包成多平台的二进制文件并发布到 GitHub Releases 36 | - 将一个 Golang 项目打包成多平台的二进制文件并发布到 DockerHub 37 | 38 | ### 编写一个简单的 Golang 程序 39 | 40 | 我们只是为了测试在不同系统和架构上二进制文件的执行，所以一个非常简单的 Golang 程序即可。我们这里就用一个最简单的 Hello World 吧。 41 | 42 | ```go 43 | package main 44 | 45 | import "fmt" 46 | 47 | func main() { 48 | fmt.Println("Hello, World!") 49 | } 50 | ``` 51 | 52 | 在终端中运行一下，结果如下。 53 | 54 | ```bash 55 | > go run main.go 56 | Hello, World! 57 | ``` 58 | 59 | 看起来不错，接下来让我们把这个 Golang 程序打包成一个二进制可执行文件。 60 | 61 | ```bash 62 | > go build -o hello main.go 63 | 64 | ``` 65 | 66 | 这个命令什么输出都没有，说明运行成功了，没有错误。对于命令行来说，没有消息就是好消息。 67 | 68 | 在当前目录下，可以看到一个名为 `hello` 的可执行文件（在 Windows 中，该文件可能名为 `hello.exe`）。我们运行一下。 69 | 70 | ```bash 71 | > ./hello 72 | Hello, World! 73 | ``` 74 | 75 | 不错，跟我们之前使用 `go run main.go` 的结果是一样的。 76 | 77 | > ### 快速回顾： 78 | > 使用 `go build` 命令可以将一个 Golang 程序打包成二进制可执行文件。 79 | 80 | ### 编译跨平台二进制可执行文件 81 | 82 | 还记得前面提到，在 Windows 平台上，`go build` 命令会生成一个以 `.exe` 结尾的可执行文件，这就不得不提 Golang 的跨平台编译能力。Golang 能轻松地生成不同平台上的二进制可执行文件，不需要开发者了解任何跨平台编译方面的细节。 83 | 84 | 假设我们正在使用 macOS 进行开发，如果我们需要编译一个可以在 Windows 平台上运行的二进制可执行文件，我们只需要运行 85 | 86 | ```bash 87 | > CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -o hello_windows_amd64.exe main.go 88 | 89 | ``` 90 | 91 | 目录下就会生成一个 `hello_windows_amd64.exe` 文件，复制到 Windows 下运行即可。 92 | 93 | ### 编译多平台二进制可执行文件并打包发布到 GitHub Releases 94 | 95 | 在开始之前，你可以看一下本项目的 [Releases](https://github.com/LeslieLeung/go-multiplatform-docker/releases) 96 | 97 | ![](http://img.ameow.xyz/20220724180813.png) 98 | 99 | 可以看到，对于每个目标平台，都有一个对应的 `tar.gz` 或 `zip` 压缩包，及其对应的 `md5` 校验码。压缩包中含有二进制可执行文件以及 `LISENCE` 和 `README.md` 文件。 100 | 101 | 这一步的实现非常简单，已经有现成的 Actions 替我们搞定。见 [wangyoucao577/go-release-action](https://github.com/wangyoucao577/go-release-action) 。 102 | 103 | 它的用法非常简单，如下。 104 | 105 | ```yaml 106 | name: build 107 | 108 | on: 109 | release: 110 | types: [created] # 表示在创建新的 Release 时触发 111 | 112 | jobs: 113 | build-go-binary: 114 | runs-on: ubuntu-latest 115 | strategy: 116 | matrix: 117 | goos: [linux, windows, darwin] # 需要打包的系统 118 | goarch: [amd64, arm64] # 需要打包的架构 119 | exclude: # 排除某些平台和架构 120 | - goarch: arm64 121 | goos: windows 122 | steps: 123 | - uses: actions/checkout@v3 124 | - uses: wangyoucao577/go-release-action@v1.30 125 | with: 126 | github_token: ${{ secrets.GITHUB_TOKEN }} # 一个默认的变量，用来实现往 Release 中添加文件 127 | goos: ${{ matrix.goos }} 128 | goarch: ${{ matrix.goarch }} 129 | goversion: 1.18 # 可以指定编译使用的 Golang 版本 130 | binary_name: "hello" # 可以指定二进制文件的名称 131 | extra_files: LICENSE README.md # 需要包含的额外文件 132 | ``` 133 | 134 | 当你完成一个版本代码的编写，准备要发布时，只需要在 git 中对该提交打上版本号，如 `v0.0.2`，然后提交至 GitHub。在 `Releases` 页面，点击 `Draft a new release`，选择刚才的标签，点击最底下的 `Publish release` 按钮即可。 135 | 136 | 然后我们可以进入 `Actions` 页面，应该可以看见已经有 `workflow` 正在运行。完成后，再回到 `Releases` 页面，就可以看到打包出的文件。 137 | 138 | > ### 快速回顾： 139 | > 使用 GitHub Actions 可以自动化编译、打包并将二进制可执行文件发布到 Release。 140 | 141 | ### 编译多平台二进制可执行文件并打包发布到 DockerHub 142 | 143 | 前面提到过，运行一个 Golang 程序最简单的方法就是将其编译成二进制可执行文件后，直接运行。这一步甚至不需要考虑实际运行的机器上是否有 Go 环境。 144 | 145 | 因此，如果要把 Golang 程序打包进一个 Docker 镜像，只需要一个最小的 Linux 系统，把这个二进制文件打包进去即可。 146 | 147 | 知道这个以后，我们很顺其自然就可以编写出以下 Dockerfile。 148 | 149 | ```dockerfile 150 | FROM alpine:3.15.5 151 | COPY hello /usr/local/bin/hello 152 | RUN chmod +x /usr/local/bin/hello 153 | ``` 154 | 155 | 简单验证一下我们的想法。（注意：以下代码仅能在 Linux 下运行，在 macOS 和 Windows 上会因为编译出的二进制文件与 Docker 的运行环境不匹配而不能运行。） 156 | 157 | ```bash 158 | > docker build -t hello . 159 | ...(输出大量的日志) 160 | > docker run -it --rm hello 161 | > hello 162 | Hello, world! 163 | ``` 164 | 165 | 成功了！（或者失败了，因为你没看我前面的注意） 166 | 167 | 不管到这一步你是成功还是失败，你应该已经想到，只需要编译出不同平台上的二进制可执行文件，再构建对应平台的 Docker 镜像就好了。 168 | 169 | #### Makefile 魔法 170 | 171 | 前面讲过，我们使用带参数的 `go build` 命令就可以生成在不同平台下的二进制可执行文件。但是我们可能有多个平台和架构，这时候 `Makefile` 就派上用场了。 172 | 173 | 我们编写一个简单的 `Makefile` ，里面指定了编译不同平台和架构使用的命令。考虑到我们的 Docker 镜像只需要 `linux/amd64` 和 `linux/arm64` 两个平台，所以我们只需要编写下面的两行命令。 174 | 当然，如果你需要一个可以本地使用，能直接编译所有平台的二进制可执行文件的 makefile ，可以参考仓库中的 `Makefile` 文件。 175 | 176 | ```makefile 177 | all: build-linux-amd64 build-linux-arm64 178 | 179 | build-linux-amd64: 180 | mkdir -p build 181 | CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o build/hello_linux_amd64 main.go 182 | 183 | build-linux-arm64: 184 | mkdir -p build 185 | CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build -o build/hello_linux_arm64 main.go 186 | ``` 187 | 188 | 需要注意的是，第一条规则 `all` 为默认的规则，执行 `make` 时就执行它指定的目标。`mkdir -p build` 保证了输出目录一定存在。 189 | 190 | 如果你使用 macOS 或者 Linux 系统，可以试着运行 `make` 命令，它会在当前目录下创建一个 `build` 文件夹，并将生成的二进制可执行文件都放在里面。 191 | 192 | #### Dockerfile 中的环境变量 193 | 194 | 前面提到过，如果你在前面的小试验中失败了，是因为 Docker 镜像中打包进了错误的二进制可执行文件。因此我们需要控制打包进镜像的二进制可执行文件的版本。 195 | 196 | 在上一步的 Makefile 中，可能你已经发现，我使用了后缀来区分不同平台和架构的二进制可执行文件，例如 `hello_linux_amd64` 。 197 | 在这一步中，我们需要让 Dockerfile 通过打包镜像的平台和架构，自动选择合适的二进制可执行文件。 198 | 199 | 我们修改一下之前的 Dockerfile， 使他变成以下的样子。 200 | 201 | ```dockerfile 202 | FROM alpine:3.15.5 203 | ARG TARGETOS 204 | ARG TARGETARCH 205 | COPY build/hello_${TARGETOS}_${TARGETARCH} /usr/local/bin/hello 206 | RUN chmod +x /usr/local/bin/hello 207 | ``` 208 | 209 | `TARGETOS` 和 `TARGETARCH` 是自带的自动变量，但你需要使用 `ARG` 命令来说明你需要这两个变量。 210 | 在 `COPY` 命令中，可以看到我们把对应平台和架构的二进制可执行文件拷贝到了 /usr/local/bin 目录下并给了它可执行权限，因此用户直接输入 `hello` 就能运行我们的程序。 211 | 212 | 如果你在上一次小试验没有成功，现在可以重新试一下了。 213 | 214 | #### 编写 GitHub Actions 215 | 216 | 至此，所有的障碍我们都已经解决了，剩下就是编写一个可以自动完成上面流程的 GitHub Actions。 217 | 218 | 我们不需要新建一个 Action， 只需要在之前的 Action 上新增一个作业（job）即可。 219 | 220 | ```yaml 221 | build-docker-image: 222 | runs-on: ubuntu-latest 223 | steps: 224 | - uses: actions/checkout@v3 225 | - uses: docker/metadata-action@v4 226 | id: meta 227 | with: 228 | images: leslieleung/hello 229 | - uses: actions/setup-go@v3 230 | with: 231 | go-version: 1.18 232 | - uses: docker/setup-qemu-action@v2 233 | - uses: docker/setup-buildx-action@v2 234 | - uses: docker/login-action@v2 235 | with: 236 | username: ${{ secrets.DOCKERHUB_USERNAME }} # 记得在 secrets 中添加响应的 secret 237 | password: ${{ secrets.DOCKERHUB_PASSWORD }} 238 | - run: make 239 | - uses: docker/build-push-action@v3 240 | with: 241 | context: . 242 | platforms: linux/arm64,linux/amd64 # 需要的平台 243 | push: true 244 | tags: ${{ steps.meta.outputs.tags }} 245 | ``` 246 | 247 | 像前面一样发布一个新的版本，然后在 Dockerhub 上就能看到刚才构建的镜像了。可以看到有 `linux/amd64` 和 `linux/arm64` 两个平台。 248 | 249 | ![](http://img.ameow.xyz/20220724185319.png) 250 | 251 | 大功告成！ 252 | 253 | ## 番外 254 | 255 | 经过 v2ex 论坛上的朋友提醒（见原帖 [关于 Golang 多平台打包发布这件事..](https://v2ex.com/t/868435) ），另外还有两种方法供参考。 256 | 257 | - [GoReleaser](https://goreleaser.com/)：能够提供跨平台编译及打包 Docker 镜像、发布等，非常强大的工具。有免费和付费的 Pro 版本。 258 | - [gox](https://github.com/mitchellh/gox)：能够并行编译。 259 | 260 | 由于 gox 具有并行编译的特性，这里增加一下关于 gox 的介绍。 261 | 262 | ### 使用 gox 加速发布过程 263 | 264 | 通过查看 gox 的文档可以发现， gox 的命令非常简单。我们往前面的 Makefile 中添加以下几行。 265 | 266 | ```makefile 267 | gox-linux: 268 | gox -osarch="linux/amd64 linux/arm64" -output="build/hello_{{.OS}}_{{.Arch}}" 269 | 270 | gox-all: 271 | gox -osarch="darwin/amd64 darwin/arm64 linux/amd64 linux/arm64 windows/amd64" -output="build/hello_{{.OS}}_{{.Arch}}" 272 | ``` 273 | 274 | 此时，运行 `make gox-linux` 或 `make gox-all` 就能完成对应平台的编译了。 275 | 276 | 同时修改一下 `build.yml`。 277 | 278 | ```yaml 279 | build-docker-image: 280 | runs-on: ubuntu-latest 281 | steps: 282 | - uses: actions/checkout@v3 283 | - uses: docker/metadata-action@v4 284 | id: meta 285 | with: 286 | images: leslieleung/hello 287 | - uses: actions/setup-go@v3 288 | with: 289 | go-version: 1.18 290 | - uses: docker/setup-qemu-action@v2 291 | - uses: docker/setup-buildx-action@v2 292 | - uses: docker/login-action@v2 293 | with: 294 | username: ${{ secrets.DOCKERHUB_USERNAME }} 295 | password: ${{ secrets.DOCKERHUB_PASSWORD }} 296 | - run: go install github.com/mitchellh/gox@latest # 安装 gox 297 | - run: make gox-linux 298 | - uses: docker/build-push-action@v3 299 | with: 300 | context: . 301 | platforms: linux/arm64,linux/amd64 302 | push: true 303 | tags: ${{ steps.meta.outputs.tags }} 304 | ``` 305 | 306 | ## 常见问题 307 | 308 | ### 权限不足，发布到 Release 失败 309 | 310 | 原因见 [链接](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)。 311 | 312 | 解决方法：在 `build.yml` 中添加以下内容。 313 | 314 | ```yaml 315 | name: build 316 | 317 | on: 318 | release: 319 | types: [created] 320 | 321 | permissions: # 添加 322 | contents: write # 添加 323 | 324 | jobs: 325 | build-go-binary: 326 | runs-on: ubuntu-latest 327 | ... 328 | ``` 329 | 330 | ## 参考 331 | 332 | [GitHub Action - Build and push Docker images](https://github.com/marketplace/actions/build-and-push-docker-images) 333 | 334 | [GNU make](https://www.gnu.org/software/make/manual/make.html) 335 | 336 | [Dockerfile reference](https://docs.docker.com/engine/reference/builder/#arg) 337 | 338 | [wangyoucao577/go-release-action](https://github.com/wangyoucao577/go-release-action) 339 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module go-multiplatform-docker 2 | 3 | go 1.18 4 | -------------------------------------------------------------------------------- /main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import "fmt" 4 | 5 | func main() { 6 | fmt.Println("Hello, World!") 7 | } 8 | --------------------------------------------------------------------------------