From 38c2f62bdfd204bedb7f7d5afed483666b574f8e Mon Sep 17 00:00:00 2001 From: Zack Koppert Date: Mon, 27 Apr 2020 15:11:10 -0700 Subject: [PATCH 01/18] Create CODE_OF_CONDUCT.md --- CODE_OF_CONDUCT.md | 76 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..4a2121f0 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,76 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at opensource@github.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq From e6da26de0faf3bde7c773db23259f03ccc96e508 Mon Sep 17 00:00:00 2001 From: Zack Koppert Date: Tue, 28 Apr 2020 09:27:24 -0700 Subject: [PATCH 02/18] Add initial security policy Signed-off-by: Zack Koppert --- SECURITY.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 SECURITY.md diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000..f0b196fb --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,3 @@ +If you discover a security issue in this repo, please submit it through the [GitHub Security Bug Bounty](https://hackerone.com/github) + +Thanks for helping make GitHub Actions safe for everyone. From 2125c794d3a8012dd7e1e5c7b6ee514cb70bda38 Mon Sep 17 00:00:00 2001 From: Zack Koppert Date: Tue, 28 Apr 2020 10:51:03 -0700 Subject: [PATCH 03/18] Update bare url to link --- CODE_OF_CONDUCT.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 4a2121f0..540565d1 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -73,4 +73,4 @@ available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.ht [homepage]: https://www.contributor-covenant.org For answers to common questions about this code of conduct, see -https://www.contributor-covenant.org/faq +[https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq) From 4de983ed12275756acca0d586ea5299c74335fdc Mon Sep 17 00:00:00 2001 From: Zack Koppert Date: Tue, 28 Apr 2020 11:09:51 -0700 Subject: [PATCH 04/18] Add header --- SECURITY.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/SECURITY.md b/SECURITY.md index f0b196fb..2613106d 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,3 +1,5 @@ +# Security Policy + If you discover a security issue in this repo, please submit it through the [GitHub Security Bug Bounty](https://hackerone.com/github) Thanks for helping make GitHub Actions safe for everyone. From faf5df24bed43f5fc02c6bbbf99a3a04f9639cfe Mon Sep 17 00:00:00 2001 From: Zack Koppert Date: Tue, 28 Apr 2020 11:15:43 -0700 Subject: [PATCH 05/18] another bare url fix --- CODE_OF_CONDUCT.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 540565d1..bda24167 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -68,7 +68,7 @@ members of the project's leadership. ## Attribution This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html +available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html) [homepage]: https://www.contributor-covenant.org From 6d0e39238019cf5be2cc804d44768e7e010c0c2a Mon Sep 17 00:00:00 2001 From: Zack Koppert Date: Tue, 28 Apr 2020 11:29:02 -0700 Subject: [PATCH 06/18] Change to MIT license Signed-off-by: Zack Koppert --- LICENSE | 686 ++------------------------------------------------------ 1 file changed, 17 insertions(+), 669 deletions(-) diff --git a/LICENSE b/LICENSE index f288702d..52e90a81 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +1,22 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 +MIT License - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. +Copyright (c) 2020 GitHub - Preamble +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: - The GNU General Public License is a free, copyleft license for -software and other kinds of works. +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. From b1825125e343ba0c016bd25381937986ab2a11c7 Mon Sep 17 00:00:00 2001 From: Zack Koppert Date: Tue, 28 Apr 2020 11:52:11 -0700 Subject: [PATCH 07/18] Start a Releasing section --- .github/CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index e5f0de9a..188f5fa2 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -29,6 +29,11 @@ Work in Progress pull requests are also welcome to get feedback early on, or if - Create a branch with a name that identifies the user and nature of the changes (similar to `user/branch-purpose`) - Open a pull request and request a review from a member of the appropriate `@github/services-account-engineering` and/or `@github/services-engineering` teams +## Releasing +If you are the current maintainer of this action: +1. + + ## Resources - [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) - [Using Pull Requests](https://help.github.com/articles/about-pull-requests/) From 337e37a76f81badd3f488b34513e0782f682c5b3 Mon Sep 17 00:00:00 2001 From: Zack Koppert Date: Tue, 28 Apr 2020 11:55:15 -0700 Subject: [PATCH 08/18] Specify license type --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index edee40f7..3541cb18 100644 --- a/README.md +++ b/README.md @@ -178,4 +178,4 @@ If you would like to help contribute to this **GitHub** Action, please see [CONT -------------------------------------------------------------------------------- ### License -- [License](https://github.com/github/super-linter/blob/master/LICENSE) +- [MIT License](https://github.com/github/super-linter/blob/master/LICENSE) From 341a3be2dd344077eec51e5d33c2820ccc202bfe Mon Sep 17 00:00:00 2001 From: Lucas Gravley <29484535+admiralAwkbar@users.noreply.github.com> Date: Wed, 29 Apr 2020 07:48:12 -0500 Subject: [PATCH 09/18] adding details --- .github/CONTRIBUTING.md | 5 +++-- .github/workflows/stack-linter.yml | 2 ++ 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 188f5fa2..1e08b557 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -31,8 +31,9 @@ Work in Progress pull requests are also welcome to get feedback early on, or if ## Releasing If you are the current maintainer of this action: -1. - +1. Create a [Tag](https://stackoverflow.com/questions/18216991/create-a-tag-in-a-github-repository) +2. Draft [Release](https://help.github.com/en/github/administering-a-repository/managing-releases-in-a-repository) document explaining details of Release +3. Look for approval from [CODEOWNERS](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners) ## Resources - [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) diff --git a/.github/workflows/stack-linter.yml b/.github/workflows/stack-linter.yml index ac561c2f..1b3b527d 100644 --- a/.github/workflows/stack-linter.yml +++ b/.github/workflows/stack-linter.yml @@ -42,3 +42,5 @@ jobs: ################################ - name: Lint Code Base uses: docker://admiralawkbar/super-linter:latest + env: + VALIDATE_ALL_CODEBASE: false From 9d31017221c42eb6fcb011fc21035869c5a17921 Mon Sep 17 00:00:00 2001 From: Lucas Gravley <29484535+admiralAwkbar@users.noreply.github.com> Date: Thu, 30 Apr 2020 08:32:49 -0500 Subject: [PATCH 10/18] adding deps --- docs/dependent-licenses.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 docs/dependent-licenses.md diff --git a/docs/dependent-licenses.md b/docs/dependent-licenses.md new file mode 100644 index 00000000..d057600c --- /dev/null +++ b/docs/dependent-licenses.md @@ -0,0 +1,19 @@ +# Dependent Licenses + +Below are the underlying technologies used in the **GitHub Super-Linter**. +All linkage should point directly to the license. + +- [Ansible-Lint](https://github.com/ansible/ansible-lint/blob/master/LICENSE) +- [coffeelint](https://github.com/clutchski/coffeelint/blob/master/LICENSE) +- [dockerfilelint](https://github.com/replicatedhq/dockerfilelint/blob/master/LICENSE) +- [eslint](https://github.com/eslint/eslint/blob/master/LICENSE) +- [golangci-lint](https://github.com/golangci/golangci-lint/blob/master/LICENSE) +- [jsonlint](https://github.com/zaach/jsonlint) + - **Note:** Public NPM Package, but no license +- [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli/blob/master/LICENSE) +- [pylint](https://github.com/PyCQA/pylint/blob/master/COPYING) +- [rubocop](https://github.com/rubocop-hq/rubocop/blob/master/LICENSE.txt) +- [shellcheck](https://github.com/koalaman/shellcheck/blob/master/LICENSE) +- [tflint](https://github.com/terraform-linters/tflint/blob/master/LICENSE) +- [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint/blob/master/LICENSE) +- [yamllint](https://github.com/adrienverge/yamllint/blob/master/LICENSE) From 7975846c3cc9d084a98a4e06711bc4ecd24ada13 Mon Sep 17 00:00:00 2001 From: Lucas Gravley <29484535+admiralAwkbar@users.noreply.github.com> Date: Thu, 30 Apr 2020 08:53:10 -0500 Subject: [PATCH 11/18] adding all of them --- docs/dependent-licenses.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/dependent-licenses.md b/docs/dependent-licenses.md index d057600c..7f10a0bc 100644 --- a/docs/dependent-licenses.md +++ b/docs/dependent-licenses.md @@ -4,16 +4,35 @@ Below are the underlying technologies used in the **GitHub Super-Linter**. All linkage should point directly to the license. - [Ansible-Lint](https://github.com/ansible/ansible-lint/blob/master/LICENSE) +- [babel-eslint](https://github.com/babel/babel-eslint/blob/master/LICENSE) - [coffeelint](https://github.com/clutchski/coffeelint/blob/master/LICENSE) +- [curl](https://github.com/curl/curl/blob/master/COPYING) - [dockerfilelint](https://github.com/replicatedhq/dockerfilelint/blob/master/LICENSE) - [eslint](https://github.com/eslint/eslint/blob/master/LICENSE) +- [file](https://github.com/file/file/blob/master/COPYING) +- [gcc](https://gcc.gnu.org/) +- [git-lfs](https://github.com/git-lfs/git-lfs/blob/master/LICENSE.md) +- [go](https://golang.org/project/) - [golangci-lint](https://github.com/golangci/golangci-lint/blob/master/LICENSE) - [jsonlint](https://github.com/zaach/jsonlint) - **Note:** Public NPM Package, but no license +- [jq](https://github.com/stedolan/jq/blob/master/COPYING) +- [libxml2](http://xmlsoft.org/) +- [make](https://www.gnu.org/software/make/) - [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli/blob/master/LICENSE) +- [musl-dev](https://pkgs.alpinelinux.org/package/v3.3/main/x86/musl-dev) +- [npm](https://github.com/npm/cli/blob/latest/LICENSE) +- [nodejs](https://github.com/nodejs/node/blob/master/LICENSE) +- [perl](https://github.com/Perl/perl5/blob/blead/Copying) +- [prettier](https://github.com/prettier/prettier/blob/master/LICENSE) +- [prettyjson](https://github.com/rafeca/prettyjson/blob/master/LICENSE) - [pylint](https://github.com/PyCQA/pylint/blob/master/COPYING) +- [py3setup-tools](https://pkgs.alpinelinux.org/package/edge/main/x86/py3-setuptools) - [rubocop](https://github.com/rubocop-hq/rubocop/blob/master/LICENSE.txt) +- [ruby](https://en.wikipedia.org/wiki/Ruby_License) - [shellcheck](https://github.com/koalaman/shellcheck/blob/master/LICENSE) +- [standard](https://github.com/standard/standard/blob/master/LICENSE) - [tflint](https://github.com/terraform-linters/tflint/blob/master/LICENSE) - [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint/blob/master/LICENSE) - [yamllint](https://github.com/adrienverge/yamllint/blob/master/LICENSE) +- [yq](https://github.com/mikefarah/yq/blob/master/LICENSE) From 056fbd49e7c30a2779a2e8a7c3c9993524fc404a Mon Sep 17 00:00:00 2001 From: Lucas Gravley <29484535+admiralAwkbar@users.noreply.github.com> Date: Thu, 30 Apr 2020 09:06:20 -0500 Subject: [PATCH 12/18] update readme --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3541cb18..f966b88c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,14 @@ # Super-Linter This repository is for the **GitHub Action** to run a **Super-Linter**. -Developers on **GitHub** can call this Action to lint their code base with the following list of linters: +It is a simple combination on various linters, written in `bash`, to help validate your source code. + +The end goal of this tool: +- Prevent broken code from being uploaded to *master* branches +- Help establish coding best practices across multiple languages +- Build guidelines for code layout and format +- Automate the process to help streamline code reviews + +Developers on **GitHub** can call the **GitHub Action** to lint their code base with the following list of linters: | *Language* | *Linter* | |---|---| @@ -172,6 +180,12 @@ The **Super-Linter** has *CI/CT/CD* configured utilizing **GitHub** Actions. - When the Pull Request is merged to master, the **Super-Linter** **Docker** container is then updated and deployed with the new codebase - **Note:** The branches **Docker** container is also removed from **DockerHub** to cleanup after itself +## Limitations +Below are a list of the known limitations for the **Github Super-Linter**: +- Due to being completely packaged at run time, you will not be able to update dependancies or change versions of the enclosed linters and binaries +- Reading additional details from `package.json` are not read by the **Github Super-Linter** +- Downloading additional codebases as dependencies from private repositories will fail due to lack of permissions + ## How to contribute If you would like to help contribute to this **GitHub** Action, please see [CONTRIBUTING](https://github.com/github/super-linter/blob/master/.github/CONTRIBUTING.md) From 0a45a03aa7597bf3b36ce59e3a742781d7999ec3 Mon Sep 17 00:00:00 2001 From: Lucas Gravley <29484535+admiralAwkbar@users.noreply.github.com> Date: Thu, 30 Apr 2020 09:09:43 -0500 Subject: [PATCH 13/18] adding templates --- .github/ISSUE_TEMPLATE/BLANK.md | 6 ++++ .github/ISSUE_TEMPLATE/ENHANCEMENT-REQUEST.md | 31 +++++++++++++++++++ .github/ISSUE_TEMPLATE/ISSUE.md | 22 +++++++++++++ 3 files changed, 59 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/BLANK.md create mode 100644 .github/ISSUE_TEMPLATE/ENHANCEMENT-REQUEST.md create mode 100644 .github/ISSUE_TEMPLATE/ISSUE.md diff --git a/.github/ISSUE_TEMPLATE/BLANK.md b/.github/ISSUE_TEMPLATE/BLANK.md new file mode 100644 index 00000000..0cea7fe6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BLANK.md @@ -0,0 +1,6 @@ + +--- +name: Blank issue +about: Freeform issue, can be used for any topic. +--- + diff --git a/.github/ISSUE_TEMPLATE/ENHANCEMENT-REQUEST.md b/.github/ISSUE_TEMPLATE/ENHANCEMENT-REQUEST.md new file mode 100644 index 00000000..039816f9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ENHANCEMENT-REQUEST.md @@ -0,0 +1,31 @@ + +--- +name: Enhancement Request +about: Used for requesting enhancements to the GitHub Super-Linter + +--- + + +**What is the current behavior, if applicable?** + + +**What is the desired behavior?** + + +**Your impression of priority / how important this request is** + + - [ ] Critical: Can't use the tool without it. + - [ ] Business Critical: Immediate opportunity to win business with this feature + - [ ] Important: Will significantly enhance the overall utility of the demo + - [ ] Nice to have: self-explanatory + +**Business case or other information justifying priority** + +**Agreed upon priority** + - [ ] Critical: Can't use the tool without it. + - [ ] Business Critical: Immediate opportunity to win business with this feature + - [ ] Important: Will significantly enhance the overall utility of the demo + - [ ] Nice to have: self-explanatory + +**Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc) + diff --git a/.github/ISSUE_TEMPLATE/ISSUE.md b/.github/ISSUE_TEMPLATE/ISSUE.md new file mode 100644 index 00000000..fa84f7fd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ISSUE.md @@ -0,0 +1,22 @@ + +--- +name: Issue Template +about: Used for creating issues about the GitHub Super-Linter + +--- + +--- +### Issue with GitHub Super-Linter + +--- +**Branch/Version:** Example: Master + +--- +**How to Reproduce:** Example: tried to build it + +--- +**Expected Behavior:** Example: It should have worked + +--- +**Additional Details:** Example: only happens half past midnight + From d81238019a91f9361f5f71b1043b44a84ca0480f Mon Sep 17 00:00:00 2001 From: Lucas Gravley <29484535+admiralAwkbar@users.noreply.github.com> Date: Thu, 30 Apr 2020 11:31:55 -0500 Subject: [PATCH 14/18] adding possum --- lib/linter.sh | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/lib/linter.sh b/lib/linter.sh index a794626e..f3b4a714 100755 --- a/lib/linter.sh +++ b/lib/linter.sh @@ -157,6 +157,38 @@ ERRORS_FOUND_TERRAFORM=0 # Count of errors found #### Function Header ########################################################### Header() { + echo ' : :' + echo ' __ | | _,_' + echo ' ( ~~^-l_____],.-~ /' + echo ' \ ")\ "^k. (_,-"' + echo ' `>._ \ _ `\ \' + echo ' _.-~/ ^k. (0) ` (0' + echo ' .-~ { ~` ~ ..T' + echo ' / . "-.. _.-/' + echo ' / Y . "T' + echo ' Y l ~-./l_' + echo ' | \ . .<' + echo ' | `-.._ __,/"r' + echo ' l .-~~"-. / I' + echo ' Y Y "~[ |' + echo ' \ \_.^--, [' + echo ' \ _~> |' + echo ' \ ___)--~ |' + echo ' ^. : l' + echo ' ^. __.j |' + echo ' Y I |' + echo ' l l I' + echo ' Y\__/\ |' + echo ' \ ^. |' + echo ' \___/~-^.' + echo ' ^. ~"--.,_' + echo ' |~-.___/ ~-.' + echo ' | ~Y--.,__/ .' + echo ' : : "x \' + echo ' \__/ \.' + echo ' \ ]' + echo ' ^..^' + echo ' V' echo "" echo "---------------------------------------------" echo "--- Github Actions Multi Language Linter ----" From afbbac9b6071bfad06030f5a8bfc17d3c91cc9c2 Mon Sep 17 00:00:00 2001 From: Lucas Gravley <29484535+admiralAwkbar@users.noreply.github.com> Date: Thu, 30 Apr 2020 11:40:22 -0500 Subject: [PATCH 15/18] Adding cleanup --- lib/linter.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/lib/linter.sh b/lib/linter.sh index f3b4a714..15a6da41 100755 --- a/lib/linter.sh +++ b/lib/linter.sh @@ -1,4 +1,5 @@ #!/bin/bash +# shellcheck disable=SC1003 ################################################################################ ################################################################################ From 91f67bf0d3f4c4368b7adeead10c0d9e3ed69f9d Mon Sep 17 00:00:00 2001 From: Lucas Gravley <29484535+admiralAwkbar@users.noreply.github.com> Date: Thu, 30 Apr 2020 11:42:34 -0500 Subject: [PATCH 16/18] it hates the possum --- lib/linter.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/linter.sh b/lib/linter.sh index 15a6da41..8a388309 100755 --- a/lib/linter.sh +++ b/lib/linter.sh @@ -1,5 +1,5 @@ #!/bin/bash -# shellcheck disable=SC1003 +# shellcheck disable=SC1003,SC2016 ################################################################################ ################################################################################ From 933ad55ac09ba8e60f4bd75ca1bdefd0f34ce772 Mon Sep 17 00:00:00 2001 From: Zack Koppert Date: Thu, 30 Apr 2020 09:52:13 -0700 Subject: [PATCH 17/18] Removing deps --- docs/dependent-licenses.md | 38 -------------------------------------- 1 file changed, 38 deletions(-) delete mode 100644 docs/dependent-licenses.md diff --git a/docs/dependent-licenses.md b/docs/dependent-licenses.md deleted file mode 100644 index 7f10a0bc..00000000 --- a/docs/dependent-licenses.md +++ /dev/null @@ -1,38 +0,0 @@ -# Dependent Licenses - -Below are the underlying technologies used in the **GitHub Super-Linter**. -All linkage should point directly to the license. - -- [Ansible-Lint](https://github.com/ansible/ansible-lint/blob/master/LICENSE) -- [babel-eslint](https://github.com/babel/babel-eslint/blob/master/LICENSE) -- [coffeelint](https://github.com/clutchski/coffeelint/blob/master/LICENSE) -- [curl](https://github.com/curl/curl/blob/master/COPYING) -- [dockerfilelint](https://github.com/replicatedhq/dockerfilelint/blob/master/LICENSE) -- [eslint](https://github.com/eslint/eslint/blob/master/LICENSE) -- [file](https://github.com/file/file/blob/master/COPYING) -- [gcc](https://gcc.gnu.org/) -- [git-lfs](https://github.com/git-lfs/git-lfs/blob/master/LICENSE.md) -- [go](https://golang.org/project/) -- [golangci-lint](https://github.com/golangci/golangci-lint/blob/master/LICENSE) -- [jsonlint](https://github.com/zaach/jsonlint) - - **Note:** Public NPM Package, but no license -- [jq](https://github.com/stedolan/jq/blob/master/COPYING) -- [libxml2](http://xmlsoft.org/) -- [make](https://www.gnu.org/software/make/) -- [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli/blob/master/LICENSE) -- [musl-dev](https://pkgs.alpinelinux.org/package/v3.3/main/x86/musl-dev) -- [npm](https://github.com/npm/cli/blob/latest/LICENSE) -- [nodejs](https://github.com/nodejs/node/blob/master/LICENSE) -- [perl](https://github.com/Perl/perl5/blob/blead/Copying) -- [prettier](https://github.com/prettier/prettier/blob/master/LICENSE) -- [prettyjson](https://github.com/rafeca/prettyjson/blob/master/LICENSE) -- [pylint](https://github.com/PyCQA/pylint/blob/master/COPYING) -- [py3setup-tools](https://pkgs.alpinelinux.org/package/edge/main/x86/py3-setuptools) -- [rubocop](https://github.com/rubocop-hq/rubocop/blob/master/LICENSE.txt) -- [ruby](https://en.wikipedia.org/wiki/Ruby_License) -- [shellcheck](https://github.com/koalaman/shellcheck/blob/master/LICENSE) -- [standard](https://github.com/standard/standard/blob/master/LICENSE) -- [tflint](https://github.com/terraform-linters/tflint/blob/master/LICENSE) -- [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint/blob/master/LICENSE) -- [yamllint](https://github.com/adrienverge/yamllint/blob/master/LICENSE) -- [yq](https://github.com/mikefarah/yq/blob/master/LICENSE) From 9aa906124126a57c9554b20f1e94e0a642956536 Mon Sep 17 00:00:00 2001 From: Zack Koppert Date: Thu, 30 Apr 2020 11:33:37 -0700 Subject: [PATCH 18/18] Add wiki reference --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index f966b88c..49059a6f 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,7 @@ Developers on **GitHub** can call the **GitHub Action** to lint their code base To use this **GitHub** Action you will need to complete the following: - Add the **GitHub** Action: **Super-Linter** to your current **GitHub** Actions workflow - Enjoy your more *stable*, and *cleaner* code base +- Check out the [Wiki](https://github.com/github/super-linter/wiki) for customization options ### Example connecting GitHub Action Workflow In your repository you should have a `.github/workflows` folder with **GitHub** Action similar to below: