summaryrefslogblamecommitdiffstats
path: root/docs/en/erlang.mk/1/guide/releases/index.html
blob: 9ebd52bac713440c25811a1d9c19f14db25de904 (plain) (tree) 
fe3492a9









9c80a881

fe3492a9



83f1ad46

642b100b

fe3492a9

































































c807880f

fe3492a9












c807880f

fe3492a9





c807880f

fe3492a9























b051513f



fe3492a9



















b051513f




















































fe3492a9



62f5d708






83f1ad46

62f5d708





b051513f


62f5d708







fe3492a9






















































fe3492a9





1
2
3
4
5
6
7
8
9

10

11
12
13

14

15

16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

81

82
83
84
85
86
87
88
89
90
91
92
93

94

95
96
97
98
99

100

101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

124
125
126

127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197

198
199
200

201
202
203
204
205
206

207

208
209
210
211
212

213
214

215
216
217
218
219
220
221

222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275

276
277
278
279
280









                                                                                           
                                                 


                                       
                                                                                                                      
                                                   
































































                                                                                                                                                                                          
                                  











                                                                                                   
                                  




                                                                                     
                                  






















                                                                                            


                                                                                                   


















                                                                                    



















































                                                                                                                                                                                                                                                                                         


 





                                          
                                                                                                                   




                                                             

                                                                                                                  






                                    





















































                                                                                                                                                                                                                           




                                         
<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="description" content="">
    <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara">

    <meta name="generator" content="Hugo 0.17" />

    <title>Nine Nines: Releases</title>

    <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'>
    <link href="/css/99s.css?r=1" rel="stylesheet">

    <link rel="shortcut icon" href="/img/ico/favicon.ico">
    <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png">
    <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png">
    <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png">

    
</head>


<body class="">
  <header id="page-head">
    <div id="topbar" class="container">
        <div class="row">
          <div class="span2">
            <h1 id="logo"><a href="/" title="99s">99s</a></h1>
          </div>
          <div class="span10">
            
            <div id="side-header">
              <nav>
                <ul>
                  <li><a title="Hear my thoughts" href="/articles">Articles</a></li>
  				  <li><a title="Watch my talks" href="/talks">Talks</a></li>
  				  <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li>
  				  <li><a title="Request my services" href="/services">Consulting & Training</a></li>
                </ul>
              </nav> 
              <ul id="social">
                <li>
                  <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a>
                </li>
                    <li>
						<a title="Keep in touch!" href="http://twitter.com/lhoguin"><img src="/img/ico_microblog.png" data-hover="/img/ico_microblog_alt.png"></a>
					</li>
                    <li>
						<a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a>
					</li>
              </ul>
            </div>
          </div>
        </div>
    </div>


</header>

<div id="contents" class="two_col">
<div class="container">
<div class="row">
<div id="docs" class="span9 maincol">

<h1 class="lined-header"><span>Releases</span></h1>

<div class="paragraph"><p>Erlang.mk relies on <em>Relx</em> for generating releases. This
chapter covers the Erlang.mk-specific bits. Consult the
<a href="https://erlware.github.io/relx/">Relx website</a> for more information.</p></div>
<div class="sect1">
<h2 id="_setup">Setup</h2>
<div class="sectionbody">
<div class="paragraph"><p>Erlang.mk will create a release if it detects a Relx configuration
file in the <em>$(RELX_CONFIG)</em> location. This defaults to
<em>$(CURDIR)/relx.config</em>. You can override it by defining
the variable before including Erlang.mk:</p></div>
<div class="listingblock">
<div class="content"></div></div>
<div class="paragraph"><p>Relx does not need to be installed. Erlang.mk will download
and build it automatically.</p></div>
<div class="paragraph"><p>The Relx executable will be saved in the <em>$(RELX)</em> file. This
location defaults to <em>$(CURDIR)/relx</em> and can be overriden.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_configuration">Configuration</h2>
<div class="sectionbody">
<div class="paragraph"><p>You can specify additional Relx options using the <code>RELX_OPTS</code>
variable. For example, to enable <code>dev_mode</code>:</p></div>
<div class="listingblock">
<div class="content"></div></div>
<div class="paragraph"><p>While you can specify the output directory for the release
in the Relx options directly, Erlang.mk provides a specific
variable for it: <code>RELX_OUTPUT_DIR</code>. It defaults to the <em>_rel</em>
directory. You can also override it:</p></div>
<div class="listingblock">
<div class="content"></div></div>
</div>
</div>
<div class="sect1">
<h2 id="_generating_the_release">Generating the release</h2>
<div class="sectionbody">
<div class="paragraph"><p>Now that you&#8217;re all set, all you need to do is generate the
release. As mentioned before, Erlang.mk will automatically
generate it when it detects the <em>$(RELX_CONFIG)</em> file. This
means the following command will also build the release:</p></div>
<div class="listingblock">
<div class="content"><!-- Generator: GNU source-highlight 3.1.8
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt>$ make</tt></pre></div></div>
<div class="paragraph"><p>If you need to generate the release, and only the release,
the <code>rel</code> target can be used:</p></div>
<div class="listingblock">
<div class="content"><!-- Generator: GNU source-highlight 3.1.8
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt>$ make rel</tt></pre></div></div>
<div class="paragraph"><p>Erlang.mk always generates a tarball alongside the release,
which can be directly uploaded to a server. The tarball is
located at <code>$(RELX_OUTPUT_DIR)/&lt;name&gt;/&lt;name&gt;-&lt;vsn&gt;.tar.gz</code>.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_running_the_release">Running the release</h2>
<div class="sectionbody">
<div class="paragraph"><p>Erlang.mk provides a convenience function for running the
release with one simple command:</p></div>
<div class="listingblock">
<div class="content"><!-- Generator: GNU source-highlight 3.1.8
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt>$ make run</tt></pre></div></div>
<div class="paragraph"><p>This command will also build the project and generate the
release if they weren&#8217;t already. It starts the release in
<em>console mode</em>, meaning you will also have a shell ready to
use to check things as needed.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_upgrading_a_release">Upgrading a release</h2>
<div class="sectionbody">
<div class="paragraph"><p>Erlang.mk provides a <code>relup</code> target for generating release
upgrades. Release upgrades allow updating the code and the
state of a running release without restarting it.</p></div>
<div class="paragraph"><p>Once your changes are done, you need to update the version
of the application(s) that will be updated. You also need
to update the version of the release.</p></div>
<div class="paragraph"><p>For each application that needs to be updated, an
<a href="http://erlang.org/doc/man/appup.html">appup file</a>
must be written. Refer to the Erlang/OTP documentation
for more details.</p></div>
<div class="paragraph"><p>For the purpose of this section, assume the initial release
version was <code>1</code>, and the new version is <code>2</code>. The name of the
release will be <code>example</code>.</p></div>
<div class="paragraph"><p>Once all this is done, you can build the tarball for the
release upgrade:</p></div>
<div class="listingblock">
<div class="content"><!-- Generator: GNU source-highlight 3.1.8
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt>$ make relup</tt></pre></div></div>
<div class="paragraph"><p>This will create an archive at the root directory of the
release, <code>$RELX_OUTPUT_DIR/example/example-2.tar.gz</code>.</p></div>
<div class="paragraph"><p>Move the archive to the correct location on the running
node. From the release&#8217;s root directory:</p></div>
<div class="listingblock">
<div class="content"><!-- Generator: GNU source-highlight 3.1.8
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt>$ mkdir releases<span style="color: #990000">/</span><span style="color: #993399">2</span><span style="color: #990000">/</span>
$ mv path/to/example-<span style="color: #993399">2</span><span style="color: #990000">.</span>tar<span style="color: #990000">.</span>gz releases<span style="color: #990000">/</span><span style="color: #993399">2</span><span style="color: #990000">/</span></tt></pre></div></div>
<div class="paragraph"><p>Finally, upgrade the release:</p></div>
<div class="listingblock">
<div class="content"><!-- Generator: GNU source-highlight 3.1.8
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt>$ bin/example_release upgrade <span style="color: #FF0000">"2/example_release"</span></tt></pre></div></div>
<div class="paragraph"><p>Or on Windows:</p></div>
<div class="listingblock">
<div class="content"><!-- Generator: GNU source-highlight 3.1.8
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt>$ bin/example_release<span style="color: #990000">.</span>cmd upgrade <span style="color: #FF0000">"2/example_release"</span></tt></pre></div></div>
<div class="paragraph"><p>Your release was upgraded!</p></div>
</div>
</div>



	
		
		

		<nav style="margin:1em 0">
			
				<a style="float:left" href="https://ninenines.eu/docs/en/erlang.mk/1/guide/ports/">
					NIFs and port drivers
				</a>
			

			
				<a style="float:right" href="https://ninenines.eu/docs/en/erlang.mk/1/guide/sfx/">
					Self-extracting releases
				</a>
			
		</nav>
	



</div>

<div class="span3 sidecol">


<h3>
	Erlang.mk
	1
	
	User Guide
</h3>

<ul>
	
	
	
</ul>

<h4 id="docs-nav">Navigation</h4>

<h4>Version select</h4>
<ul>
	
	
	
		<li><a href="/docs/en/erlang.mk/1/guide">1</a></li>
	
</ul>

</div>
</div>
</div>
</div>

      <footer>
        <div class="container">
          <div class="row">
            <div class="span6">
              <p id="scroll-top"><a href="#">↑ Scroll to top</a></p>
              <nav>
                <ul>
                  <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li>
                </ul>
              </nav>
            </div>
            <div class="span6 credits">
               <p><img src="/img/footer_logo.png"></p>
               <p>Copyright &copy; Loïc Hoguin 2012-2016</p>
            </div>
          </div>
        </div>
      </footer>

    
    <script src="/js/custom.js"></script>
  </body>
</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-11 16:53:18 +0000