├── .editorconfig ├── .github └── workflows │ ├── release.yml │ └── test.yml ├── .gitignore ├── .prettierrc ├── .tool-versions ├── LICENSE ├── Makefile ├── README.md ├── action.Dockerfile ├── action.yml ├── catalog-info.yaml ├── compose.test.yaml ├── compose.yaml ├── docs └── preview.png ├── package-lock.json ├── package.json ├── src ├── app.js └── webhooks.js └── tests ├── __snapshots__ └── webhooks.test.js.snap ├── main.test.js ├── mocks ├── github_webhook_full.json └── github_webhook_no_commits.json └── webhooks.test.js /.editorconfig: -------------------------------------------------------------------------------- 1 | [*] 2 | indent_size = 2 -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: Release 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | 8 | jobs: 9 | release: 10 | runs-on: ubuntu-latest 11 | permissions: 12 | contents: write 13 | pull-requests: write 14 | steps: 15 | - uses: actions/checkout@v4 16 | 17 | - uses: asdf-vm/actions/install@v3 18 | 19 | - run: make install 20 | 21 | - run: make test 22 | 23 | - run: make version 24 | 25 | - run: make release 26 | env: 27 | CONVENTIONAL_GITHUB_RELEASER_TOKEN: ${{ secrets.GITHUB_TOKEN }} 28 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: Test 2 | 3 | on: [push] 4 | 5 | jobs: 6 | test: 7 | runs-on: ubuntu-latest 8 | steps: 9 | - uses: actions/checkout@v4 10 | with: 11 | fetch-depth: 0 12 | 13 | - uses: asdf-vm/actions/install@v3 14 | 15 | - run: make install 16 | 17 | - run: make test 18 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules/ -------------------------------------------------------------------------------- /.prettierrc: -------------------------------------------------------------------------------- 1 | {} 2 | -------------------------------------------------------------------------------- /.tool-versions: -------------------------------------------------------------------------------- 1 | nodejs 20.19.0 2 | -------------------------------------------------------------------------------- /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 | test: 2 | npm run test 3 | 4 | install: 5 | ifndef CI 6 | asdf plugin add nodejs || true 7 | asdf install || true 8 | endif 9 | npm install 10 | 11 | version: 12 | npm run standard-version 13 | 14 | release: 15 | git push --follow-tags origin main 16 | npm run release 17 | 18 | workspace: 19 | docker compose build workspace 20 | docker compose run --rm workspace 21 | 22 | clean: 23 | docker compose down -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Discord Webhook 2 | 3 | > All credits go to the initial release by [baked-libs/discord-webhook](https://github.com/baked-libs/discord-webhook). 4 | 5 | This is a hard fork of the original Discord Webhook GitHub Action, which was specifically catered towards Java development. This is one a slightly more generic one where we just want to post commits via webhooks. 6 | 7 | ![preview](./docs/preview.png) 8 | 9 | ## :mailbox_with_no_mail: Inputs 10 | 11 | ### `webhook_url` 12 | 13 | **Required** The GitHub webhook URL comprised of both `id` and `token` fields. 14 | 15 | ### `id` 16 | 17 | > This is ignored if `webhook_url` is set 18 | 19 | **Required** This is the id of your Discord webhook, if you copy the webhook url, this will be the first part of it. 20 | 21 | ### `token` 22 | 23 | > This is ignored if `webhook_url` is set 24 | 25 | **Required** Now your Discord webhook token, it's the second part of the url. 26 | 27 | ### `censor_username` 28 | 29 | Censor username with by only showing the first and last character. For example, `j...y` as `johnnyhuy`. 30 | 31 | ### `repo_name` 32 | 33 | Specify a custom repository name to overwrite the `username/repo` format. 34 | 35 | ### `hide_links` 36 | 37 | Hide links on embedded view. 38 | 39 | ### `color` 40 | 41 | Color of the Discord embed. 42 | 43 | ### `thread_id` 44 | 45 | The ID of the thread in forum channel to send the embed to. 46 | 47 | ## :scroll: Usage 48 | 49 | To set up this Action, create a new workflow file under `.github/workflows/workflow_name.yml`. 50 | 51 | ```yaml 52 | name: Discord Webhook 53 | 54 | on: [push] 55 | 56 | jobs: 57 | git: 58 | runs-on: ubuntu-latest 59 | steps: 60 | - uses: actions/checkout@v2 61 | 62 | - name: Run Discord Webhook 63 | uses: johnnyhuy/actions-discord-git-webhook@main 64 | with: 65 | webhook_url: ${{ secrets.YOUR_DISCORD_WEBHOOK_URL }} 66 | ``` 67 | 68 | ### Alternatives 69 | 70 | ```yaml 71 | # Disable URL links to the repository 72 | - name: Run Discord Webhook 73 | uses: johnnyhuy/actions-discord-git-webhook@main 74 | with: 75 | webhook_url: ${{ secrets.YOUR_DISCORD_WEBHOOK_URL }} 76 | hide_links: true 77 | 78 | # Censor username 79 | - name: Run Discord Webhook 80 | uses: johnnyhuy/actions-discord-git-webhook@main 81 | with: 82 | webhook_url: ${{ secrets.YOUR_DISCORD_WEBHOOK_URL }} 83 | censor_username: false 84 | 85 | # Using an ID and token 86 | - name: Run Discord Webhook 87 | uses: johnnyhuy/actions-discord-git-webhook@main 88 | with: 89 | id: ${{ secrets.YOUR_DISCORD_WEBHOOK_ID }} 90 | token: ${{ secrets.YOUR_DISCORD_WEBHOOK_TOKEN }} 91 | 92 | # Using a custom repo name 93 | - name: Run Discord Webhook 94 | uses: johnnyhuy/actions-discord-git-webhook@main 95 | with: 96 | id: ${{ secrets.YOUR_DISCORD_WEBHOOK_ID }} 97 | token: ${{ secrets.YOUR_DISCORD_WEBHOOK_TOKEN }} 98 | repo_name: My Special Repo 99 | 100 | # Send embed in forum thread 101 | - name: Run Discord Webhook 102 | uses: johnnyhuy/actions-discord-git-webhook@main 103 | with: 104 | id: ${{ secrets.YOUR_DISCORD_WEBHOOK_ID }} 105 | token: ${{ secrets.YOUR_DISCORD_WEBHOOK_TOKEN }} 106 | thread_id: ${{ secrets.YOUR_DISCORD_THREAD_ID }} 107 | ``` 108 | 109 | ## Development 110 | 111 | This project uses a Makefile to simplify Docker commands for development, testing, and releasing. 112 | 113 | ### Prerequisites 114 | 115 | - Docker and Docker Compose 116 | - Make 117 | 118 | ### Getting Started 119 | 120 | ```bash 121 | # Start development workspace (using Docker) 122 | make workspace 123 | npm ci 124 | 125 | # Or locally 126 | npm ci 127 | ``` 128 | 129 | ### Testing 130 | 131 | ```bash 132 | # Run tests 133 | make test 134 | ``` 135 | 136 | ### Building and Releasing 137 | 138 | ```bash 139 | # Build the release container 140 | make build 141 | 142 | # Create a new version 143 | make version 144 | 145 | # Push and release to GitHub 146 | make release 147 | ``` 148 | 149 | ### Cleanup 150 | 151 | ```bash 152 | # Clean up Docker resources 153 | make clean 154 | ``` 155 | 156 | ### Versioning 157 | 158 | Changes are versioned via GitHub Actions that use [`standard-version`](https://github.com/conventional-changelog/standard-version) to create Git tags and [`conventional-github-releaser`](https://github.com/conventional-changelog/releaser-tools/tree/master/packages/conventional-github-releaser) to submit GitHub releases. 159 | 160 | We follow the [`Conventional Commits`](https://www.conventionalcommits.org/en/v1.0.0/#summary) standard where commit messages get _automatically_ analysed to produce a generated semantic version. 161 | -------------------------------------------------------------------------------- /action.Dockerfile: -------------------------------------------------------------------------------- 1 | FROM node:20-alpine 2 | 3 | WORKDIR /opt/workspace 4 | 5 | COPY ./src /opt/workspace/src 6 | COPY ./package-lock.json /opt/workspace/package-lock.json 7 | COPY ./package.json /opt/workspace/package.json 8 | 9 | RUN npm ci 10 | 11 | ENTRYPOINT [ "node", "/opt/workspace/src/app.js" ] -------------------------------------------------------------------------------- /action.yml: -------------------------------------------------------------------------------- 1 | name: "discord-webhook" 2 | description: "This GitHub Action sends fancy and more meaningful Discord messages for your commits. It includes Test results and coverage." 3 | 4 | inputs: 5 | webhook_url: 6 | description: Discord webhook URL 7 | id: 8 | description: Discord Webhook ID (ignored if `webhook_url` is set) 9 | token: 10 | description: Discord Webhook token (ignored if `webhook_url` is set) 11 | repo_name: 12 | description: Overwrite repository name with a custom one 13 | censor_username: 14 | description: Hide the full GitHub username 15 | default: false 16 | hide_links: 17 | description: Toggle whether to show repo links on the webhook event 18 | default: false 19 | color: 20 | description: Color of the Discord embed 21 | default: "7dbbe6" 22 | thread_id: 23 | description: Thread ID to send the message to 24 | 25 | runs: 26 | using: "docker" 27 | image: "action.Dockerfile" 28 | 29 | branding: 30 | icon: check-circle 31 | color: blue 32 | -------------------------------------------------------------------------------- /catalog-info.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: backstage.io/v1alpha1 2 | kind: Component 3 | metadata: 4 | name: actions-discord-git-webhook 5 | description: A GitHub Action to send commit notifications to Discord via webhooks 6 | tags: 7 | - github-actions 8 | - discord 9 | - javascript 10 | spec: 11 | type: library 12 | lifecycle: production 13 | owner: johnnyhuy 14 | 15 | --- 16 | apiVersion: backstage.io/v1alpha1 17 | kind: API 18 | metadata: 19 | name: discord-webhook-api 20 | description: Discord Webhook API for sending messages 21 | spec: 22 | type: webhook 23 | lifecycle: production 24 | owner: discord 25 | system: discord 26 | definition: | 27 | https://discord.com/developers/docs/resources/webhook 28 | 29 | --- 30 | apiVersion: backstage.io/v1alpha1 31 | kind: System 32 | metadata: 33 | name: discord 34 | description: Discord messaging platform 35 | spec: 36 | owner: discord 37 | 38 | --- 39 | apiVersion: backstage.io/v1alpha1 40 | kind: Location 41 | metadata: 42 | name: actions-discord-git-webhook 43 | description: GitHub repo for the actions-discord-git-webhook action 44 | spec: 45 | type: github 46 | target: "https://github.com/johnnyhuy/actions-discord-git-webhook" 47 | -------------------------------------------------------------------------------- /compose.test.yaml: -------------------------------------------------------------------------------- 1 | version: "3.8" 2 | 3 | services: 4 | test: 5 | image: johnnyhuy/actions-discord-git-webhook/test:latest 6 | entrypoint: /opt/workspace/node_modules/.bin/jest 7 | build: 8 | context: . 9 | dockerfile: action.Dockerfile 10 | volumes: 11 | - "./tests:/opt/workspace/tests" 12 | -------------------------------------------------------------------------------- /compose.yaml: -------------------------------------------------------------------------------- 1 | version: "3.8" 2 | 3 | services: 4 | workspace: 5 | image: johnnyhuy/actions-discord-git-webhook/workspace:latest 6 | entrypoint: /bin/sh 7 | build: 8 | context: . 9 | dockerfile: action.Dockerfile 10 | volumes: 11 | - ".:/opt/workspace" 12 | 13 | release: 14 | image: johnnyhuy/actions-discord-git-webhook/release:latest 15 | build: 16 | context: . 17 | dockerfile: release.Dockerfile 18 | volumes: 19 | - ".:/opt/workspace" 20 | working_dir: /opt/workspace 21 | environment: 22 | - CONVENTIONAL_GITHUB_RELEASER_TOKEN 23 | 24 | action: 25 | image: johnnyhuy/actions-discord-git-webhook/action:latest 26 | build: 27 | context: . 28 | dockerfile: action.Dockerfile 29 | -------------------------------------------------------------------------------- /docs/preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/johnnyhuy/actions-discord-git-webhook/344d3543a4d21067013d88ab8ee47ad498d8bb98/docs/preview.png -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "actions-discord-git-webhook", 3 | "version": "1.0.4", 4 | "description": "This is a hard fork of the original Discord Webhook GitHub Action, which was specifically catered towards Java development. This is one a slightly more generic one where we just want to post commits via webhooks.", 5 | "main": "src/main.js", 6 | "author": "johnnyhuy", 7 | "license": "GPL-3.0", 8 | "scripts": { 9 | "test": "jest", 10 | "format:check": "prettier --check .", 11 | "format": "prettier --write .", 12 | "standard-version": "standard-version", 13 | "release": "conventional-github-releaser" 14 | }, 15 | "dependencies": { 16 | "@actions/core": "^1.11.1", 17 | "@actions/github": "^6.0.0", 18 | "child-process-promise": "^2.1.3", 19 | "conventional-github-releaser": "^3.1.5", 20 | "discord.js": "^14.18.0", 21 | "standard-version": "^9.5.0", 22 | "xml-library": "0.2.0" 23 | }, 24 | "devDependencies": { 25 | "jest": "^29.7.0", 26 | "jest-when": "^3.7.0", 27 | "prettier": "^3.5.3" 28 | }, 29 | "standard-version": { 30 | "skip": { 31 | "changelog": true 32 | } 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /src/app.js: -------------------------------------------------------------------------------- 1 | const core = require("@actions/core"); 2 | const github = require("@actions/github"); 3 | const process = require("process"); 4 | const webhooks = require("./webhooks.js"); 5 | 6 | async function main() { 7 | let webhookUrl = core.getInput("webhook_url"); 8 | const hideLinks = core.getInput("hide_links"); 9 | const color = core.getInput("color"); 10 | const id = core.getInput("id"); 11 | const token = core.getInput("token"); 12 | const customRepoName = core.getInput("repo_name"); 13 | const censorUsername = core.getInput("censor_username"); 14 | const threadId = core.getInput("thread_id"); 15 | 16 | let payload = github.context.payload; 17 | 18 | if (customRepoName !== "") { 19 | payload.repository.full_name = customRepoName; 20 | } 21 | 22 | if (!webhookUrl) { 23 | core.warning( 24 | "Missing webhook URL, using id and token fields to generate a webhook URL", 25 | ); 26 | 27 | if (!id || !token) { 28 | core.setFailed( 29 | "Webhook URL cannot be generated, please add `id` and `token` or `webhook_url` to the GitHub action", 30 | ); 31 | process.exit(1); 32 | } 33 | 34 | webhookUrl = `https://discord.com/api/webhooks/${id}/${token}`; 35 | } 36 | 37 | await webhooks.send( 38 | webhookUrl, 39 | payload, 40 | hideLinks, 41 | censorUsername, 42 | color, 43 | threadId, 44 | ); 45 | } 46 | 47 | main() 48 | .then(() => process.exit(0)) 49 | .catch((error) => { 50 | core.setFailed(error); 51 | process.exit(1); 52 | }); 53 | -------------------------------------------------------------------------------- /src/webhooks.js: -------------------------------------------------------------------------------- 1 | const discord = require("discord.js"); 2 | const core = require("@actions/core"); 3 | const MAX_MESSAGE_LENGTH = 128; 4 | 5 | module.exports.send = ( 6 | webhookUrl, 7 | payload, 8 | hideLinks, 9 | censorUsername, 10 | color, 11 | threadId, 12 | ) => { 13 | const repository = payload.repository.full_name; 14 | const commits = payload.commits; 15 | const size = commits.length; 16 | const branch = payload.ref.split("/")[payload.ref.split("/").length - 1]; 17 | const url = payload.compare; 18 | 19 | if (commits.length === 0) { 20 | core.warning(`Aborting analysis, found no commits.`); 21 | return Promise.resolve(); 22 | } 23 | 24 | core.debug(`Received payload: ${JSON.stringify(payload, null, 2)}`); 25 | core.debug(`Received ${commits.length}/${size} commits...`); 26 | core.info("Constructing Embed..."); 27 | 28 | let latest = commits[0]; 29 | const count = size == 1 ? "Commit" : " Commits"; 30 | 31 | // Handle color parameter properly: If it starts with #, use as is, otherwise use as color name 32 | const colorValue = color; 33 | let embed = new discord.EmbedBuilder() 34 | .setColor(colorValue) 35 | .setTitle(`⚡ ${size} ${count}\n📁\`${repository}\`\n🌳 \`${branch}\``) 36 | .setDescription(this.getChangeLog(payload, hideLinks, censorUsername)) 37 | .setTimestamp(Date.parse(latest.timestamp)); 38 | 39 | if (!hideLinks) { 40 | embed.setURL(url); 41 | } 42 | 43 | return new Promise((resolve, reject) => { 44 | let client; 45 | core.info("Preparing Discord webhook client..."); 46 | 47 | try { 48 | client = new discord.WebhookClient({ url: webhookUrl }); 49 | } catch (error) { 50 | reject(error); 51 | } 52 | 53 | if (threadId) { 54 | core.info(`Sending message to thread: ${threadId}`); 55 | } else { 56 | core.info("Sending message to channel..."); 57 | } 58 | 59 | return client 60 | .send({ 61 | embeds: [embed], 62 | threadId: threadId || null, 63 | }) 64 | .then((result) => { 65 | core.info("Successfully sent the message!"); 66 | resolve(result); 67 | }) 68 | .catch((error) => reject(error)); 69 | }); 70 | }; 71 | 72 | module.exports.getChangeLog = (payload, hideLinks, censorUsername) => { 73 | core.info("Constructing Changelog..."); 74 | const commits = payload.commits; 75 | let changelog = ""; 76 | 77 | for (let i in commits) { 78 | if (i > 3) { 79 | changelog += `+ ${commits.length - i} more...\n`; 80 | break; 81 | } 82 | 83 | let commit = commits[i]; 84 | const firstUsername = commit.author.username[0]; 85 | const lastUsername = 86 | commit.author.username[commit.author.username.length - 1]; 87 | const username = !!censorUsername 88 | ? `${firstUsername}...${lastUsername}` 89 | : commit.author.username; 90 | const repository = payload.repository; 91 | 92 | if (commit.message.includes(repository.full_name) && hideLinks) { 93 | const firstRepository = repository.full_name[0]; 94 | const lastRepository = 95 | repository.full_name[repository.full_name.length - 1]; 96 | commit.message = commit.message.replaceAll( 97 | repository.full_name, 98 | `${firstRepository}...${lastRepository}`, 99 | ); 100 | } 101 | 102 | let sha = commit.id.substring(0, 6); 103 | let message = 104 | commit.message.length > MAX_MESSAGE_LENGTH 105 | ? commit.message.substring(0, MAX_MESSAGE_LENGTH) + "..." 106 | : commit.message; 107 | changelog += !hideLinks 108 | ? `[\`${sha}\`](${commit.url}) ${message} by _@${username}_\n` 109 | : `\`${sha}\` ${message} by _@${username}_\n`; 110 | } 111 | 112 | return changelog; 113 | }; 114 | -------------------------------------------------------------------------------- /tests/__snapshots__/webhooks.test.js.snap: -------------------------------------------------------------------------------- 1 | // Jest Snapshot v1, https://goo.gl/fbAQLP 2 | 3 | exports[`get change log 1`] = ` 4 | "[\`a11bef\`](https://github.com/johndoe/example_repo/commit/a11bef06a3f659402fe7563abf99ad00de2209e6) Merge branch 'master' of https://github.com/johndoe/example_repo into master by _@johndoe_ 5 | [\`ca82a6\`](https://github.com/johndoe/example_repo/commit/ca82a6dff817ec66f44342007202690a93763949) fix: Some feature fix by _@johndoe_ 6 | " 7 | `; 8 | 9 | exports[`get change log with censor username 1`] = ` 10 | "[\`a11bef\`](https://github.com/johndoe/example_repo/commit/a11bef06a3f659402fe7563abf99ad00de2209e6) Merge branch 'master' of https://github.com/johndoe/example_repo into master by _@j...e_ 11 | [\`ca82a6\`](https://github.com/johndoe/example_repo/commit/ca82a6dff817ec66f44342007202690a93763949) fix: Some feature fix by _@j...e_ 12 | " 13 | `; 14 | 15 | exports[`get change log with hiding links 1`] = ` 16 | "\`a11bef\` Merge branch 'master' of https://github.com/j...o into master by _@johndoe_ 17 | \`ca82a6\` fix: Some feature fix by _@johndoe_ 18 | " 19 | `; 20 | 21 | exports[`get change log with hiding links and censor username 1`] = ` 22 | "\`a11bef\` Merge branch 'master' of https://github.com/j...o into master by _@j...e_ 23 | \`ca82a6\` fix: Some feature fix by _@j...e_ 24 | " 25 | `; 26 | -------------------------------------------------------------------------------- /tests/main.test.js: -------------------------------------------------------------------------------- 1 | const { when, resetAllWhenMocks } = require("jest-when"); 2 | const process = require("process"); 3 | 4 | jest.mock("discord.js"); 5 | jest.mock("@actions/core"); 6 | jest.mock("@actions/github"); 7 | jest.spyOn(process, "exit").mockImplementation(() => Promise.resolve); 8 | 9 | afterEach(() => { 10 | jest.resetModules(); 11 | }); 12 | 13 | test("error if webhook URL, token and ID is empty", async () => { 14 | // Arrange 15 | const payload = require("./mocks/github_webhook_full.json"); 16 | const core = require("@actions/core"); 17 | const github = require("@actions/github"); 18 | const webhooks = require("../src/webhooks"); 19 | webhooks.send = jest.fn(); 20 | github.context.payload = payload; 21 | 22 | // Act 23 | expect.assertions(1); 24 | const data = await require("../src/app"); 25 | 26 | // Assert 27 | expect(core.setFailed).toHaveBeenCalledWith( 28 | "Webhook URL cannot be generated, please add `id` and `token` or `webhook_url` to the GitHub action", 29 | ); 30 | }); 31 | 32 | test("error if token is empty", async () => { 33 | // Arrange 34 | const payload = require("./mocks/github_webhook_full.json"); 35 | const core = require("@actions/core"); 36 | const github = require("@actions/github"); 37 | const webhooks = require("../src/webhooks"); 38 | webhooks.send = jest.fn(); 39 | github.context.payload = payload; 40 | when(core.getInput).calledWith("id").mockReturnValue("123321123321"); 41 | 42 | // Act 43 | expect.assertions(1); 44 | const data = await require("../src/app"); 45 | 46 | // Assert 47 | expect(core.setFailed).toHaveBeenCalledWith( 48 | "Webhook URL cannot be generated, please add `id` and `token` or `webhook_url` to the GitHub action", 49 | ); 50 | }); 51 | 52 | test("error if id is empty", async () => { 53 | // Arrange 54 | const payload = require("./mocks/github_webhook_full.json"); 55 | const core = require("@actions/core"); 56 | const github = require("@actions/github"); 57 | const webhooks = require("../src/webhooks"); 58 | webhooks.send = jest.fn(); 59 | github.context.payload = payload; 60 | when(core.getInput).calledWith("token").mockReturnValue("123321123321"); 61 | 62 | // Act 63 | expect.assertions(1); 64 | const data = await require("../src/app"); 65 | 66 | // Assert 67 | expect(core.setFailed).toHaveBeenCalledWith( 68 | "Webhook URL cannot be generated, please add `id` and `token` or `webhook_url` to the GitHub action", 69 | ); 70 | }); 71 | 72 | test("error if webhook url is empty", async () => { 73 | // Arrange 74 | const payload = require("./mocks/github_webhook_full.json"); 75 | const core = require("@actions/core"); 76 | const github = require("@actions/github"); 77 | const webhooks = require("../src/webhooks"); 78 | webhooks.send = jest.fn(); 79 | github.context.payload = payload; 80 | when(core.getInput).calledWith("id").mockReturnValue("123321123321"); 81 | when(core.getInput).calledWith("token").mockReturnValue("123321123321"); 82 | 83 | // Act 84 | expect.assertions(1); 85 | const data = await require("../src/app"); 86 | 87 | // Assert 88 | expect(core.setFailed).not.toHaveBeenCalledWith( 89 | "Webhook URL cannot be generated, please add `id` and `token` or `webhook_url` to the GitHub action", 90 | ); 91 | }); 92 | -------------------------------------------------------------------------------- /tests/mocks/github_webhook_full.json: -------------------------------------------------------------------------------- 1 | { 2 | "after": "ca82a6dff817ec66f44342007202690a93763949", 3 | "base_ref": null, 4 | "before": "085bb3bcb608e1e8451d4b2432f8ecbe6306e7e7", 5 | "commits": [ 6 | { 7 | "author": { 8 | "email": "john@example.com", 9 | "name": "John Doe", 10 | "username": "johndoe" 11 | }, 12 | "committer": { 13 | "email": "john@example.com", 14 | "name": "John Doe", 15 | "username": "johndoe" 16 | }, 17 | "distinct": true, 18 | "id": "a11bef06a3f659402fe7563abf99ad00de2209e6", 19 | "message": "Merge branch 'master' of https://github.com/johndoe/example_repo into master", 20 | "timestamp": "2026-09-12T17:19:08+10:00", 21 | "tree_id": "fa67886fe5ed496ebe7ea107d83e55a474d24982", 22 | "url": "https://github.com/johndoe/example_repo/commit/a11bef06a3f659402fe7563abf99ad00de2209e6" 23 | }, 24 | { 25 | "author": { 26 | "email": "john@example.com", 27 | "name": "John Doe", 28 | "username": "johndoe" 29 | }, 30 | "committer": { 31 | "email": "john@example.com", 32 | "name": "John Doe", 33 | "username": "johndoe" 34 | }, 35 | "distinct": true, 36 | "id": "ca82a6dff817ec66f44342007202690a93763949", 37 | "message": "fix: Some feature fix", 38 | "timestamp": "2026-09-12T17:56:18+10:00", 39 | "tree_id": "8767690dc443b57f0a9bc1219877dd1f84d28b24", 40 | "url": "https://github.com/johndoe/example_repo/commit/ca82a6dff817ec66f44342007202690a93763949" 41 | } 42 | ], 43 | "compare": "https://github.com/johndoe/example_repo/compare/ca82a6dff817...085bb3bcb608e", 44 | "created": false, 45 | "deleted": false, 46 | "forced": false, 47 | "head_commit": { 48 | "author": { 49 | "email": "john@example.com", 50 | "name": "John Doe", 51 | "username": "johndoe" 52 | }, 53 | "committer": { 54 | "email": "john@example.com", 55 | "name": "John Doe", 56 | "username": "johndoe" 57 | }, 58 | "distinct": true, 59 | "id": "ca82a6dff817ec66f44342007202690a93763949", 60 | "message": "fix: Some feature fix", 61 | "timestamp": "2026-09-12T17:56:18+10:00", 62 | "tree_id": "8767690dc443b57f0a9bc1219877dd1f84d28b24", 63 | "url": "https://github.com/johndoe/example_repo/commit/ca82a6dff817ec66f44342007202690a93763949" 64 | }, 65 | "pusher": { 66 | "email": "john@example.com", 67 | "name": "johndoe" 68 | }, 69 | "ref": "refs/heads/main", 70 | "repository": { 71 | "archive_url": "https://api.github.com/repos/johndoe/example_repo/{archive_format}{/ref}", 72 | "archived": false, 73 | "assignees_url": "https://api.github.com/repos/johndoe/example_repo/assignees{/user}", 74 | "blobs_url": "https://api.github.com/repos/johndoe/example_repo/git/blobs{/sha}", 75 | "branches_url": "https://api.github.com/repos/johndoe/example_repo/branches{/branch}", 76 | "clone_url": "https://github.com/johndoe/example_repo.git", 77 | "collaborators_url": "https://api.github.com/repos/johndoe/example_repo/collaborators{/collaborator}", 78 | "comments_url": "https://api.github.com/repos/johndoe/example_repo/comments{/number}", 79 | "commits_url": "https://api.github.com/repos/johndoe/example_repo/commits{/sha}", 80 | "compare_url": "https://api.github.com/repos/johndoe/example_repo/compare/{base}...{head}", 81 | "contents_url": "https://api.github.com/repos/johndoe/example_repo/contents/{+path}", 82 | "contributors_url": "https://api.github.com/repos/johndoe/example_repo/contributors", 83 | "created_at": 1662967148000, 84 | "default_branch": "master", 85 | "deployments_url": "https://api.github.com/repos/johndoe/example_repo/deployments", 86 | "description": "Example repo", 87 | "disabled": false, 88 | "downloads_url": "https://api.github.com/repos/johndoe/example_repo/downloads", 89 | "events_url": "https://api.github.com/repos/johndoe/example_repo/events", 90 | "fork": false, 91 | "forks": 0, 92 | "forks_count": 0, 93 | "forks_url": "https://api.github.com/repos/johndoe/example_repo/forks", 94 | "full_name": "johndoe/example_repo", 95 | "git_commits_url": "https://api.github.com/repos/johndoe/example_repo/git/commits{/sha}", 96 | "git_refs_url": "https://api.github.com/repos/johndoe/example_repo/git/refs{/sha}", 97 | "git_tags_url": "https://api.github.com/repos/johndoe/example_repo/git/tags{/sha}", 98 | "git_url": "git://github.com/johndoe/example_repo.git", 99 | "has_downloads": true, 100 | "has_issues": false, 101 | "has_pages": false, 102 | "has_projects": false, 103 | "has_wiki": false, 104 | "homepage": "http://example.com", 105 | "hooks_url": "https://api.github.com/repos/johndoe/example_repo/hooks", 106 | "html_url": "https://github.com/johndoe/example_repo", 107 | "id": 139721584, 108 | "issue_comment_url": "https://api.github.com/repos/johndoe/example_repo/issues/comments{/number}", 109 | "issue_events_url": "https://api.github.com/repos/johndoe/example_repo/issues/events{/number}", 110 | "issues_url": "https://api.github.com/repos/johndoe/example_repo/issues{/number}", 111 | "keys_url": "https://api.github.com/repos/johndoe/example_repo/keys{/key_id}", 112 | "labels_url": "https://api.github.com/repos/johndoe/example_repo/labels{/name}", 113 | "language": "PHP", 114 | "languages_url": "https://api.github.com/repos/johndoe/example_repo/languages", 115 | "license": null, 116 | "master_branch": "master", 117 | "merges_url": "https://api.github.com/repos/johndoe/example_repo/merges", 118 | "milestones_url": "https://api.github.com/repos/johndoe/example_repo/milestones{/number}", 119 | "mirror_url": null, 120 | "name": "example_repo", 121 | "node_id": "MDEwOlJlcG9zaXRvcnkxMzk3MjE1ODQ=", 122 | "notifications_url": "https://api.github.com/repos/johndoe/example_repo/notifications{?since,all,participating}", 123 | "open_issues": 8, 124 | "open_issues_count": 8, 125 | "owner": { 126 | "avatar_url": "https://avatars.githubusercontent.com/u/27847622?v=4", 127 | "email": "john@example.com", 128 | "events_url": "https://api.github.com/users/johndoe/events{/privacy}", 129 | "followers_url": "https://api.github.com/users/johndoe/followers", 130 | "following_url": "https://api.github.com/users/johndoe/following{/other_user}", 131 | "gists_url": "https://api.github.com/users/johndoe/gists{/gist_id}", 132 | "gravatar_id": "", 133 | "html_url": "https://github.com/johndoe", 134 | "id": 27847622, 135 | "login": "johndoe", 136 | "name": "johndoe", 137 | "node_id": "MDQ6VXNlcjI3OQQ3NjIy", 138 | "organizations_url": "https://api.github.com/users/johndoe/orgs", 139 | "received_events_url": "https://api.github.com/users/johndoe/received_events", 140 | "repos_url": "https://api.github.com/users/johndoe/repos", 141 | "site_admin": false, 142 | "starred_url": "https://api.github.com/users/johndoe/starred{/owner}{/repo}", 143 | "subscriptions_url": "https://api.github.com/users/johndoe/subscriptions", 144 | "type": "User", 145 | "url": "https://api.github.com/users/johndoe" 146 | }, 147 | "private": true, 148 | "pulls_url": "https://api.github.com/repos/johndoe/example_repo/pulls{/number}", 149 | "pushed_at": 1631433553, 150 | "releases_url": "https://api.github.com/repos/johndoe/example_repo/releases{/id}", 151 | "size": 42999, 152 | "ssh_url": "git@github.com:johndoe/example_repo.git", 153 | "stargazers": 1, 154 | "stargazers_count": 1, 155 | "stargazers_url": "https://api.github.com/repos/johndoe/example_repo/stargazers", 156 | "statuses_url": "https://api.github.com/repos/johndoe/example_repo/statuses/{sha}", 157 | "subscribers_url": "https://api.github.com/repos/johndoe/example_repo/subscribers", 158 | "subscription_url": "https://api.github.com/repos/johndoe/example_repo/subscription", 159 | "svn_url": "https://github.com/johndoe/example_repo", 160 | "tags_url": "https://api.github.com/repos/johndoe/example_repo/tags", 161 | "teams_url": "https://api.github.com/repos/johndoe/example_repo/teams", 162 | "trees_url": "https://api.github.com/repos/johndoe/example_repo/git/trees{/sha}", 163 | "updated_at": "2026-09-01T22:40:48Z", 164 | "url": "https://github.com/johndoe/example_repo", 165 | "watchers": 1, 166 | "watchers_count": 1 167 | }, 168 | "sender": { 169 | "avatar_url": "https://avatars.githubusercontent.com/u/27847622?v=4", 170 | "events_url": "https://api.github.com/users/johndoe/events{/privacy}", 171 | "followers_url": "https://api.github.com/users/johndoe/followers", 172 | "following_url": "https://api.github.com/users/johndoe/following{/other_user}", 173 | "gists_url": "https://api.github.com/users/johndoe/gists{/gist_id}", 174 | "gravatar_id": "", 175 | "html_url": "https://github.com/johndoe", 176 | "id": 27847622, 177 | "login": "johndoe", 178 | "node_id": "MDQ6VXNlcjI3ODQ3NjIy", 179 | "organizations_url": "https://api.github.com/users/johndoe/orgs", 180 | "received_events_url": "https://api.github.com/users/johndoe/received_events", 181 | "repos_url": "https://api.github.com/users/johndoe/repos", 182 | "site_admin": false, 183 | "starred_url": "https://api.github.com/users/johndoe/starred{/owner}{/repo}", 184 | "subscriptions_url": "https://api.github.com/users/johndoe/subscriptions", 185 | "type": "User", 186 | "url": "https://api.github.com/users/johndoe" 187 | } 188 | } 189 | -------------------------------------------------------------------------------- /tests/mocks/github_webhook_no_commits.json: -------------------------------------------------------------------------------- 1 | { 2 | "after": "ca82a6dff817ec66f44342007202690a93763949", 3 | "base_ref": null, 4 | "before": "085bb3bcb608e1e8451d4b2432f8ecbe6306e7e7", 5 | "commits": [], 6 | "compare": "https://github.com/johndoe/example_repo/compare/ca82a6dff817...085bb3bcb608e", 7 | "created": false, 8 | "deleted": false, 9 | "forced": false, 10 | "head_commit": { 11 | "author": { 12 | "email": "john@example.com", 13 | "name": "John Doe", 14 | "username": "johndoe" 15 | }, 16 | "committer": { 17 | "email": "john@example.com", 18 | "name": "John Doe", 19 | "username": "johndoe" 20 | }, 21 | "distinct": true, 22 | "id": "ca82a6dff817ec66f44342007202690a93763949", 23 | "message": "fix: Some feature fix", 24 | "timestamp": "2026-09-12T17:56:18+10:00", 25 | "tree_id": "8767690dc443b57f0a9bc1219877dd1f84d28b24", 26 | "url": "https://github.com/johndoe/example_repo/commit/ca82a6dff817ec66f44342007202690a93763949" 27 | }, 28 | "pusher": { 29 | "email": "john@example.com", 30 | "name": "johndoe" 31 | }, 32 | "ref": "refs/heads/main", 33 | "repository": { 34 | "archive_url": "https://api.github.com/repos/johndoe/example_repo/{archive_format}{/ref}", 35 | "archived": false, 36 | "assignees_url": "https://api.github.com/repos/johndoe/example_repo/assignees{/user}", 37 | "blobs_url": "https://api.github.com/repos/johndoe/example_repo/git/blobs{/sha}", 38 | "branches_url": "https://api.github.com/repos/johndoe/example_repo/branches{/branch}", 39 | "clone_url": "https://github.com/johndoe/example_repo.git", 40 | "collaborators_url": "https://api.github.com/repos/johndoe/example_repo/collaborators{/collaborator}", 41 | "comments_url": "https://api.github.com/repos/johndoe/example_repo/comments{/number}", 42 | "commits_url": "https://api.github.com/repos/johndoe/example_repo/commits{/sha}", 43 | "compare_url": "https://api.github.com/repos/johndoe/example_repo/compare/{base}...{head}", 44 | "contents_url": "https://api.github.com/repos/johndoe/example_repo/contents/{+path}", 45 | "contributors_url": "https://api.github.com/repos/johndoe/example_repo/contributors", 46 | "created_at": 1662967148000, 47 | "default_branch": "master", 48 | "deployments_url": "https://api.github.com/repos/johndoe/example_repo/deployments", 49 | "description": "Example repo", 50 | "disabled": false, 51 | "downloads_url": "https://api.github.com/repos/johndoe/example_repo/downloads", 52 | "events_url": "https://api.github.com/repos/johndoe/example_repo/events", 53 | "fork": false, 54 | "forks": 0, 55 | "forks_count": 0, 56 | "forks_url": "https://api.github.com/repos/johndoe/example_repo/forks", 57 | "full_name": "johndoe/example_repo", 58 | "git_commits_url": "https://api.github.com/repos/johndoe/example_repo/git/commits{/sha}", 59 | "git_refs_url": "https://api.github.com/repos/johndoe/example_repo/git/refs{/sha}", 60 | "git_tags_url": "https://api.github.com/repos/johndoe/example_repo/git/tags{/sha}", 61 | "git_url": "git://github.com/johndoe/example_repo.git", 62 | "has_downloads": true, 63 | "has_issues": false, 64 | "has_pages": false, 65 | "has_projects": false, 66 | "has_wiki": false, 67 | "homepage": "http://example.com", 68 | "hooks_url": "https://api.github.com/repos/johndoe/example_repo/hooks", 69 | "html_url": "https://github.com/johndoe/example_repo", 70 | "id": 139721584, 71 | "issue_comment_url": "https://api.github.com/repos/johndoe/example_repo/issues/comments{/number}", 72 | "issue_events_url": "https://api.github.com/repos/johndoe/example_repo/issues/events{/number}", 73 | "issues_url": "https://api.github.com/repos/johndoe/example_repo/issues{/number}", 74 | "keys_url": "https://api.github.com/repos/johndoe/example_repo/keys{/key_id}", 75 | "labels_url": "https://api.github.com/repos/johndoe/example_repo/labels{/name}", 76 | "language": "PHP", 77 | "languages_url": "https://api.github.com/repos/johndoe/example_repo/languages", 78 | "license": null, 79 | "master_branch": "master", 80 | "merges_url": "https://api.github.com/repos/johndoe/example_repo/merges", 81 | "milestones_url": "https://api.github.com/repos/johndoe/example_repo/milestones{/number}", 82 | "mirror_url": null, 83 | "name": "example_repo", 84 | "node_id": "MDEwOlJlcG9zaXRvcnkxMzk3MjE1ODQ=", 85 | "notifications_url": "https://api.github.com/repos/johndoe/example_repo/notifications{?since,all,participating}", 86 | "open_issues": 8, 87 | "open_issues_count": 8, 88 | "owner": { 89 | "avatar_url": "https://avatars.githubusercontent.com/u/27847622?v=4", 90 | "email": "john@example.com", 91 | "events_url": "https://api.github.com/users/johndoe/events{/privacy}", 92 | "followers_url": "https://api.github.com/users/johndoe/followers", 93 | "following_url": "https://api.github.com/users/johndoe/following{/other_user}", 94 | "gists_url": "https://api.github.com/users/johndoe/gists{/gist_id}", 95 | "gravatar_id": "", 96 | "html_url": "https://github.com/johndoe", 97 | "id": 27847622, 98 | "login": "johndoe", 99 | "name": "johndoe", 100 | "node_id": "MDQ6VXNlcjI3OQQ3NjIy", 101 | "organizations_url": "https://api.github.com/users/johndoe/orgs", 102 | "received_events_url": "https://api.github.com/users/johndoe/received_events", 103 | "repos_url": "https://api.github.com/users/johndoe/repos", 104 | "site_admin": false, 105 | "starred_url": "https://api.github.com/users/johndoe/starred{/owner}{/repo}", 106 | "subscriptions_url": "https://api.github.com/users/johndoe/subscriptions", 107 | "type": "User", 108 | "url": "https://api.github.com/users/johndoe" 109 | }, 110 | "private": true, 111 | "pulls_url": "https://api.github.com/repos/johndoe/example_repo/pulls{/number}", 112 | "pushed_at": 1631433553, 113 | "releases_url": "https://api.github.com/repos/johndoe/example_repo/releases{/id}", 114 | "size": 42999, 115 | "ssh_url": "git@github.com:johndoe/example_repo.git", 116 | "stargazers": 1, 117 | "stargazers_count": 1, 118 | "stargazers_url": "https://api.github.com/repos/johndoe/example_repo/stargazers", 119 | "statuses_url": "https://api.github.com/repos/johndoe/example_repo/statuses/{sha}", 120 | "subscribers_url": "https://api.github.com/repos/johndoe/example_repo/subscribers", 121 | "subscription_url": "https://api.github.com/repos/johndoe/example_repo/subscription", 122 | "svn_url": "https://github.com/johndoe/example_repo", 123 | "tags_url": "https://api.github.com/repos/johndoe/example_repo/tags", 124 | "teams_url": "https://api.github.com/repos/johndoe/example_repo/teams", 125 | "trees_url": "https://api.github.com/repos/johndoe/example_repo/git/trees{/sha}", 126 | "updated_at": "2026-09-01T22:40:48Z", 127 | "url": "https://github.com/johndoe/example_repo", 128 | "watchers": 1, 129 | "watchers_count": 1 130 | }, 131 | "sender": { 132 | "avatar_url": "https://avatars.githubusercontent.com/u/27847622?v=4", 133 | "events_url": "https://api.github.com/users/johndoe/events{/privacy}", 134 | "followers_url": "https://api.github.com/users/johndoe/followers", 135 | "following_url": "https://api.github.com/users/johndoe/following{/other_user}", 136 | "gists_url": "https://api.github.com/users/johndoe/gists{/gist_id}", 137 | "gravatar_id": "", 138 | "html_url": "https://github.com/johndoe", 139 | "id": 27847622, 140 | "login": "johndoe", 141 | "node_id": "MDQ6VXNlcjI3ODQ3NjIy", 142 | "organizations_url": "https://api.github.com/users/johndoe/orgs", 143 | "received_events_url": "https://api.github.com/users/johndoe/received_events", 144 | "repos_url": "https://api.github.com/users/johndoe/repos", 145 | "site_admin": false, 146 | "starred_url": "https://api.github.com/users/johndoe/starred{/owner}{/repo}", 147 | "subscriptions_url": "https://api.github.com/users/johndoe/subscriptions", 148 | "type": "User", 149 | "url": "https://api.github.com/users/johndoe" 150 | } 151 | } 152 | -------------------------------------------------------------------------------- /tests/webhooks.test.js: -------------------------------------------------------------------------------- 1 | test("get change log", async () => { 2 | const { getChangeLog } = require("../src/webhooks"); 3 | const payload = require("./mocks/github_webhook_full.json"); 4 | 5 | expect(getChangeLog(payload, false, false)).toMatchSnapshot(); 6 | }); 7 | 8 | test("get change log with censor username", async () => { 9 | const { getChangeLog } = require("../src/webhooks"); 10 | const payload = require("./mocks/github_webhook_full.json"); 11 | 12 | expect(getChangeLog(payload, false, true)).toMatchSnapshot(); 13 | }); 14 | 15 | test("get change log with hiding links", async () => { 16 | const { getChangeLog } = require("../src/webhooks"); 17 | const payload = require("./mocks/github_webhook_full.json"); 18 | 19 | expect(getChangeLog(payload, true, false)).toMatchSnapshot(); 20 | }); 21 | 22 | test("get change log with hiding links and censor username", async () => { 23 | const { getChangeLog } = require("../src/webhooks"); 24 | const payload = require("./mocks/github_webhook_full.json"); 25 | 26 | expect(getChangeLog(payload, true, true)).toMatchSnapshot(); 27 | }); 28 | 29 | test("send webhook", async () => { 30 | // Arrange 31 | const webhooks = require("../src/webhooks"); 32 | const discord = require("discord.js"); 33 | const sendWebhook = jest.fn(() => { 34 | return { 35 | send: jest.fn().mockResolvedValue(null), 36 | }; 37 | }); 38 | discord.WebhookClient = sendWebhook; 39 | discord.Client = jest.fn(); 40 | discord.EmbedBuilder = jest.fn(() => { 41 | return { 42 | setURL: jest.fn().mockReturnThis(), 43 | setColor: jest.fn().mockReturnThis(), 44 | setTitle: jest.fn().mockReturnThis(), 45 | setDescription: jest.fn().mockReturnThis(), 46 | setTimestamp: jest.fn().mockReturnThis(), 47 | }; 48 | }); 49 | const payload = require("./mocks/github_webhook_full.json"); 50 | 51 | // Act 52 | const data = await webhooks.send( 53 | "https://discord.com/api/webhooks/123321123321/blah", 54 | payload, 55 | false, 56 | false, 57 | "blue", 58 | ); 59 | 60 | // Assert 61 | expect(sendWebhook).toBeCalled(); 62 | }); 63 | 64 | test("send failed webhook", async () => { 65 | // Arrange 66 | const webhooks = require("../src/webhooks"); 67 | const discord = require("discord.js"); 68 | discord.WebhookClient = jest.fn(() => { 69 | return { 70 | send: jest.fn().mockRejectedValue(new Error()), 71 | }; 72 | }); 73 | discord.Client = jest.fn(); 74 | discord.EmbedBuilder = jest.fn(() => { 75 | return { 76 | setURL: jest.fn().mockReturnThis(), 77 | setColor: jest.fn().mockReturnThis(), 78 | setTitle: jest.fn().mockReturnThis(), 79 | setDescription: jest.fn().mockReturnThis(), 80 | setTimestamp: jest.fn().mockReturnThis(), 81 | }; 82 | }); 83 | const payload = require("./mocks/github_webhook_full.json"); 84 | 85 | try { 86 | // Act 87 | await webhooks.send( 88 | "https://discord.com/api/webhooks/913404819069345793/MF4mRyPECq9h4KI64B-UomFCcF1fZ1Ka_EnsQ89Hs0e0iaRc3migPGYdirz8odcpt2Wv", 89 | payload, 90 | false, 91 | false, 92 | "blue", 93 | ); 94 | } catch (error) { 95 | // Assert 96 | expect(error).toBeInstanceOf(Error); 97 | } 98 | }); 99 | --------------------------------------------------------------------------------