Compare commits
20 Commits
d9e446553c
...
0.0.2
Author | SHA1 | Date | |
---|---|---|---|
c476591e00 | |||
aee3dbad18 | |||
0fa845b3ff | |||
6aaa82efa4 | |||
e13d7f6fe4 | |||
ee328d8d46 | |||
b000ad4a20 | |||
37a29e4524 | |||
fa1856ed8f | |||
4dcb662659 | |||
5aae615920 | |||
928bc414e4 | |||
c29a9f6827 | |||
e2ce0926db | |||
e12a348054 | |||
90bb429734 | |||
9f1538fed4 | |||
49117d619a | |||
4fb04e66bd | |||
8c0ce3abe8 |
3
.env.dist
Normal file
3
.env.dist
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
GITEA_RELEASE_PROJECT=
|
||||||
|
GITEA_RELEASE_ORG=
|
||||||
|
GITEA_RELEASE_USERNAME=
|
5
.gitignore
vendored
5
.gitignore
vendored
@ -1,3 +1,6 @@
|
|||||||
/coverage
|
/coverage
|
||||||
/bin
|
/bin
|
||||||
rice-box.go
|
rice-box.go
|
||||||
|
/release
|
||||||
|
/vendor
|
||||||
|
/.env
|
674
LICENSE
Normal file
674
LICENSE
Normal file
@ -0,0 +1,674 @@
|
|||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
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 <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
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
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
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
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
14
Makefile
14
Makefile
@ -13,13 +13,19 @@ deps:
|
|||||||
go get -u github.com/cortesi/modd/cmd/modd
|
go get -u github.com/cortesi/modd/cmd/modd
|
||||||
go get -u github.com/golangci/golangci-lint/cmd/golangci-lint
|
go get -u github.com/golangci/golangci-lint/cmd/golangci-lint
|
||||||
|
|
||||||
coverage:
|
|
||||||
@script/coverage
|
|
||||||
|
|
||||||
lint:
|
lint:
|
||||||
golangci-lint run --tests=false --enable-all
|
golangci-lint run --tests=false --enable-all
|
||||||
|
|
||||||
|
vendor:
|
||||||
|
go mod vendor
|
||||||
|
|
||||||
|
release: clean vendor
|
||||||
|
./misc/script/release
|
||||||
|
|
||||||
|
gitea-release:
|
||||||
|
./misc/script/gitea-release
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
rm -rf ./bin ./release ./coverage
|
rm -rf ./bin ./release ./coverage
|
||||||
|
|
||||||
.PHONY: test clean lint coverage doc
|
.PHONY: test clean lint coverage doc release vendor
|
44
README.md
44
README.md
@ -1,7 +1,5 @@
|
|||||||
# Scaffold
|
# Scaffold
|
||||||
|
|
||||||
> **/!\\** Statut: préalpha
|
|
||||||
|
|
||||||
Utilitaire de génération d'arborescence de fichiers à partir de projets "modèles" distants/locaux.
|
Utilitaire de génération d'arborescence de fichiers à partir de projets "modèles" distants/locaux.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
@ -14,10 +12,48 @@ go install forge.cadoles.com/wpetit/scaffold/cmd/scaffold
|
|||||||
|
|
||||||
### À partir des binaires
|
### À partir des binaires
|
||||||
|
|
||||||
|
1. [Télécharger la dernière version du binaire correspondant à votre plateforme](https://forge.cadoles.com/wpetit/scaffold/releases) (dernière version stable: 0.0.2)
|
||||||
|
2. Extraire l'archive et place le binaire `bin/scaffold` dans votre `$PATH` (par exemple dans le répertoire `/usr/local/bin`)
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
```
|
```
|
||||||
TODO
|
NAME:
|
||||||
|
scaffold - generate/update directory tree from template
|
||||||
|
|
||||||
|
USAGE:
|
||||||
|
scaffold [global options] command [command options] [arguments...]
|
||||||
|
|
||||||
|
COMMANDS:
|
||||||
|
from, n generate a new project from a given template url
|
||||||
|
help, h Shows a list of commands or help for one command
|
||||||
|
|
||||||
|
GLOBAL OPTIONS:
|
||||||
|
--help, -h show help (default: false)
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Commandes
|
||||||
|
|
||||||
|
#### `from`
|
||||||
|
|
||||||
|
```
|
||||||
|
NAME:
|
||||||
|
scaffold from - generate a new project from a given template url
|
||||||
|
|
||||||
|
USAGE:
|
||||||
|
scaffold from [command options] <URL>
|
||||||
|
|
||||||
|
OPTIONS:
|
||||||
|
--directory DIR, -d DIR Set destination to DIR (default: "./")
|
||||||
|
--manifest FILE, -m FILE The scaffold manifest FILE (default: "scaffold.yml")
|
||||||
|
--ignore value, -i value Ignore files matching pattern (default: ".git", ".git/**", "./.git/**/*")
|
||||||
|
--help, -h show help (default: false)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
- [Format du fichier `scaffold.yml`](./doc/scaffold_file_format.md)
|
||||||
|
|
||||||
## Licence
|
## Licence
|
||||||
|
|
||||||
GPL-3.0
|
[GPL-3.0](./LICENSE)
|
@ -16,7 +16,7 @@ func main() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if err := app.Run(os.Args); err != nil {
|
if err := app.Run(os.Args); err != nil {
|
||||||
fmt.Printf("%+v", err)
|
fmt.Printf("%+v\n", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
3
doc/create_projet_template.md
Normal file
3
doc/create_projet_template.md
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
# Créer un nouveau modèle de projet
|
||||||
|
|
||||||
|
Un modèle de projet `scaffold` est un simple répertoire (ou dépôt Git) contenant à sa racine un fichier `scaffold.yml`.
|
0
doc/generate_project_from_template.md
Normal file
0
doc/generate_project_from_template.md
Normal file
71
doc/scaffold_file_format.md
Normal file
71
doc/scaffold_file_format.md
Normal file
@ -0,0 +1,71 @@
|
|||||||
|
## Format du fichier `scaffold.yml`
|
||||||
|
|
||||||
|
Le fichier `scaffold.yml` est au format [YAML](https://yaml.org/). C'est ce fichier qui permet de définir les données à injecter dans les modèles lors de la génération d'un nouveau projet avec la commande `scaffold from ...`.
|
||||||
|
|
||||||
|
**Schéma**
|
||||||
|
|
||||||
|
``` yaml
|
||||||
|
# Version du format de fichier. Actuellement, la seule valeur possible est 1.
|
||||||
|
version: 1
|
||||||
|
|
||||||
|
# Liste des variables à injecter dans les modèles de fichier
|
||||||
|
vars:
|
||||||
|
- <Var>
|
||||||
|
# - <Var>...
|
||||||
|
```
|
||||||
|
|
||||||
|
## Types
|
||||||
|
|
||||||
|
### `<Var>`
|
||||||
|
|
||||||
|
Définition d'une variable injectable dans les modèles de fichier.
|
||||||
|
|
||||||
|
**Schéma**
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Type de la variable. Actuellement, la seul valeur possible est "string"
|
||||||
|
type: "string"
|
||||||
|
|
||||||
|
# Nom de la variable. C'est le nom qui permettra d'accéder à la valeur de la variable dans les modèles de fichiers.
|
||||||
|
name: <string>
|
||||||
|
|
||||||
|
# Description de la variable. C'est le texte qui sera affiché dans l'invite de commande au moment de la génération de l'arborescence de fichiers.
|
||||||
|
description: <string>
|
||||||
|
|
||||||
|
# Liste des contraintes appliquées à la valeur de la variable. La valeur est considérée comme invalide tant que l'ensemble des contraintes ne sont pas remplies.
|
||||||
|
constraints:
|
||||||
|
- <Constraint>
|
||||||
|
# - <Constraint>...
|
||||||
|
```
|
||||||
|
|
||||||
|
### `<Constraint>`
|
||||||
|
|
||||||
|
Définition d'une contrainte appliquée à la valeur d'une variable.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Règle de validation à appliquer à la valeur entrée par l'utilisateur.
|
||||||
|
rule: <Rule>
|
||||||
|
|
||||||
|
# Message à afficher à l'utilisateur si la règle de validation concorde avec la valeur entrée par celui ci.
|
||||||
|
message: <string>
|
||||||
|
```
|
||||||
|
|
||||||
|
**Exemple**
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Règle validant que la valeur ne doit pas être vide.
|
||||||
|
rule: Input == ""
|
||||||
|
message: Cette valeur ne peut être vide.
|
||||||
|
```
|
||||||
|
|
||||||
|
### `<Rule>`
|
||||||
|
|
||||||
|
Règle de validation d'une contrainte appliquée à une variable.
|
||||||
|
|
||||||
|
Ce n'est ni plus ni moins qu'une condition booléenne écrite avec la syntaxe proposée par la librairie [github.com/antonmedv/expr](https://github.com/antonmedv/expr/blob/master/docs/Language-Definition.md).
|
||||||
|
|
||||||
|
Voici les variables globales disponibles aux règles:
|
||||||
|
|
||||||
|
|Variable|Description|
|
||||||
|
|--------|-----------|
|
||||||
|
|`Input` |Valeur entrée par l'utilisateur|
|
2
go.mod
2
go.mod
@ -7,10 +7,12 @@ require (
|
|||||||
github.com/Masterminds/semver v1.5.0 // indirect
|
github.com/Masterminds/semver v1.5.0 // indirect
|
||||||
github.com/Masterminds/sprig v2.22.0+incompatible
|
github.com/Masterminds/sprig v2.22.0+incompatible
|
||||||
github.com/antonmedv/expr v1.4.5
|
github.com/antonmedv/expr v1.4.5
|
||||||
|
github.com/davecgh/go-spew v1.1.1
|
||||||
github.com/google/uuid v1.1.1 // indirect
|
github.com/google/uuid v1.1.1 // indirect
|
||||||
github.com/huandu/xstrings v1.3.0 // indirect
|
github.com/huandu/xstrings v1.3.0 // indirect
|
||||||
github.com/imdario/mergo v0.3.8 // indirect
|
github.com/imdario/mergo v0.3.8 // indirect
|
||||||
github.com/manifoldco/promptui v0.7.0
|
github.com/manifoldco/promptui v0.7.0
|
||||||
|
github.com/mattn/go-zglob v0.0.1
|
||||||
github.com/mitchellh/copystructure v1.0.0 // indirect
|
github.com/mitchellh/copystructure v1.0.0 // indirect
|
||||||
github.com/pkg/errors v0.9.1
|
github.com/pkg/errors v0.9.1
|
||||||
github.com/urfave/cli/v2 v2.1.1
|
github.com/urfave/cli/v2 v2.1.1
|
||||||
|
2
go.sum
2
go.sum
@ -67,6 +67,8 @@ github.com/mattn/go-colorable v0.0.9/go.mod h1:9vuHe8Xs5qXnSaW/c/ABM9alt+Vo+STaO
|
|||||||
github.com/mattn/go-isatty v0.0.4 h1:bnP0vzxcAdeI1zdubAl5PjU6zsERjGZb7raWodagDYs=
|
github.com/mattn/go-isatty v0.0.4 h1:bnP0vzxcAdeI1zdubAl5PjU6zsERjGZb7raWodagDYs=
|
||||||
github.com/mattn/go-isatty v0.0.4/go.mod h1:M+lRXTBqGeGNdLjl/ufCoiOlB5xdOkqRJdNxMWT7Zi4=
|
github.com/mattn/go-isatty v0.0.4/go.mod h1:M+lRXTBqGeGNdLjl/ufCoiOlB5xdOkqRJdNxMWT7Zi4=
|
||||||
github.com/mattn/go-runewidth v0.0.4/go.mod h1:LwmH8dsx7+W8Uxz3IHJYH5QSwggIsqBzpuz5H//U1FU=
|
github.com/mattn/go-runewidth v0.0.4/go.mod h1:LwmH8dsx7+W8Uxz3IHJYH5QSwggIsqBzpuz5H//U1FU=
|
||||||
|
github.com/mattn/go-zglob v0.0.1 h1:xsEx/XUoVlI6yXjqBK062zYhRTZltCNmYPx6v+8DNaY=
|
||||||
|
github.com/mattn/go-zglob v0.0.1/go.mod h1:9fxibJccNxU2cnpIKLRRFA7zX7qhkJIQWBb449FYHOo=
|
||||||
github.com/mitchellh/copystructure v1.0.0 h1:Laisrj+bAB6b/yJwB5Bt3ITZhGJdqmxquMKeZ+mmkFQ=
|
github.com/mitchellh/copystructure v1.0.0 h1:Laisrj+bAB6b/yJwB5Bt3ITZhGJdqmxquMKeZ+mmkFQ=
|
||||||
github.com/mitchellh/copystructure v1.0.0/go.mod h1:SNtv71yrdKgLRyLFxmLdkAbkKEFWgYaq1OVrnRcwhnw=
|
github.com/mitchellh/copystructure v1.0.0/go.mod h1:SNtv71yrdKgLRyLFxmLdkAbkKEFWgYaq1OVrnRcwhnw=
|
||||||
github.com/mitchellh/go-homedir v1.1.0 h1:lukF9ziXFxDFPkA1vsr5zpc1XuPDn/wFntq5mG+4E0Y=
|
github.com/mitchellh/go-homedir v1.1.0 h1:lukF9ziXFxDFPkA1vsr5zpc1XuPDn/wFntq5mG+4E0Y=
|
||||||
|
@ -4,6 +4,6 @@ import "github.com/urfave/cli/v2"
|
|||||||
|
|
||||||
func All() []*cli.Command {
|
func All() []*cli.Command {
|
||||||
return []*cli.Command{
|
return []*cli.Command{
|
||||||
newProjectCommand(),
|
fromCommand(),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
package command
|
package command
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"log"
|
"fmt"
|
||||||
"net/url"
|
"net/url"
|
||||||
"os"
|
"os"
|
||||||
|
|
||||||
@ -13,9 +13,9 @@ import (
|
|||||||
"github.com/urfave/cli/v2"
|
"github.com/urfave/cli/v2"
|
||||||
)
|
)
|
||||||
|
|
||||||
func newProjectCommand() *cli.Command {
|
func fromCommand() *cli.Command {
|
||||||
return &cli.Command{
|
return &cli.Command{
|
||||||
Name: "new",
|
Name: "from",
|
||||||
Aliases: []string{"n"},
|
Aliases: []string{"n"},
|
||||||
Usage: "generate a new project from a given template url",
|
Usage: "generate a new project from a given template url",
|
||||||
ArgsUsage: "<URL>",
|
ArgsUsage: "<URL>",
|
||||||
@ -32,12 +32,18 @@ func newProjectCommand() *cli.Command {
|
|||||||
Usage: "The scaffold manifest `FILE`",
|
Usage: "The scaffold manifest `FILE`",
|
||||||
Value: "scaffold.yml",
|
Value: "scaffold.yml",
|
||||||
},
|
},
|
||||||
|
&cli.StringSliceFlag{
|
||||||
|
Name: "ignore",
|
||||||
|
Aliases: []string{"i"},
|
||||||
|
Usage: "Ignore files matching pattern",
|
||||||
|
Value: cli.NewStringSlice(".git", ".git/**", "./.git/**/*"),
|
||||||
|
},
|
||||||
},
|
},
|
||||||
Action: newProjectAction,
|
Action: fromAction,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func newProjectAction(c *cli.Context) error {
|
func fromAction(c *cli.Context) error {
|
||||||
rawURL := c.Args().First()
|
rawURL := c.Args().First()
|
||||||
|
|
||||||
projectURL, err := url.Parse(rawURL)
|
projectURL, err := url.Parse(rawURL)
|
||||||
@ -59,6 +65,10 @@ func newProjectAction(c *cli.Context) error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if fetcher == nil {
|
||||||
|
return errors.Errorf("could not find any fetcher matching URL '%v'", projectURL)
|
||||||
|
}
|
||||||
|
|
||||||
vfs, err := fetcher.Fetch(projectURL)
|
vfs, err := fetcher.Fetch(projectURL)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return errors.Wrap(err, "could not fetch project")
|
return errors.Wrap(err, "could not fetch project")
|
||||||
@ -74,13 +84,13 @@ func newProjectAction(c *cli.Context) error {
|
|||||||
return errors.Wrapf(err, "could not read manifest '%s'", manifestPath)
|
return errors.Wrapf(err, "could not read manifest '%s'", manifestPath)
|
||||||
}
|
}
|
||||||
|
|
||||||
log.Println("Could not find scaffold manifest.")
|
fmt.Println("Could not find scaffold manifest.")
|
||||||
}
|
}
|
||||||
|
|
||||||
if manifestFile != nil {
|
if manifestFile != nil {
|
||||||
defer manifestFile.Close()
|
defer manifestFile.Close()
|
||||||
|
|
||||||
log.Println("Loading template scaffold manifest...")
|
fmt.Println("Loading scaffold manifest.")
|
||||||
|
|
||||||
manifest, err := template.Load(manifestFile)
|
manifest, err := template.Load(manifestFile)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@ -91,6 +101,7 @@ func newProjectAction(c *cli.Context) error {
|
|||||||
return errors.Wrapf(err, "could not validate manifest '%s'", manifestPath)
|
return errors.Wrapf(err, "could not validate manifest '%s'", manifestPath)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fmt.Println("Prompting for templates variables.")
|
||||||
if err := template.Prompt(manifest, templateData); err != nil {
|
if err := template.Prompt(manifest, templateData); err != nil {
|
||||||
return errors.Wrap(err, "could not prompt for template data")
|
return errors.Wrap(err, "could not prompt for template data")
|
||||||
}
|
}
|
||||||
@ -98,9 +109,22 @@ func newProjectAction(c *cli.Context) error {
|
|||||||
|
|
||||||
directory := c.String("directory")
|
directory := c.String("directory")
|
||||||
|
|
||||||
return template.CopyDir(vfs, ".", directory, &template.Option{
|
ignore := c.StringSlice("ignore")
|
||||||
TemplateData: templateData,
|
ignore = append(ignore, manifestPath)
|
||||||
TemplateExt: ".gotpl",
|
|
||||||
IgnorePatterns: []string{manifestPath},
|
fmt.Println("Generating project tree.")
|
||||||
|
|
||||||
|
err = template.CopyDir(vfs, ".", directory, &template.Option{
|
||||||
|
TemplateData: templateData,
|
||||||
|
TemplateExt: ".gotpl",
|
||||||
|
IgnorePatterns: ignore,
|
||||||
|
PreferredStrategy: template.Undefined,
|
||||||
})
|
})
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Println("Done.")
|
||||||
|
|
||||||
|
return nil
|
||||||
}
|
}
|
@ -1,8 +1,10 @@
|
|||||||
package project
|
package project
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"log"
|
"fmt"
|
||||||
"net/url"
|
"net/url"
|
||||||
|
"os"
|
||||||
|
"strings"
|
||||||
|
|
||||||
"github.com/pkg/errors"
|
"github.com/pkg/errors"
|
||||||
"gopkg.in/src-d/go-billy.v4"
|
"gopkg.in/src-d/go-billy.v4"
|
||||||
@ -15,6 +17,8 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
const GitScheme = "git"
|
const GitScheme = "git"
|
||||||
|
const HTTPScheme = "http"
|
||||||
|
const HTTPSScheme = "https"
|
||||||
|
|
||||||
type GitFetcher struct{}
|
type GitFetcher struct{}
|
||||||
|
|
||||||
@ -47,12 +51,13 @@ func (f *GitFetcher) Fetch(url *url.URL) (billy.Filesystem, error) {
|
|||||||
url.Fragment = ""
|
url.Fragment = ""
|
||||||
}
|
}
|
||||||
|
|
||||||
log.Printf("Cloning repository '%s'...", url.String())
|
fmt.Printf("Cloning repository '%s'.\n", url.String())
|
||||||
|
|
||||||
repo, err := git.Clone(memory.NewStorage(), fs, &git.CloneOptions{
|
repo, err := git.Clone(memory.NewStorage(), fs, &git.CloneOptions{
|
||||||
URL: url.String(),
|
URL: url.String(),
|
||||||
Auth: auth,
|
Auth: auth,
|
||||||
ReferenceName: branchName,
|
ReferenceName: branchName,
|
||||||
|
Progress: os.Stdout,
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if err == transport.ErrRepositoryNotFound {
|
if err == transport.ErrRepositoryNotFound {
|
||||||
@ -67,7 +72,7 @@ func (f *GitFetcher) Fetch(url *url.URL) (billy.Filesystem, error) {
|
|||||||
return nil, errors.Wrap(err, "could not retrieve worktree")
|
return nil, errors.Wrap(err, "could not retrieve worktree")
|
||||||
}
|
}
|
||||||
|
|
||||||
log.Printf("Checking out branch '%s'...", branchName)
|
fmt.Printf("Checking out branch '%s'.\n", branchName)
|
||||||
|
|
||||||
err = worktree.Checkout(&git.CheckoutOptions{
|
err = worktree.Checkout(&git.CheckoutOptions{
|
||||||
Force: true,
|
Force: true,
|
||||||
@ -85,6 +90,10 @@ func (f *GitFetcher) Match(url *url.URL) bool {
|
|||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (url.Scheme == HTTPSScheme || url.Scheme == HTTPScheme) && strings.HasSuffix(url.Path, ".git") {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
isFilesystemPath := isFilesystemPath(url.Path)
|
isFilesystemPath := isFilesystemPath(url.Path)
|
||||||
if url.Scheme == "" && !isFilesystemPath {
|
if url.Scheme == "" && !isFilesystemPath {
|
||||||
return true
|
return true
|
||||||
|
@ -4,6 +4,8 @@ import (
|
|||||||
"net/url"
|
"net/url"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
|
"gopkg.in/src-d/go-billy.v4/osfs"
|
||||||
|
|
||||||
"gopkg.in/src-d/go-billy.v4"
|
"gopkg.in/src-d/go-billy.v4"
|
||||||
)
|
)
|
||||||
|
|
||||||
@ -13,7 +15,7 @@ const FileScheme = "file"
|
|||||||
type LocalFetcher struct{}
|
type LocalFetcher struct{}
|
||||||
|
|
||||||
func (f *LocalFetcher) Fetch(url *url.URL) (billy.Filesystem, error) {
|
func (f *LocalFetcher) Fetch(url *url.URL) (billy.Filesystem, error) {
|
||||||
return nil, nil
|
return osfs.New(url.Path), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (f *LocalFetcher) Match(url *url.URL) bool {
|
func (f *LocalFetcher) Match(url *url.URL) bool {
|
||||||
@ -21,7 +23,11 @@ func (f *LocalFetcher) Match(url *url.URL) bool {
|
|||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
return isFilesystemPath(url.Path)
|
if url.Scheme == "" && isFilesystemPath(url.Path) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
func NewLocalFetcher() *LocalFetcher {
|
func NewLocalFetcher() *LocalFetcher {
|
||||||
@ -29,5 +35,5 @@ func NewLocalFetcher() *LocalFetcher {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func isFilesystemPath(path string) bool {
|
func isFilesystemPath(path string) bool {
|
||||||
return strings.HasPrefix(path, "./") || strings.HasPrefix(path, "/")
|
return strings.HasPrefix(path, ".") || strings.HasPrefix(path, "/")
|
||||||
}
|
}
|
||||||
|
@ -1,9 +1,9 @@
|
|||||||
package template
|
package template
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"io/ioutil"
|
"io/ioutil"
|
||||||
"log"
|
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
@ -13,6 +13,7 @@ import (
|
|||||||
"gopkg.in/src-d/go-billy.v4"
|
"gopkg.in/src-d/go-billy.v4"
|
||||||
|
|
||||||
"github.com/Masterminds/sprig"
|
"github.com/Masterminds/sprig"
|
||||||
|
"github.com/mattn/go-zglob"
|
||||||
"github.com/pkg/errors"
|
"github.com/pkg/errors"
|
||||||
)
|
)
|
||||||
|
|
||||||
@ -43,12 +44,12 @@ func CopyDir(vfs billy.Filesystem, baseDir string, dst string, opts *Option) err
|
|||||||
}
|
}
|
||||||
|
|
||||||
for _, p := range opts.IgnorePatterns {
|
for _, p := range opts.IgnorePatterns {
|
||||||
match, err := filepath.Match(p, srcPath)
|
match, err := zglob.Match(p, strings.TrimPrefix(srcPath, "./"))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return errors.Wrap(err, "could not match ignored file")
|
return errors.Wrap(err, "could not match ignored file")
|
||||||
}
|
}
|
||||||
if match {
|
if match {
|
||||||
log.Printf("Ignoring %s.", srcPath)
|
fmt.Printf("Ignoring %s.\n", srcPath)
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -61,7 +62,7 @@ func CopyDir(vfs billy.Filesystem, baseDir string, dst string, opts *Option) err
|
|||||||
dstPath := filepath.Join(dst, relSrcPath)
|
dstPath := filepath.Join(dst, relSrcPath)
|
||||||
|
|
||||||
if info.IsDir() {
|
if info.IsDir() {
|
||||||
log.Printf("creating dir '%s'", dstPath)
|
fmt.Printf("Creating dir '%s'.\n", dstPath)
|
||||||
if err := os.MkdirAll(dstPath, 0755); err != nil {
|
if err := os.MkdirAll(dstPath, 0755); err != nil {
|
||||||
return errors.Wrapf(err, "could not create directory '%s'", dstPath)
|
return errors.Wrapf(err, "could not create directory '%s'", dstPath)
|
||||||
}
|
}
|
||||||
@ -89,6 +90,44 @@ func CopyFile(vfs billy.Filesystem, src, dst string, opts *Option) (err error) {
|
|||||||
opts = &Option{}
|
opts = &Option{}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
stat, err := os.Stat(dst)
|
||||||
|
if err != nil && !os.IsNotExist(err) {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// If dst exists
|
||||||
|
if stat != nil {
|
||||||
|
strategy := opts.PreferredStrategy
|
||||||
|
|
||||||
|
if opts.Unnattended && opts.PreferredStrategy == -1 {
|
||||||
|
strategy = defaultStrategy
|
||||||
|
}
|
||||||
|
|
||||||
|
if opts.PreferredStrategy == -1 {
|
||||||
|
var useAsPreferredStrategy bool
|
||||||
|
|
||||||
|
strategy, useAsPreferredStrategy, err = askOverwriteStrategy(dst)
|
||||||
|
if err != nil {
|
||||||
|
return errors.Wrap(err, "could not ask for overwrite strategy")
|
||||||
|
}
|
||||||
|
|
||||||
|
if useAsPreferredStrategy {
|
||||||
|
opts.PreferredStrategy = strategy
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
switch strategy {
|
||||||
|
case CopyAsDist:
|
||||||
|
fmt.Printf("Using '%s.dist' as destination file.\n", dst)
|
||||||
|
dst += ".dist"
|
||||||
|
case DoNotCopy:
|
||||||
|
fmt.Printf("Skipping existing file '%s'.\n", dst)
|
||||||
|
return nil
|
||||||
|
default:
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
if !strings.HasSuffix(src, opts.TemplateExt) {
|
if !strings.HasSuffix(src, opts.TemplateExt) {
|
||||||
return copyFile(vfs, src, dst)
|
return copyFile(vfs, src, dst)
|
||||||
}
|
}
|
||||||
@ -111,7 +150,7 @@ func CopyFile(vfs billy.Filesystem, src, dst string, opts *Option) (err error) {
|
|||||||
|
|
||||||
dst = strings.TrimSuffix(dst, opts.TemplateExt)
|
dst = strings.TrimSuffix(dst, opts.TemplateExt)
|
||||||
|
|
||||||
log.Printf("templating file from '%s' to '%s'", src, dst)
|
fmt.Printf("Templating file from '%s' to '%s'.\n", src, dst)
|
||||||
|
|
||||||
out, err := os.Create(dst)
|
out, err := os.Create(dst)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@ -135,7 +174,7 @@ func CopyFile(vfs billy.Filesystem, src, dst string, opts *Option) (err error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func copyFile(vfs billy.Filesystem, src, dst string) (err error) {
|
func copyFile(vfs billy.Filesystem, src, dst string) (err error) {
|
||||||
log.Printf("copying file '%s' to '%s'", src, dst)
|
fmt.Printf("Copying file '%s' to '%s'.\n", src, dst)
|
||||||
|
|
||||||
in, err := vfs.Open(src)
|
in, err := vfs.Open(src)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
7
internal/template/error.go
Normal file
7
internal/template/error.go
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
package template
|
||||||
|
|
||||||
|
import "github.com/pkg/errors"
|
||||||
|
|
||||||
|
var (
|
||||||
|
ErrUnexpectedOverwriteStrategy = errors.New("unexpected overwrite strategy")
|
||||||
|
)
|
@ -1,7 +1,9 @@
|
|||||||
package template
|
package template
|
||||||
|
|
||||||
type Option struct {
|
type Option struct {
|
||||||
IgnorePatterns []string
|
IgnorePatterns []string
|
||||||
TemplateData Data
|
TemplateData Data
|
||||||
TemplateExt string
|
TemplateExt string
|
||||||
|
Unnattended bool
|
||||||
|
PreferredStrategy Strategy
|
||||||
}
|
}
|
||||||
|
62
internal/template/strategy.go
Normal file
62
internal/template/strategy.go
Normal file
@ -0,0 +1,62 @@
|
|||||||
|
package template
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
|
||||||
|
"github.com/manifoldco/promptui"
|
||||||
|
"github.com/pkg/errors"
|
||||||
|
)
|
||||||
|
|
||||||
|
type Strategy int
|
||||||
|
|
||||||
|
const (
|
||||||
|
Undefined Strategy = -1
|
||||||
|
Overwrite Strategy = iota
|
||||||
|
CopyAsDist
|
||||||
|
DoNotCopy
|
||||||
|
)
|
||||||
|
|
||||||
|
// nolint: gochecknoglobals
|
||||||
|
var defaultStrategy = CopyAsDist
|
||||||
|
|
||||||
|
func askOverwriteStrategy(dst string) (Strategy, bool, error) {
|
||||||
|
strategyPrompt := promptui.Select{
|
||||||
|
Label: fmt.Sprintf("The file '%s' already exists. What do you want to do ?", dst),
|
||||||
|
Items: []string{
|
||||||
|
"Leave <dest> file as is",
|
||||||
|
"Copy source file as '<dest>.dist'",
|
||||||
|
"Overwrite '<dest>' with source file",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
strategySelectedIndex, _, err := strategyPrompt.Run()
|
||||||
|
if err != nil {
|
||||||
|
return -1, false, errors.Wrap(err, "could not prompt for overwrite strategy")
|
||||||
|
}
|
||||||
|
|
||||||
|
asPreferredStrategyPrompt := promptui.Select{
|
||||||
|
Label: "Do you want to apply this strategy to all files ?",
|
||||||
|
Items: []string{
|
||||||
|
"Yes",
|
||||||
|
"No",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
preferredSelectedIndex, _, err := asPreferredStrategyPrompt.Run()
|
||||||
|
if err != nil {
|
||||||
|
return -1, false, errors.Wrap(err, "could not prompt for preferred strategy")
|
||||||
|
}
|
||||||
|
|
||||||
|
useAsPreferredStrategy := preferredSelectedIndex == 0
|
||||||
|
|
||||||
|
switch strategySelectedIndex {
|
||||||
|
case 0:
|
||||||
|
return DoNotCopy, useAsPreferredStrategy, nil
|
||||||
|
case 1:
|
||||||
|
return CopyAsDist, useAsPreferredStrategy, nil
|
||||||
|
case 2:
|
||||||
|
return Overwrite, useAsPreferredStrategy, nil
|
||||||
|
default:
|
||||||
|
return -1, false, ErrUnexpectedOverwriteStrategy
|
||||||
|
}
|
||||||
|
}
|
153
misc/script/gitea-release
Executable file
153
misc/script/gitea-release
Executable file
@ -0,0 +1,153 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
set -eo pipefail
|
||||||
|
|
||||||
|
GITEA_RELEASE_PROJECT=${GITEA_RELEASE_PROJECT}
|
||||||
|
GITEA_RELEASE_ORG=${GITEA_RELEASE_ORG}
|
||||||
|
GITEA_RELEASE_BASE_URL=${GITEA_BASE_URL:-https://forge.cadoles.com}
|
||||||
|
GITEA_RELEASE_USERNAME=${GITEA_RELEASE_USERNAME}
|
||||||
|
GITEA_RELEASE_PASSWORD=${GITEA_RELEASE_PASSWORD}
|
||||||
|
GITEA_RELEASE_VERSION=${GITEA_RELEASE_VERSION}
|
||||||
|
GITEA_RELEASE_COMMITISH_TARGET=${GITEA_RELEASE_COMMITISH_TARGET}
|
||||||
|
GITEA_RELEASE_IS_DRAFT=${GITEA_RELEASE_IS_DRAFT:-false}
|
||||||
|
GITEA_RELEASE_IS_PRERELEASE=${GITEA_RELEASE_IS_PRERELEASE:-true}
|
||||||
|
GITEA_RELEASE_BODY=${GITEA_RELEASE_BODY}
|
||||||
|
GITEA_RELEASE_ATTACHMENTS=${GITEA_RELEASE_ATTACHMENTS}
|
||||||
|
|
||||||
|
function check_dependencies {
|
||||||
|
assert_command_available 'curl'
|
||||||
|
assert_command_available 'jq'
|
||||||
|
}
|
||||||
|
|
||||||
|
function assert_command_available {
|
||||||
|
local command=$1
|
||||||
|
local command_path=$(which $command)
|
||||||
|
|
||||||
|
if [ -z "$command_path" ]; then
|
||||||
|
echo "The '$command' command could not be found. Please install it before using this script." 1>&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
function check_environment {
|
||||||
|
assert_environment GITEA_RELEASE_PROJECT
|
||||||
|
assert_environment GITEA_RELEASE_ORG
|
||||||
|
assert_environment GITEA_RELEASE_BASE_URL
|
||||||
|
}
|
||||||
|
|
||||||
|
function source_env_file {
|
||||||
|
if [ ! -f '.env' ]; then
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
set -o allexport
|
||||||
|
source .env
|
||||||
|
set +o allexport
|
||||||
|
}
|
||||||
|
|
||||||
|
function assert_environment {
|
||||||
|
local name=$1
|
||||||
|
local value=${!name}
|
||||||
|
|
||||||
|
if [ -z "$value" ]; then
|
||||||
|
echo "The $"$name" environment variable is empty." 1>&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
function ask_credentials {
|
||||||
|
if [ -z "$GITEA_RELEASE_USERNAME" ]; then
|
||||||
|
echo -n "Username: "
|
||||||
|
read GITEA_RELEASE_USERNAME
|
||||||
|
|
||||||
|
fi
|
||||||
|
if [ -z "$GITEA_RELEASE_PASSWORD" ]; then
|
||||||
|
echo -n "Password: "
|
||||||
|
stty -echo
|
||||||
|
read GITEA_RELEASE_PASSWORD
|
||||||
|
stty echo
|
||||||
|
echo
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
function retrieve_version {
|
||||||
|
if [ ! -z "$GITEA_RELEASE_VERSION" ]; then
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
|
||||||
|
set +e
|
||||||
|
GITEA_RELEASE_VERSION=$(git describe --abbrev=0 --tags 2>/dev/null)
|
||||||
|
GITEA_RELEASE_VERSION=${GITEA_RELEASE_VERSION}
|
||||||
|
set -e
|
||||||
|
}
|
||||||
|
|
||||||
|
function retrieve_commitish_target {
|
||||||
|
if [ ! -z "$GITEA_RELEASE_COMMITISH_TARGET" ]; then
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
|
||||||
|
GITEA_RELEASE_COMMITISH_TARGET=$(git log -n 1 --pretty="format:%h")
|
||||||
|
}
|
||||||
|
|
||||||
|
function create_release {
|
||||||
|
local payload={}
|
||||||
|
|
||||||
|
payload=$(json_set "$payload" body "\"$GITEA_RELEASE_BODY\"")
|
||||||
|
payload=$(json_set "$payload" draft $GITEA_RELEASE_IS_DRAFT)
|
||||||
|
payload=$(json_set "$payload" name "\"$GITEA_RELEASE_VERSION\"")
|
||||||
|
payload=$(json_set "$payload" prerelease $GITEA_RELEASE_IS_PRERELEASE)
|
||||||
|
payload=$(json_set "$payload" tag_name "\"${GITEA_RELEASE_VERSION:-$GITEA_RELEASE_COMMITISH_TARGET}\"")
|
||||||
|
payload=$(json_set "$payload" target_commitish "\"$GITEA_RELEASE_COMMITISH_TARGET\"")
|
||||||
|
|
||||||
|
gitea_api "/repos/$GITEA_RELEASE_ORG/$GITEA_RELEASE_PROJECT/releases" \
|
||||||
|
-H "Content-Type:application/json" \
|
||||||
|
-d "$payload"
|
||||||
|
}
|
||||||
|
|
||||||
|
function json_set {
|
||||||
|
local data=$1
|
||||||
|
local key=$2
|
||||||
|
local value=$3
|
||||||
|
echo $data | jq -cr --argjson v "$value" --arg k "$key" '.[$k] = $v'
|
||||||
|
}
|
||||||
|
|
||||||
|
function upload_release_attachments {
|
||||||
|
local release="$1"
|
||||||
|
local release_id=$(echo "$release" | jq -r .id)
|
||||||
|
|
||||||
|
if [ -z "$GITEA_RELEASE_ATTACHMENTS" ]; then
|
||||||
|
set +e
|
||||||
|
GITEA_RELEASE_ATTACHMENTS="$(ls release/*.{tar.gz,zip} 2>/dev/null)"
|
||||||
|
set -e
|
||||||
|
fi
|
||||||
|
|
||||||
|
for file in $GITEA_RELEASE_ATTACHMENTS; do
|
||||||
|
local filename=$(basename "$file")
|
||||||
|
gitea_api "/repos/$GITEA_RELEASE_ORG/$GITEA_RELEASE_PROJECT/releases/$release_id/assets?name=$filename" \
|
||||||
|
-H "Content-Type:multipart/form-data" \
|
||||||
|
-F "attachment=@$file"
|
||||||
|
done
|
||||||
|
}
|
||||||
|
|
||||||
|
function gitea_api {
|
||||||
|
local path=$1
|
||||||
|
local args=${@:2}
|
||||||
|
|
||||||
|
curl -L \
|
||||||
|
--fail \
|
||||||
|
-u "$GITEA_RELEASE_USERNAME:$GITEA_RELEASE_PASSWORD" \
|
||||||
|
${args} \
|
||||||
|
"$GITEA_RELEASE_BASE_URL/api/v1$path"
|
||||||
|
}
|
||||||
|
|
||||||
|
function main {
|
||||||
|
check_dependencies
|
||||||
|
source_env_file
|
||||||
|
check_environment
|
||||||
|
ask_credentials
|
||||||
|
retrieve_commitish_target
|
||||||
|
retrieve_version
|
||||||
|
local release=$(create_release)
|
||||||
|
upload_release_attachments "$release"
|
||||||
|
}
|
||||||
|
|
||||||
|
main
|
102
misc/script/release
Executable file
102
misc/script/release
Executable file
@ -0,0 +1,102 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
set -eo pipefail
|
||||||
|
|
||||||
|
OS_TARGETS=(linux)
|
||||||
|
ARCH_TARGETS=${ARCH_TARGETS:-amd64 arm64}
|
||||||
|
|
||||||
|
DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )"
|
||||||
|
PROJECT_DIR="$DIR/../.."
|
||||||
|
|
||||||
|
function build {
|
||||||
|
|
||||||
|
local name=$1
|
||||||
|
local srcdir=$2
|
||||||
|
local os=$3
|
||||||
|
local arch=$4
|
||||||
|
|
||||||
|
local dirname="$name-$os-$arch"
|
||||||
|
local destdir="$PROJECT_DIR/release/$dirname"
|
||||||
|
|
||||||
|
rm -rf "$destdir"
|
||||||
|
mkdir -p "$destdir"
|
||||||
|
|
||||||
|
echo "building $dirname..."
|
||||||
|
|
||||||
|
CGO_ENABLED=0 GOOS="$os" GOARCH="$arch" go build \
|
||||||
|
-mod=vendor \
|
||||||
|
-ldflags="-s -w -X 'main.GitRef=$(current_commit_ref)' -X 'main.ProjectVersion=$(current_version)' -X 'main.BuildDate=$(current_date)'" \
|
||||||
|
-gcflags=-trimpath="${PWD}" \
|
||||||
|
-asmflags=-trimpath="${PWD}" \
|
||||||
|
-o "$destdir/bin/$name" \
|
||||||
|
"$srcdir"
|
||||||
|
|
||||||
|
if [ ! -z "$(which upx)" ]; then
|
||||||
|
upx --best "$destdir/bin/$name"
|
||||||
|
fi
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
function current_date {
|
||||||
|
date '+%Y-%m-%d %H:%M'
|
||||||
|
}
|
||||||
|
|
||||||
|
function current_commit_ref {
|
||||||
|
git log -n 1 --pretty="format:%h"
|
||||||
|
}
|
||||||
|
|
||||||
|
function current_version {
|
||||||
|
local latest_tag=$(git describe --abbrev=0 2>/dev/null)
|
||||||
|
echo ${latest_tag:-0.0.0}
|
||||||
|
}
|
||||||
|
|
||||||
|
function copy {
|
||||||
|
|
||||||
|
local name=$1
|
||||||
|
local os=$2
|
||||||
|
local arch=$3
|
||||||
|
local src=$4
|
||||||
|
local dest=$5
|
||||||
|
|
||||||
|
local dirname="$name-$os-$arch"
|
||||||
|
local destdir="$PROJECT_DIR/release/$dirname"
|
||||||
|
|
||||||
|
echo "copying '$src' to '$destdir/$dest'..."
|
||||||
|
|
||||||
|
mkdir -p "$(dirname $destdir/$dest)"
|
||||||
|
|
||||||
|
cp -rfL $src "$destdir/$dest"
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
function compress {
|
||||||
|
local name=$1
|
||||||
|
local os=$2
|
||||||
|
local arch=$3
|
||||||
|
|
||||||
|
local dirname="$name-$os-$arch"
|
||||||
|
local destdir="$PROJECT_DIR/release/$dirname"
|
||||||
|
|
||||||
|
echo "compressing $dirname..."
|
||||||
|
tar -czf "$destdir.tar.gz" -C "$destdir/../" "$dirname"
|
||||||
|
}
|
||||||
|
|
||||||
|
function release_scaffold {
|
||||||
|
local os=$1
|
||||||
|
local arch=$2
|
||||||
|
|
||||||
|
build 'scaffold' "$PROJECT_DIR/cmd/scaffold" $os $arch
|
||||||
|
copy 'scaffold' $os $arch "$PROJECT_DIR/README.md" "README.md"
|
||||||
|
copy 'scaffold' $os $arch "$PROJECT_DIR/LICENSE" "LICENSE"
|
||||||
|
compress 'scaffold' $os $arch
|
||||||
|
}
|
||||||
|
|
||||||
|
function main {
|
||||||
|
for os in ${OS_TARGETS[@]}; do
|
||||||
|
for arch in ${ARCH_TARGETS[@]}; do
|
||||||
|
release_scaffold $os $arch
|
||||||
|
done
|
||||||
|
done
|
||||||
|
}
|
||||||
|
|
||||||
|
main
|
Reference in New Issue
Block a user