Skip to content

Commit a08dace

Browse files
sirihansensirihansen
committed
A rebar3 plugin for installing OTP applications
0 parents  commit a08dace

File tree

9 files changed

+968
-0
lines changed

9 files changed

+968
-0
lines changed

‎.gitignore‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
.rebar3
2+
_*
3+
.eunit
4+
*.o
5+
*.beam
6+
*.plt
7+
*.swp
8+
*.swo
9+
.erlang.cookie
10+
ebin
11+
log
12+
erl_crash.dump
13+
.rebar
14+
logs
15+
_build
16+
.idea
17+
rebar3.crashdump

‎LICENSE.txt‎

Lines changed: 178 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,178 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+

‎README.md‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
rebar3_otp_install_plugin
2+
=====
3+
4+
A rebar3 plugin for installing OTP applications
5+
6+
7+
Description
8+
-----------
9+
10+
This plugin makes it possible to restore the OTP bundle as it looked
11+
before OTP-20, i.e. the applications that have been moved out of the
12+
OTP repository can be installed into `/usr/local/lib/erlang/lib/` or
13+
`$HOME/.local/lib/erlang/lib` or any other suitable place where `erl`
14+
can find them again.
15+
16+
The decoupled applications are proper `rebar3` applications, but since
17+
they are used in legacy project, this plugin is provided to allow
18+
continued use without converting the projects to using `rebar3` for
19+
packaging.
20+
21+
The plugin is implemented in the `otp` namespace.
22+
23+
24+
Build
25+
-----
26+
27+
$ rebar3 compile
28+
29+
Usage
30+
-----
31+
rebar3 otp install [<app>] [-r <repo>] [-v <version>] [-t <tag>]
32+
[-r <ref>] [-b <branch>] [-o <target>]
33+
[--nodeps]
34+
35+
<app> The application to install. If not given, the application
36+
found in the current directory is installed.
37+
-r, --repo Git repository to fetch application from. Default is the
38+
official erlang/OTP repository for the given application.
39+
-v, --version Application version. Default is the latest from master
40+
branch.
41+
-t, --tag Git tag for application. Default is the latest from
42+
master branch.
43+
-r, --ref Git ref for application. Default is the latest from
44+
master branch.
45+
-b, --branch Git branch for application. Default is master.
46+
-o, --target Directory where the apps shall be installed. A
47+
subdirectory named erlang will be created under the given
48+
target directory. Default is $HOME/.local/lib.
49+
--nodeps Install only the primary application, no dependecies.
50+
51+
52+
Example
53+
-------
54+
55+
Add the plugin to your rebar config (typically your global config
56+
$HOME/.config/rebar3/rebar.config):
57+
58+
{plugins, [{rebar3_otp_install_plugin,
59+
{git, "[email protected]:erlang/rebar3_otp_install_plugin.git",
60+
{tag, "0.1"}}}
61+
]}.
62+
63+
Then just call your plugin directly in any directory:
64+
65+
66+
$ rebar3 otp install typer -v 0.9.13
67+
===> Compiling rebar3_otp_install_plugin
68+
===> Verifying dependencies...
69+
===> Verifying dependencies...
70+
===> Fetching typer ({git,"[email protected]:erlang/typer.git",
71+
{tag,"0.9.13"}})
72+
===> Fetching rebar3_appup_plugin ({pkg,<<"rebar3_appup_plugin">>,
73+
<<"2.2.0">>})
74+
===> Downloaded package, caching at ....
75+
===> Compiling rebar3_appup_plugin
76+
===> Compiling rebar3_otpdoc_plugin
77+
===> Compiling typer
78+
===> Compiling typer.appup.src
79+
===> Building escript...
80+
===> Installing applications: [typer]
81+
82+
83+
or inside a OTP application directory:
84+
85+
$ rebar3 otp install
86+
===> Verifying dependencies...
87+
===> Compiling typer
88+
===> Compiling typer.appup.src
89+
===> Building escript...
90+
===> Installing application from current project
91+
===> Installing applications: [typer]
92+
93+
Make sure that you start your erlang node with additional paths to
94+
installed libs and executables.

‎rebar.config‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
%% -*- erlang -*-
2+
%%
3+
%% %CopyrightBegin%
4+
%%
5+
%% Copyright Ericsson AB 2017. All Rights Reserved.
6+
%%
7+
%% Licensed under the Apache License, Version 2.0 (the "License");
8+
%% you may not use this file except in compliance with the License.
9+
%% You may obtain a copy of the License at
10+
%%
11+
%% http://www.apache.org/licenses/LICENSE-2.0
12+
%%
13+
%% Unless required by applicable law or agreed to in writing, software
14+
%% distributed under the License is distributed on an "AS IS" BASIS,
15+
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
%% See the License for the specific language governing permissions and
17+
%% limitations under the License.
18+
%%
19+
%% %CopyrightEnd%
20+
%%
21+
{erl_opts, [debug_info]}.
22+
{profiles,[{test,[{erl_opts,[nowarn_export_all]}]}]}.

‎rebar.lock‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[].

‎src/rebar3_otp_install_plugin.app.src‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
%%
2+
%% %CopyrightBegin%
3+
%%
4+
%% Copyright Ericsson AB 2017. All Rights Reserved.
5+
%%
6+
%% Licensed under the Apache License, Version 2.0 (the "License");
7+
%% you may not use this file except in compliance with the License.
8+
%% You may obtain a copy of the License at
9+
%%
10+
%% http://www.apache.org/licenses/LICENSE-2.0
11+
%%
12+
%% Unless required by applicable law or agreed to in writing, software
13+
%% distributed under the License is distributed on an "AS IS" BASIS,
14+
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
%% See the License for the specific language governing permissions and
16+
%% limitations under the License.
17+
%%
18+
%% %CopyrightEnd%
19+
%%
20+
{application, rebar3_otp_install_plugin,
21+
[{description, "A rebar3 plugin for installing OTP applications"},
22+
{vsn, git},
23+
{registered, []},
24+
{applications,[kernel,stdlib]},
25+
{env,[]},
26+
{modules, []},
27+
{maintainers, []},
28+
{licenses, []},
29+
{links, []}
30+
]}.

‎src/rebar3_otp_install_plugin.erl‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
%%
2+
%% %CopyrightBegin%
3+
%%
4+
%% Copyright Ericsson AB 2017. All Rights Reserved.
5+
%%
6+
%% Licensed under the Apache License, Version 2.0 (the "License");
7+
%% you may not use this file except in compliance with the License.
8+
%% You may obtain a copy of the License at
9+
%%
10+
%% http://www.apache.org/licenses/LICENSE-2.0
11+
%%
12+
%% Unless required by applicable law or agreed to in writing, software
13+
%% distributed under the License is distributed on an "AS IS" BASIS,
14+
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
%% See the License for the specific language governing permissions and
16+
%% limitations under the License.
17+
%%
18+
%% %CopyrightEnd%
19+
%%
20+
-module(rebar3_otp_install_plugin).
21+
22+
-export([init/1]).
23+
24+
-spec init(rebar_state:t()) -> {ok, rebar_state:t()}.
25+
init(State) ->
26+
rebar3_otp_install_plugin_prv:init(State).

0 commit comments

Comments
 (0)