-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathactivities.html
1333 lines (1270 loc) · 79.1 KB
/
activities.html
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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Activities — rever 0.5.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/numpy_friendly.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css" />
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Noticia+Text|Open+Sans|Droid+Sans+Mono" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/jquery.cookie.js"></script>
<script src="_static/cloud.base.js"></script>
<script src="_static/cloud.js"></script>
<link rel="shortcut icon" href="_static/longship.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Environment Variables" href="envvars.html" />
<link rel="prev" title="Contributor & Authorship Tracking" href="authorship.html" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="canonical" href="http://xon.sh/activities.html"/>
</head><body>
<div class="relbar-top">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> </li>
<li class="right" >
<a href="envvars.html" title="Environment Variables"
accesskey="N">next</a> </li>
<li class="right" >
<a href="authorship.html" title="Contributor & Authorship Tracking"
accesskey="P">previous</a> </li>
<li><a href="index.html">rever 0.5.0 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Activities</a></li>
</ul>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="activities">
<h1>Activities<a class="headerlink" href="#activities" title="Permalink to this headline">¶</a></h1>
<p>The following displays information about the release activities that come stock
with rever.</p>
<table class="colwidths-auto docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#appimage"><span class="std std-ref">AppImage</span></a></p></td>
<td><p>Create AppImage.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#authors"><span class="std std-ref">Authors</span></a></p></td>
<td><p>Manages keeping a contributors listing up-to-date.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#bibtex"><span class="std std-ref">BibTex</span></a></p></td>
<td><p>Writes a BibTex reference for the version of software.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#changelog"><span class="std std-ref">Changelog</span></a></p></td>
<td><p>Manages keeping a changelog up-to-date.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#check"><span class="std std-ref">Check</span></a></p></td>
<td><p>Run <cite>rever check</cite>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#command"><span class="std std-ref">Command</span></a></p></td>
<td><p>Runs a command</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#condaforge"><span class="std std-ref">CondaForge</span></a></p></td>
<td><p>Updates conda-forge feedstocks.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#deploytogcloud"><span class="std std-ref">DeploytoGCloud</span></a></p></td>
<td><p>Deploys a docker container to the google cloud</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#deploytogcloudapp"><span class="std std-ref">DeploytoGCloudApp</span></a></p></td>
<td><p>Deploys an app to the google cloud via the app engine</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#dockerbuild"><span class="std std-ref">DockerBuild</span></a></p></td>
<td><p>Builds a Dockerfile.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#dockerpush"><span class="std std-ref">DockerPush</span></a></p></td>
<td><p>Pushes a built Dockerfile.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#forge"><span class="std std-ref">Forge</span></a></p></td>
<td><p>Updates a forge feedstock.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#ghpages"><span class="std std-ref">GHPages</span></a></p></td>
<td><p>Activity for pushing documentation up to GitHub pages.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#ghrelease"><span class="std std-ref">GHRelease</span></a></p></td>
<td><p>Performs a github release.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#nose"><span class="std std-ref">Nose</span></a></p></td>
<td><p>Runs nose tests inside of a container.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pushtag"><span class="std std-ref">PushTag</span></a></p></td>
<td><p>Pushes the current tag up to a remote repository.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pypi"><span class="std std-ref">PyPI</span></a></p></td>
<td><p>Uploads a package to the Python Package Index.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pytest"><span class="std std-ref">PyTest</span></a></p></td>
<td><p>Runs pytest inside of a container.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#sphinx"><span class="std std-ref">Sphinx</span></a></p></td>
<td><p>Runs sphinx inside of a container.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#tag"><span class="std std-ref">Tag</span></a></p></td>
<td><p>Locally tags the current version.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#versionbump"><span class="std std-ref">VersionBump</span></a></p></td>
<td><p>Changes the version to the value of $VERSION.</p></td>
</tr>
</tbody>
</table>
<div class="section" id="listing">
<h2>Listing<a class="headerlink" href="#listing" title="Permalink to this headline">¶</a></h2>
<div class="section" id="appimage">
<span id="id1"></span><h3>AppImage<a class="headerlink" href="#appimage" title="Permalink to this headline">¶</a></h3>
<p>The AppImage activity class is available via:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">rever.activities.appimage</span> <span class="kn">import</span> <span class="n">AppImage</span>
</pre></div>
</div>
<p>Create AppImage.</p>
<p>This activity’s defaults are equivalent to the following <code class="docutils literal notranslate"><span class="pre">rever.xsh</span></code> file:</p>
<div class="highlight-xonsh notranslate"><div class="highlight"><pre><span></span><span class="nv">$ACTIVITIES</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'appimage'</span><span class="p">]</span>
<span class="nv">$APPIMAGE_TEMPLATE</span> <span class="o">=</span> <span class="s1">'$VERSION'</span>
<span class="nv">$APPIMAGE_PYTHON_VERSION</span> <span class="o">=</span> <span class="kc">None</span>
</pre></div>
</div>
<hr class="docutils" />
</div>
<div class="section" id="authors">
<span id="id2"></span><h3>Authors<a class="headerlink" href="#authors" title="Permalink to this headline">¶</a></h3>
<p>The Authors activity class is available via:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">rever.activities.authors</span> <span class="kn">import</span> <span class="n">Authors</span>
</pre></div>
</div>
<p>Manages keeping a contributors listing up-to-date.</p>
<blockquote>
<div><p>This activity may be configured with the following envionment variables:</p>
<dl class="field-list">
<dt class="field-odd">$AUTHORS_FILENAME</dt>
<dd class="field-odd"><p>str, path to input file. The default is ‘AUTHORS’.</p>
</dd>
<dt class="field-even">$AUTHORS_TEMPLATE</dt>
<dd class="field-even"><p>str, This value goes at the top of the
authors file. The default value is:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span>All of the people who have made at least one contribution to $PROJECT
Authors are sorted by {sorting_text}.
{authors}
</pre></div>
</div>
<p>This is evaluated in the current environment and,</p>
<ul class="simple">
<li><p>“{sorting_text}” is a special textual description of the sort method.</p></li>
<li><p>“{authors}” is a contcatenated string of all formatted authors.</p></li>
</ul>
<p>which the template is formatted with.</p>
</dd>
<dt class="field-odd">$AUTHORS_FORMAT</dt>
<dd class="field-odd"><p>str, the string that formats each author in the author file.
The default is <a href="#id3"><span class="problematic" id="id4">``</span></a>”* {name}</p>
</dd>
</dl>
</div></blockquote>
<dl>
<dt>“<a href="#id5"><span class="problematic" id="id6">``</span></a>. The valid fields are all of those present</dt><dd><blockquote>
<div><p>in the author metadata (see below).</p>
</div></blockquote>
<dl class="field-list">
<dt class="field-odd">$AUTHORS_LATEST</dt>
<dd class="field-odd"><p>str, file to write just the latest contribuors to, i.e.
this is the listing of the contributors for just this release.
This defaults to <code class="docutils literal notranslate"><span class="pre">$REVER_DIR/LATEST-AUTHORS.json</span></code>. This is evaluated
in the current environment.</p>
</dd>
<dt class="field-even">$AUTHORS_METADATA</dt>
<dd class="field-even"><p>str, path to YAML file that stores author metadata.
The default is ‘.authors.yml’. This is evaluated in the current environment.
This file has the following format:</p>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="c1"># required fields</span>
<span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Princess Buttercup</span>
<span class="nt">email</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">[email protected]</span>
<span class="c1"># optional fields</span>
<span class="nt">github</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">bcup</span>
<span class="nt">is_org</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">False</span>
<span class="nt">aliases</span><span class="p">:</span>
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">Buttercup</span>
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">beecup</span>
<span class="nt">alternate_emails</span><span class="p">:</span>
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">[email protected]</span>
<span class="c1"># autogenerated fields</span>
<span class="nt">num_commits</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">1000</span>
<span class="nt">first_commit</span><span class="p">:</span> <span class="s">'1987-09-25'</span>
<span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Westley</span>
<span class="nt">email</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">[email protected]</span>
<span class="nt">github</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">westley</span>
<span class="nt">aliases</span><span class="p">:</span>
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">Dread Pirate Roberts</span>
<span class="nt">alternate_emails</span><span class="p">:</span>
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">[email protected]</span>
<span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Florin</span>
<span class="nt">email</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">[email protected]</span>
<span class="nt">github</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">florin</span>
<span class="nt">is_org</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">True</span>
</pre></div>
</div>
</dd>
<dt class="field-odd">$AUTHORS_SORTBY</dt>
<dd class="field-odd"><p>str, flag that specifies how authors should be sorted in
the authors file. Valid options are:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">"num_commits"</span></code>: Number of commits per author</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">"first_commit"</span></code>: Sort by first commit.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">"alpha"</span></code>: Alphabetically.</p></li>
</ul>
</dd>
<dt class="field-even">$AUTHORS_INCLUDE_ORGS</dt>
<dd class="field-even"><p>bool, Whether or not to include organizations in
the authors file, defaults to False.</p>
</dd>
<dt class="field-odd">$AUTHORS_MAILMAP</dt>
<dd class="field-odd"><p>str, bool, or None, If this is a non-empty string,
it will be interperted as a file path to a mailmap file that will be
generated based on the metadata provided. The default value is <code class="docutils literal notranslate"><span class="pre">".mailmap"</span></code>.
This is evaluated in the current environment.</p>
</dd>
</dl>
</dd>
</dl>
<p>This activity’s defaults are equivalent to the following <code class="docutils literal notranslate"><span class="pre">rever.xsh</span></code> file:</p>
<div class="highlight-xonsh notranslate"><div class="highlight"><pre><span></span><span class="nv">$ACTIVITIES</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'authors'</span><span class="p">]</span>
<span class="nv">$AUTHORS_FILENAME</span> <span class="o">=</span> <span class="s1">'AUTHORS'</span>
<span class="nv">$AUTHORS_TEMPLATE</span> <span class="o">=</span> <span class="s1">'All of the people who have made at least one contribution to $PROJECT.</span><span class="se">\n</span><span class="s1">Authors are sorted </span><span class="si">{sorting_text}</span><span class="s1">.</span><span class="se">\n\n</span><span class="si">{authors}</span><span class="se">\n</span><span class="s1">'</span>
<span class="nv">$AUTHORS_FORMAT</span> <span class="o">=</span> <span class="s1">'* </span><span class="si">{name}</span><span class="se">\n</span><span class="s1">'</span>
<span class="nv">$AUTHORS_LATEST</span> <span class="o">=</span> <span class="s1">'$REVER_DIR/LATEST-AUTHORS.json'</span>
<span class="nv">$AUTHORS_METADATA</span> <span class="o">=</span> <span class="s1">'.authors.yml'</span>
<span class="nv">$AUTHORS_SORTBY</span> <span class="o">=</span> <span class="s1">'num_commits'</span>
<span class="nv">$AUTHORS_INCLUDE_ORGS</span> <span class="o">=</span> <span class="kc">False</span>
<span class="nv">$AUTHORS_MAILMAP</span> <span class="o">=</span> <span class="s1">'.mailmap'</span>
</pre></div>
</div>
<hr class="docutils" />
</div>
<div class="section" id="bibtex">
<span id="id7"></span><h3>BibTex<a class="headerlink" href="#bibtex" title="Permalink to this headline">¶</a></h3>
<p>The BibTex activity class is available via:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">rever.activities.bibtex</span> <span class="kn">import</span> <span class="n">BibTex</span>
</pre></div>
</div>
<p>Writes a BibTex reference for the version of software.</p>
<p>Environment variables that directly affect the behaviour of this
activity are:</p>
<dl class="field-list simple">
<dt class="field-odd">$BIBTEX_BIBFILE</dt>
<dd class="field-odd"><p>str, The filename to create. Defaults to
<code class="docutils literal notranslate"><span class="pre">'bibtex.bib'</span></code>.</p>
</dd>
<dt class="field-even">$BIBTEX_PROJECT_NAME</dt>
<dd class="field-even"><p>str, The name of the project. This is expanded
in the current envrionment, default <code class="docutils literal notranslate"><span class="pre">$PROJECT</span></code>.</p>
</dd>
<dt class="field-odd">$BIBTEX_AUTHORS</dt>
<dd class="field-odd"><p>list of str, The name of the authors to credit
in the citation. Default has no authors.</p>
</dd>
<dt class="field-even">$BIBTEX_URL</dt>
<dd class="field-even"><p>str, URL to the project. This is expanded in the current
environment, default <code class="docutils literal notranslate"><span class="pre">'$WEBSITE_URL'</span></code>.</p>
</dd>
</dl>
<p>Other environment variables that affect the behaviour of the bibtex
activity are:</p>
<dl class="field-list simple">
<dt class="field-odd">$PROJECT</dt>
<dd class="field-odd"><p>Used as the default project name.</p>
</dd>
<dt class="field-even">$WEBSITE_URL</dt>
<dd class="field-even"><p>Used as the default URL.</p>
</dd>
<dt class="field-odd">$VERSION</dt>
<dd class="field-odd"><p>Used in the bibtex entry as part of the identifier.</p>
</dd>
</dl>
<p>This activity’s defaults are equivalent to the following <code class="docutils literal notranslate"><span class="pre">rever.xsh</span></code> file:</p>
<div class="highlight-xonsh notranslate"><div class="highlight"><pre><span></span><span class="nv">$ACTIVITIES</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'bibtex'</span><span class="p">]</span>
<span class="nv">$BIBTEX_BIBFILE</span> <span class="o">=</span> <span class="s1">'bibtex.bib'</span>
<span class="nv">$BIBTEX_PROJECT_NAME</span> <span class="o">=</span> <span class="s1">'$PROJECT'</span>
<span class="nv">$BIBTEX_AUTHORS</span> <span class="o">=</span> <span class="p">()</span>
<span class="nv">$BIBTEX_URL</span> <span class="o">=</span> <span class="s1">'$WEBSITE_URL'</span>
</pre></div>
</div>
<hr class="docutils" />
</div>
<div class="section" id="changelog">
<span id="id8"></span><h3>Changelog<a class="headerlink" href="#changelog" title="Permalink to this headline">¶</a></h3>
<p>The Changelog activity class is available via:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">rever.activities.changelog</span> <span class="kn">import</span> <span class="n">Changelog</span>
</pre></div>
</div>
<p>Manages keeping a changelog up-to-date.</p>
<blockquote>
<div><p>This activity may be configured with the following envionment variables:</p>
<dl class="field-list">
<dt class="field-odd">$CHANGELOG_FILENAME</dt>
<dd class="field-odd"><p>str, path to input file. The default is ‘CHANGELOG’.</p>
</dd>
<dt class="field-even">$CHANGELOG_PATTERN</dt>
<dd class="field-even"><p>str, Python regex that is used to find the location
in the file where new changelog entries should be placed. The default is
<code class="docutils literal notranslate"><span class="pre">'..</span> <span class="pre">current</span> <span class="pre">developments'</span></code>.</p>
</dd>
<dt class="field-odd">$CHANGELOG_HEADER</dt>
<dd class="field-odd"><p>str or callable that accepts a single version argument,
this is the replacement that goes above the new merge entries.
This should contain a string that matches the pattern arg
so that the next release may be inserted automatically.
The default value is:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span><span class="cp">.. current developments</span>
v$VERSION
====================
</pre></div>
</div>
</dd>
<dt class="field-even">$CHANGELOG_NEWS</dt>
<dd class="field-even"><p>str, path to directory containing news files.
The default is <code class="docutils literal notranslate"><span class="pre">'news'</span></code>.</p>
</dd>
<dt class="field-odd">$CHANGELOG_IGNORE</dt>
<dd class="field-odd"><p>list of str, regexes of filenames in the news directory
to ignore. The default is to ignore the template file.</p>
</dd>
<dt class="field-even">$CHANGELOG_LATEST</dt>
<dd class="field-even"><p>str, file to write just the latest part of the
changelog to. This defaults to <code class="docutils literal notranslate"><span class="pre">$REVER_DIR/LATEST</span></code>. This is evaluated
in the current environment. If this file is not within <code class="docutils literal notranslate"><span class="pre">$REVER_DIR</span></code>,
it is added to the repository.</p>
</dd>
<dt class="field-odd">$CHANGELOG_TEMPLATE</dt>
<dd class="field-odd"><p>str, filename of the template file in the
news directory. The default is <code class="docutils literal notranslate"><span class="pre">'TEMPLATE'</span></code>.</p>
</dd>
<dt class="field-even">$CHANGELOG_CATEGORIES</dt>
<dd class="field-even"><p>iterable of str, the news categories that are used.
Default:<code class="docutils literal notranslate"><span class="pre">('Added',</span> <span class="pre">'Changed',</span> <span class="pre">'Deprecated',</span> <span class="pre">'Removed',</span> <span class="pre">'Fixed',</span> <span class="pre">'Security')</span></code></p>
</dd>
<dt class="field-odd">$CHANGELOG_CATEGORY_TITLE_FORMAT</dt>
<dd class="field-odd"><p>str or callable, a format string with <code class="docutils literal notranslate"><span class="pre">{category}</span></code>
entry for formatting changelog and template category titles. If this is a callable,
it is a function which takes a single category argument and returns the title string.
The default is <a href="#id9"><span class="problematic" id="id10">``</span></a>”<strong>{category}:</strong></p>
</dd>
</dl>
</div></blockquote>
<dl class="simple">
<dt>“<a href="#id11"><span class="problematic" id="id12">``</span></a>.</dt><dd><dl class="field-list simple">
<dt class="field-odd">$CHANGELOG_AUTHORS_TITLE</dt>
<dd class="field-odd"><p>str or bool, If this is a non-empty string and the <code class="docutils literal notranslate"><span class="pre">authors</span></code>
activitiy is being run, this will append an authors section to this changelog entry
that contains all of the authors that contributed to this version. This string is
the section title and is formatted as if it were a category with
<code class="docutils literal notranslate"><span class="pre">$CHANGELOG_CATEGORY_TITLE_FORMAT</span></code>. The default is <code class="docutils literal notranslate"><span class="pre">"Authors"</span></code>.</p>
</dd>
<dt class="field-even">$CHANGELOG_AUTHORS_FORMAT</dt>
<dd class="field-even"><p>str, this is a format string that formats each author who
contributed to this release, if an authors section will be appened. This is
evaluated in the context of the authors, see the <code class="docutils literal notranslate"><span class="pre">authors</span></code> activity for more
details on the available fields. The default is <a href="#id13"><span class="problematic" id="id14">``</span></a>”* {name}</p>
</dd>
</dl>
</dd>
</dl>
<p>“<a href="#id15"><span class="problematic" id="id16">``</span></a>.</p>
<p>This activity’s defaults are equivalent to the following <code class="docutils literal notranslate"><span class="pre">rever.xsh</span></code> file:</p>
<div class="highlight-xonsh notranslate"><div class="highlight"><pre><span></span><span class="nv">$ACTIVITIES</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'changelog'</span><span class="p">]</span>
<span class="nv">$CHANGELOG_FILENAME</span> <span class="o">=</span> <span class="s1">'CHANGELOG'</span>
<span class="nv">$CHANGELOG_PATTERN</span> <span class="o">=</span> <span class="s1">'.. current developments'</span>
<span class="nv">$CHANGELOG_HEADER</span> <span class="o">=</span> <span class="s1">'.. current developments</span><span class="se">\n\n</span><span class="s1">v$VERSION</span><span class="se">\n</span><span class="s1">====================</span><span class="se">\n\n</span><span class="s1">'</span>
<span class="nv">$CHANGELOG_NEWS</span> <span class="o">=</span> <span class="s1">'news'</span>
<span class="nv">$CHANGELOG_IGNORE</span> <span class="o">=</span> <span class="kc">None</span>
<span class="nv">$CHANGELOG_LATEST</span> <span class="o">=</span> <span class="s1">'$REVER_DIR/LATEST'</span>
<span class="nv">$CHANGELOG_TEMPLATE</span> <span class="o">=</span> <span class="s1">'TEMPLATE'</span>
<span class="nv">$CHANGELOG_CATEGORIES</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'Added'</span><span class="p">,</span> <span class="s1">'Changed'</span><span class="p">,</span> <span class="s1">'Deprecated'</span><span class="p">,</span> <span class="s1">'Removed'</span><span class="p">,</span> <span class="s1">'Fixed'</span><span class="p">,</span> <span class="s1">'Security'</span><span class="p">)</span>
<span class="nv">$CHANGELOG_CATEGORY_TITLE_FORMAT</span> <span class="o">=</span> <span class="s1">'**</span><span class="si">{category}</span><span class="s1">:**</span><span class="se">\n\n</span><span class="s1">'</span>
<span class="nv">$CHANGELOG_AUTHORS_TITLE</span> <span class="o">=</span> <span class="s1">'Authors'</span>
<span class="nv">$CHANGELOG_AUTHORS_FORMAT</span> <span class="o">=</span> <span class="s1">'* </span><span class="si">{name}</span><span class="se">\n</span><span class="s1">'</span>
</pre></div>
</div>
<hr class="docutils" />
</div>
<div class="section" id="check">
<span id="id17"></span><h3>Check<a class="headerlink" href="#check" title="Permalink to this headline">¶</a></h3>
<p>The Check activity class is available via:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">rever.activities.check</span> <span class="kn">import</span> <span class="n">Check</span>
</pre></div>
</div>
<p>Run <cite>rever check</cite>.</p>
<p>This activity takes no parameters.</p>
<p>This activity’s defaults are equivalent to the following <code class="docutils literal notranslate"><span class="pre">rever.xsh</span></code> file:</p>
<div class="highlight-xonsh notranslate"><div class="highlight"><pre><span></span><span class="nv">$ACTIVITIES</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'check'</span><span class="p">]</span>
</pre></div>
</div>
<hr class="docutils" />
</div>
<div class="section" id="command">
<span id="id18"></span><h3>Command<a class="headerlink" href="#command" title="Permalink to this headline">¶</a></h3>
<p>The Command activity class is available via:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">rever.activities.command</span> <span class="kn">import</span> <span class="n">Command</span>
</pre></div>
</div>
<p>Runs a command</p>
<p>Optionally, an undo command can also be given to undo the given command</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The recommended way to create a command is with the
<a class="reference internal" href="api/activities/command.html#rever.activities.command.command" title="rever.activities.command.command"><code class="xref py py-func docutils literal notranslate"><span class="pre">rever.activities.command.command()</span></code></a> function.</p>
</div>
<hr class="docutils" />
</div>
<div class="section" id="condaforge">
<span id="id19"></span><h3>CondaForge<a class="headerlink" href="#condaforge" title="Permalink to this headline">¶</a></h3>
<p>The CondaForge activity class is available via:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">rever.activities.conda_forge</span> <span class="kn">import</span> <span class="n">CondaForge</span>
</pre></div>
</div>
<p>Updates conda-forge feedstocks.</p>
<p>The behaviour of this activity may be adjusted through the following
environment variables:</p>
<dl class="field-list">
<dt class="field-odd">$CONDA_FORGE_FEEDSTOCK</dt>
<dd class="field-odd"><p>str or None, feedstock name or URL,
default <code class="docutils literal notranslate"><span class="pre">$PROJECT-feedstock</span></code>.</p>
</dd>
<dt class="field-even">$CONDA_FORGE_PROTOCOL</dt>
<dd class="field-even"><p>str, one of <code class="docutils literal notranslate"><span class="pre">'ssh'</span></code>, <code class="docutils literal notranslate"><span class="pre">'http'</span></code>, or <code class="docutils literal notranslate"><span class="pre">'https'</span></code>
that specifies how the activity should interact with github when
cloning, pulling, or pushing to the feedstock repo. Note that
<code class="docutils literal notranslate"><span class="pre">'ssh'</span></code> requires you to have an SSH key registered with github.
The default is <code class="docutils literal notranslate"><span class="pre">'ssh'</span></code>.</p>
</dd>
<dt class="field-odd">$CONDA_FORGE_SOURCE_URL</dt>
<dd class="field-odd"><p>str, the URL that the recipe will use to
download the source code. This is needed so that we may update the
hash of the downloaded file. This string is evaluated with the current
environment. Default
<code class="docutils literal notranslate"><span class="pre">'https://github.com/$GITHUB_ORG/$GITHUB_REPO/archive/$VERSION.tar.gz'</span></code>.</p>
</dd>
<dt class="field-even">$CONDA_FORGE_HASH_TYPE</dt>
<dd class="field-even"><p>str, the type of hash that the recipe uses, eg
<code class="docutils literal notranslate"><span class="pre">'md5'</span></code> or <code class="docutils literal notranslate"><span class="pre">'sha256'</span></code>. Default <code class="docutils literal notranslate"><span class="pre">'sha256'</span></code>.</p>
</dd>
<dt class="field-odd">$CONDA_FORGE_PATTERNS</dt>
<dd class="field-odd"><p>list or 3-tuples of str, this is list of
(filename, pattern-regex, replacement) tuples that is evaluated
inside of the recipe directory. This is similar to the version bump
pattern structure. Both the pattern-regex str and the replacement str
will have environment variables expanded. The following environment
variables are added for this evaluation:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">$SOURCE_URL</span></code>: the fully expanded source code URL.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">$HASH_TYPE</span></code>: the hash type used to hash <code class="docutils literal notranslate"><span class="pre">$SOURCE_URL</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">$HASH</span></code>: the hexdigest of <code class="docutils literal notranslate"><span class="pre">$SOURCE_URL</span></code>.</p></li>
</ul>
<p>The default patterns match most standard recipes.</p>
</dd>
<dt class="field-even">$CONDA_FORGE_PULL_REQUEST</dt>
<dd class="field-even"><p>bool, whether the activity should open
a pull request to the upstream conda-forge feestock, default True.</p>
</dd>
<dt class="field-odd">$CONDA_FORGE_RERENDER</dt>
<dd class="field-odd"><p>bool, whether the activity should rerender the
feedstock using conda-smithy, default True.</p>
</dd>
<dt class="field-even">$CONDA_FORGE_FORK</dt>
<dd class="field-even"><p>bool, whether the activity should create a new fork of
the feedstock if it doesn’t exist already, default True.</p>
</dd>
<dt class="field-odd">$CONDA_FORGE_FORK_ORG</dt>
<dd class="field-odd"><p>str, the org to fork the recipe to or which holds
the fork, if <code class="docutils literal notranslate"><span class="pre">''</span></code> use the registered gh username, defaults to <code class="docutils literal notranslate"><span class="pre">''</span></code></p>
</dd>
</dl>
<p>Other environment variables that affect the behavior are:</p>
<dl class="field-list simple">
<dt class="field-odd">$GITHUB_CREDFILE</dt>
<dd class="field-odd"><p>the credential file to use. This should NOT be
set in the rever.xsh file</p>
</dd>
<dt class="field-even">$GITHUB_ORG</dt>
<dd class="field-even"><p>the github organization that the project belongs to.</p>
</dd>
<dt class="field-odd">$GITHUB_REPO</dt>
<dd class="field-odd"><p>the github repository of the project.</p>
</dd>
<dt class="field-even">$TAG_TEMPLATE</dt>
<dd class="field-even"><p>str, the template string used to tag the version, by default
this is ‘$VERSION’. Used to download project source.</p>
</dd>
<dt class="field-odd">$PROJECT</dt>
<dd class="field-odd"><p>the name of the project being released.</p>
</dd>
<dt class="field-even">$REVER_CONFIG_DIR</dt>
<dd class="field-even"><p>the user’s config directory for rever, which
is where the GitHub credential files are stored by default.</p>
</dd>
</dl>
<p>This activity’s defaults are equivalent to the following <code class="docutils literal notranslate"><span class="pre">rever.xsh</span></code> file:</p>
<div class="highlight-xonsh notranslate"><div class="highlight"><pre><span></span><span class="nv">$ACTIVITIES</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'conda_forge'</span><span class="p">]</span>
<span class="nv">$CONDA_FORGE_FEEDSTOCK</span> <span class="o">=</span> <span class="kc">None</span>
<span class="nv">$CONDA_FORGE_PROTOCOL</span> <span class="o">=</span> <span class="kc">None</span>
<span class="nv">$CONDA_FORGE_SOURCE_URL</span> <span class="o">=</span> <span class="kc">None</span>
<span class="nv">$CONDA_FORGE_HASH_TYPE</span> <span class="o">=</span> <span class="kc">None</span>
<span class="nv">$CONDA_FORGE_PATTERNS</span> <span class="o">=</span> <span class="kc">None</span>
<span class="nv">$CONDA_FORGE_PULL_REQUEST</span> <span class="o">=</span> <span class="kc">True</span>
<span class="nv">$CONDA_FORGE_RERENDER</span> <span class="o">=</span> <span class="kc">True</span>
<span class="nv">$CONDA_FORGE_FORK</span> <span class="o">=</span> <span class="kc">True</span>
<span class="nv">$CONDA_FORGE_FORK_ORG</span> <span class="o">=</span> <span class="kc">None</span>
</pre></div>
</div>
<hr class="docutils" />
</div>
<div class="section" id="deploytogcloud">
<span id="id20"></span><h3>DeploytoGCloud<a class="headerlink" href="#deploytogcloud" title="Permalink to this headline">¶</a></h3>
<p>The DeploytoGCloud activity class is available via:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">rever.activities.gcloud</span> <span class="kn">import</span> <span class="n">DeploytoGCloud</span>
</pre></div>
</div>
<p>Deploys a docker container to the google cloud</p>
<p>This activity may be configured with the following environment variables:</p>
<dl class="field-list simple">
<dt class="field-odd">$GCLOUD_PROJECT_ID</dt>
<dd class="field-odd"><p>str, the gcloud project id</p>
</dd>
<dt class="field-even">$GCLOUD_CLUSTER</dt>
<dd class="field-even"><p>str the kubernetes cluster to deploy to</p>
</dd>
<dt class="field-odd">$GCLOUD_ZONE</dt>
<dd class="field-odd"><p>str, the gcloud zone</p>
</dd>
<dt class="field-even">$GCLOUD_CONTAINER_NAME</dt>
<dd class="field-even"><p>str, the name of the container image to deploy to</p>
</dd>
<dt class="field-odd">$GCLOUD_DOCKER_HOST</dt>
<dd class="field-odd"><p>str, the name of the docker host to pull the container from, defaults to docker.io</p>
</dd>
<dt class="field-even">$GCLOUD_DOCKER_ORG</dt>
<dd class="field-even"><p>str, the name of the docker org to pull the container
from</p>
</dd>
<dt class="field-odd">$GCLOUD_DOCKER_REPO</dt>
<dd class="field-odd"><p>str, the name of the docker container repo to use</p>
</dd>
<dt class="field-even">$VERSION</dt>
<dd class="field-even"><p>str, the version of the container to use</p>
</dd>
</dl>
<p>This activity’s defaults are equivalent to the following <code class="docutils literal notranslate"><span class="pre">rever.xsh</span></code> file:</p>
<div class="highlight-xonsh notranslate"><div class="highlight"><pre><span></span><span class="nv">$ACTIVITIES</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'deploy_to_gcloud'</span><span class="p">]</span>
<span class="nv">$DEPLOY_TO_GCLOUD_PROJECT_ID</span> <span class="o">=</span> <span class="s1">'$$GCLOUD_PROJECT_ID'</span>
<span class="nv">$DEPLOY_TO_GCLOUD_CLUSTER</span> <span class="o">=</span> <span class="s1">'$GCLOUD_CLUSTER'</span>
<span class="nv">$DEPLOY_TO_GCLOUD_ZONE</span> <span class="o">=</span> <span class="s1">'$GCLOUD_ZONE'</span>
<span class="nv">$DEPLOY_TO_GCLOUD_CONTAINER_NAME</span> <span class="o">=</span> <span class="s1">'$GCLOUD_CONTAINER_NAME'</span>
<span class="nv">$DEPLOY_TO_GCLOUD_DOCKER_ORG</span> <span class="o">=</span> <span class="s1">'$GCLOUD_DOCKER_ORG'</span>
<span class="nv">$DEPLOY_TO_GCLOUD_DOCKER_REPO</span> <span class="o">=</span> <span class="s1">'$GCLOUD_DOCKER_REPO'</span>
</pre></div>
</div>
<hr class="docutils" />
</div>
<div class="section" id="deploytogcloudapp">
<span id="id21"></span><h3>DeploytoGCloudApp<a class="headerlink" href="#deploytogcloudapp" title="Permalink to this headline">¶</a></h3>
<p>The DeploytoGCloudApp activity class is available via:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">rever.activities.gcloud</span> <span class="kn">import</span> <span class="n">DeploytoGCloudApp</span>
</pre></div>
</div>
<p>Deploys an app to the google cloud via the app engine</p>
<p>This activity may be configured with the following environment variables:</p>
<dl class="field-list simple">
<dt class="field-odd">$GCLOUD_PROJECT_ID</dt>
<dd class="field-odd"><p>str, the gcloud project id</p>
</dd>
<dt class="field-even">$GCLOUD_ZONE</dt>
<dd class="field-even"><p>str, the gcloud zone</p>
</dd>
</dl>
<p>This activity’s defaults are equivalent to the following <code class="docutils literal notranslate"><span class="pre">rever.xsh</span></code> file:</p>
<div class="highlight-xonsh notranslate"><div class="highlight"><pre><span></span><span class="nv">$ACTIVITIES</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'deploy_to_gcloud_app'</span><span class="p">]</span>
<span class="nv">$DEPLOY_TO_GCLOUD_APP_PROJECT_ID</span> <span class="o">=</span> <span class="s1">'$$GCLOUD_PROJECT_ID'</span>
<span class="nv">$DEPLOY_TO_GCLOUD_APP_ZONE</span> <span class="o">=</span> <span class="s1">'$GCLOUD_ZONE'</span>
</pre></div>
</div>
<hr class="docutils" />
</div>
<div class="section" id="dockerbuild">
<span id="id22"></span><h3>DockerBuild<a class="headerlink" href="#dockerbuild" title="Permalink to this headline">¶</a></h3>
<p>The DockerBuild activity class is available via:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">rever.activities.docker</span> <span class="kn">import</span> <span class="n">DockerBuild</span>
</pre></div>
</div>
<p>Builds a Dockerfile.</p>
<p>The behaviour of this activity may be adjusted through the following
environment variables:</p>
<dl class="field-list simple">
<dt class="field-odd">$DOCKER_BUILD_PATH</dt>
<dd class="field-odd"><p>str, path to the Dockerfile, default (None) looks from
reads from <code class="docutils literal notranslate"><span class="pre">$DOCKERFILE</span></code>.</p>
</dd>
<dt class="field-even">$DOCKER_BUILD_CONTEXT</dt>
<dd class="field-even"><p>str, directory to execute the build within.
An empty string indicates that the image should be built in directory
containing the path. The default (None) reads from <code class="docutils literal notranslate"><span class="pre">$DOCKERFILE_CONTEXT</span></code>.</p>
</dd>
<dt class="field-odd">$DOCKER_BUILD_TAGS</dt>
<dd class="field-odd"><p>list of str, Tags the <code class="docutils literal notranslate"><span class="pre">$DOCKERFILE</span></code> should be built
and pushed with. Default (None) reads from <code class="docutils literal notranslate"><span class="pre">$DOCKERFILE_TAGS</span></code>.</p>
</dd>
<dt class="field-even">$DOCKER_BUILD_CACHE</dt>
<dd class="field-even"><p>bool, Flag for whether or not to use the cache,
default False.</p>
</dd>
</dl>
<p>This activity’s defaults are equivalent to the following <code class="docutils literal notranslate"><span class="pre">rever.xsh</span></code> file:</p>
<div class="highlight-xonsh notranslate"><div class="highlight"><pre><span></span><span class="nv">$ACTIVITIES</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'docker_build'</span><span class="p">]</span>
<span class="nv">$DOCKER_BUILD_PATH</span> <span class="o">=</span> <span class="kc">None</span>
<span class="nv">$DOCKER_BUILD_CONTEXT</span> <span class="o">=</span> <span class="kc">None</span>
<span class="nv">$DOCKER_BUILD_TAGS</span> <span class="o">=</span> <span class="kc">None</span>
<span class="nv">$DOCKER_BUILD_CACHE</span> <span class="o">=</span> <span class="kc">False</span>
</pre></div>
</div>
<hr class="docutils" />
</div>
<div class="section" id="dockerpush">
<span id="id23"></span><h3>DockerPush<a class="headerlink" href="#dockerpush" title="Permalink to this headline">¶</a></h3>
<p>The DockerPush activity class is available via:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">rever.activities.docker</span> <span class="kn">import</span> <span class="n">DockerPush</span>
</pre></div>
</div>
<p>Pushes a built Dockerfile.</p>
<p>The behaviour of this activity may be adjusted through the following
environment variables:</p>
<dl class="field-list simple">
<dt class="field-odd">$DOCKER_PUSH_TAGS</dt>
<dd class="field-odd"><p>list of str, Tags that the <code class="docutils literal notranslate"><span class="pre">$DOCKERFILE</span></code> should be built
and pushed with. Default (None) reads from <code class="docutils literal notranslate"><span class="pre">$DOCKERFILE_TAGS</span></code>.</p>
</dd>
</dl>
<p>This activity’s defaults are equivalent to the following <code class="docutils literal notranslate"><span class="pre">rever.xsh</span></code> file:</p>
<div class="highlight-xonsh notranslate"><div class="highlight"><pre><span></span><span class="nv">$ACTIVITIES</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'docker_push'</span><span class="p">]</span>
<span class="nv">$DOCKER_PUSH_TAGS</span> <span class="o">=</span> <span class="kc">None</span>
</pre></div>
</div>
<hr class="docutils" />
</div>
<div class="section" id="forge">
<span id="id24"></span><h3>Forge<a class="headerlink" href="#forge" title="Permalink to this headline">¶</a></h3>
<p>The Forge activity class is available via:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">rever.activities.forge</span> <span class="kn">import</span> <span class="n">Forge</span>
</pre></div>
</div>
<p>Updates a forge feedstock.</p>
<p>The behaviour of this activity may be adjusted through the following
environment variables:</p>
<dl class="field-list">
<dt class="field-odd">$FORGE_FEEDSTOCK</dt>
<dd class="field-odd"><p>str or None, feedstock name or URL,
default <code class="docutils literal notranslate"><span class="pre">$PROJECT-feedstock</span></code>.</p>
</dd>
<dt class="field-even">$FORGE_PROTOCOL</dt>
<dd class="field-even"><p>str, one of <code class="docutils literal notranslate"><span class="pre">'ssh'</span></code>, <code class="docutils literal notranslate"><span class="pre">'http'</span></code>, or <code class="docutils literal notranslate"><span class="pre">'https'</span></code>
that specifies how the activity should interact with github when
cloning, pulling, or pushing to the feedstock repo. Note that
<code class="docutils literal notranslate"><span class="pre">'ssh'</span></code> requires you to have an SSH key registered with github.
The default is <code class="docutils literal notranslate"><span class="pre">'ssh'</span></code>.</p>
</dd>
<dt class="field-odd">$FORGE_SOURCE_URL</dt>
<dd class="field-odd"><p>str, the URL that the recipe will use to
download the source code. This is needed so that we may update the
hash of the downloaded file. This string is evaluated with the current
environment. Default
<code class="docutils literal notranslate"><span class="pre">'https://github.com/$GITHUB_ORG/$GITHUB_REPO/archive/$VERSION.tar.gz'</span></code>.</p>
</dd>
<dt class="field-even">$FORGE_HASH_TYPE</dt>
<dd class="field-even"><p>str, the type of hash that the recipe uses, eg
<code class="docutils literal notranslate"><span class="pre">'md5'</span></code> or <code class="docutils literal notranslate"><span class="pre">'sha256'</span></code>. Default <code class="docutils literal notranslate"><span class="pre">'sha256'</span></code>.</p>
</dd>
<dt class="field-odd">$FORGE_PATTERNS</dt>
<dd class="field-odd"><p>list or 3-tuples of str, this is list of
(filename, pattern-regex, replacement) tuples that is evaluated
inside of the recipe directory. This is similar to the version bump
pattern structure. Both the pattern-regex str and the replacement str
will have environment variables expanded. The following environment
variables are added for this evaluation (only if $FORGE_USE_GIT_URL is False):</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">$SOURCE_URL</span></code>: the fully expanded source code URL.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">$HASH_TYPE</span></code>: the hash type used to hash <code class="docutils literal notranslate"><span class="pre">$SOURCE_URL</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">$HASH</span></code>: the hexdigest of <code class="docutils literal notranslate"><span class="pre">$SOURCE_URL</span></code>.</p></li>
</ul>
<p>The default patterns match most standard recipes.</p>
</dd>
<dt class="field-even">$FORGE_PULL_REQUEST</dt>
<dd class="field-even"><p>bool, whether the activity should open
a pull request to the upstream conda-forge feestock, default True.</p>
</dd>
<dt class="field-odd">$FORGE_RERENDER</dt>
<dd class="field-odd"><p>bool, whether the activity should rerender the
feedstock using conda-smithy, default True.</p>
</dd>
<dt class="field-even">$FORGE_FEEDSTOCK_ORG</dt>
<dd class="field-even"><p>str, specify the feedstock organization. Must be set.</p>
</dd>
<dt class="field-odd">$FORGE_FORK</dt>
<dd class="field-odd"><p>bool, whether the activity should create a new fork of
the feedstock if it doesn’t exist already, default True.</p>
</dd>
<dt class="field-even">$FORGE_FORK_ORG</dt>
<dd class="field-even"><p>str, the org to fork the recipe to or which holds
the fork, if <code class="docutils literal notranslate"><span class="pre">''</span></code> use the registered gh username, defaults to <code class="docutils literal notranslate"><span class="pre">''</span></code></p>
</dd>
<dt class="field-odd">$FORGE_USE_GIT_URL</dt>
<dd class="field-odd"><p>bool, whether or not to use <cite>git_url</cite> in the recipe source
url, default True.</p>
</dd>
<dt class="field-even">$FORGE_RECIPE_DIR</dt>
<dd class="field-even"><p>str, the name of the recipe folder, default is ‘recipe’.</p>
</dd>
</dl>
<p>Other environment variables that affect the behavior are:</p>
<dl class="field-list simple">
<dt class="field-odd">$GITHUB_CREDFILE</dt>
<dd class="field-odd"><p>the credential file to use. This should NOT be
set in the rever.xsh file</p>
</dd>
<dt class="field-even">$GITHUB_ORG</dt>
<dd class="field-even"><p>the github organization that the project belongs to.</p>
</dd>
<dt class="field-odd">$GITHUB_REPO</dt>
<dd class="field-odd"><p>the github repository of the project.</p>
</dd>
<dt class="field-even">$TAG_TEMPLATE</dt>
<dd class="field-even"><p>str, the template string used to tag the version, by default
this is ‘$VERSION’. Used to download project source.</p>
</dd>
<dt class="field-odd">$PROJECT</dt>
<dd class="field-odd"><p>the name of the project being released.</p>
</dd>
<dt class="field-even">$REVER_CONFIG_DIR</dt>
<dd class="field-even"><p>the user’s config directory for rever, which
is where the GitHub credential files are stored by default.</p>
</dd>
</dl>
<p>This activity’s defaults are equivalent to the following <code class="docutils literal notranslate"><span class="pre">rever.xsh</span></code> file:</p>
<div class="highlight-xonsh notranslate"><div class="highlight"><pre><span></span><span class="nv">$ACTIVITIES</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'forge'</span><span class="p">]</span>
<span class="nv">$FORGE_FEEDSTOCK</span> <span class="o">=</span> <span class="kc">None</span>
<span class="nv">$FORGE_FEEDSTOCK_ORG</span> <span class="o">=</span> <span class="kc">None</span>
<span class="nv">$FORGE_PROTOCOL</span> <span class="o">=</span> <span class="kc">None</span>
<span class="nv">$FORGE_SOURCE_URL</span> <span class="o">=</span> <span class="kc">None</span>
<span class="nv">$FORGE_HASH_TYPE</span> <span class="o">=</span> <span class="kc">None</span>
<span class="nv">$FORGE_PATTERNS</span> <span class="o">=</span> <span class="kc">None</span>
<span class="nv">$FORGE_PULL_REQUEST</span> <span class="o">=</span> <span class="kc">True</span>
<span class="nv">$FORGE_RERENDER</span> <span class="o">=</span> <span class="kc">True</span>
<span class="nv">$FORGE_FORK</span> <span class="o">=</span> <span class="kc">True</span>
<span class="nv">$FORGE_FORK_ORG</span> <span class="o">=</span> <span class="kc">None</span>
<span class="nv">$FORGE_USE_GIT_URL</span> <span class="o">=</span> <span class="kc">False</span>
<span class="nv">$FORGE_RECIPE_DIR</span> <span class="o">=</span> <span class="kc">None</span>
</pre></div>
</div>
<hr class="docutils" />
</div>
<div class="section" id="ghpages">
<span id="id25"></span><h3>GHPages<a class="headerlink" href="#ghpages" title="Permalink to this headline">¶</a></h3>
<p>The GHPages activity class is available via:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">rever.activities.ghpages</span> <span class="kn">import</span> <span class="n">GHPages</span>
</pre></div>
</div>
<p>Activity for pushing documentation up to GitHub pages.</p>
<p>This activity uses the following environment variable:</p>
<dl class="field-list simple">
<dt class="field-odd">$GHPAGES_REPO</dt>
<dd class="field-odd"><p>str, the URL of the GitHUb pages repository.</p>
</dd>
<dt class="field-even">$GHPAGES_BRANCH</dt>
<dd class="field-even"><p>str, the GitHub pages branch name, i.e. either
<code class="docutils literal notranslate"><span class="pre">gh-pages</span></code> or <code class="docutils literal notranslate"><span class="pre">master</span></code>. If not provided, the activity will
attempt to deduce it from the repo name.</p>
</dd>
<dt class="field-odd">$GHPAGES_COPY</dt>
<dd class="field-odd"><p>list or str 2-tuples, This is a list of (src, dst)
pairs of files to copy from the project into the gh-pages repo.
These pairs will have environment variables expanded and it is
evaluated in the current directory (where rever was run from).
src files or directories that don’t exist will be skipped.
After variable expansion, this list will be deduplicated.
Additionally, the environment variable <code class="docutils literal notranslate"><span class="pre">$GHPAGES_REPO_DIR</span></code>
is added to allow easy access to the local clone of the
repo, which is at <code class="docutils literal notranslate"><span class="pre">$REVER_DIR/ghpages-repo</span></code>. By default,
this will look in the sphinx html directory created by the
sphinx activity.</p>
</dd>
</dl>
<p>This activity’s defaults are equivalent to the following <code class="docutils literal notranslate"><span class="pre">rever.xsh</span></code> file:</p>
<div class="highlight-xonsh notranslate"><div class="highlight"><pre><span></span><span class="nv">$ACTIVITIES</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'ghpages'</span><span class="p">]</span>
<span class="nv">$GHPAGES_REPO</span> <span class="o">=</span> <span class="s1">'<no default value>'</span>
<span class="nv">$GHPAGES_BRANCH</span> <span class="o">=</span> <span class="kc">None</span>
<span class="nv">$GHPAGES_COPY</span> <span class="o">=</span> <span class="p">(</span>
<span class="p">(</span><span class="s1">'$SPHINX_HOST_DIR/html'</span><span class="p">,</span> <span class="s1">'$GHPAGES_REPO_DIR'</span><span class="p">),</span>
<span class="p">(</span><span class="s1">'$REVER_DIR/sphinx-build/html'</span><span class="p">,</span> <span class="s1">'$GHPAGES_REPO_DIR'</span><span class="p">),</span>
<span class="p">)</span>
</pre></div>
</div>
<hr class="docutils" />
</div>
<div class="section" id="ghrelease">
<span id="id26"></span><h3>GHRelease<a class="headerlink" href="#ghrelease" title="Permalink to this headline">¶</a></h3>
<p>The GHRelease activity class is available via:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">rever.activities.ghrelease</span> <span class="kn">import</span> <span class="n">GHRelease</span>
</pre></div>
</div>
<p>Performs a github release.</p>
<p>The behaviour of this activity may be adjusted through the following
environment variables:</p>
<dl class="field-list simple">
<dt class="field-odd">$GHRELEASE_NAME</dt>
<dd class="field-odd"><p>str, Name of the release. This is evaluated with the
version. Default is <code class="docutils literal notranslate"><span class="pre">$VERSION</span></code></p>
</dd>
<dt class="field-even">$GHRELEASE_NOTES</dt>
<dd class="field-even"><p>str or None, Release notes to send to the release
page. If None (the default), this is read from <code class="docutils literal notranslate"><span class="pre">$CHANGELOG_LATEST</span></code>,
if present, or failing that <code class="docutils literal notranslate"><span class="pre">$REVER_DIR/LATEST</span></code>. If neither file exists,
an empty string is passes in.</p>
</dd>
<dt class="field-odd">$GHRELEASE_PREPEND</dt>
<dd class="field-odd"><p>str, string to prepend to the release notes,
defaults to ‘’</p>
</dd>
<dt class="field-even">$GHRELEASE_APPEND</dt>
<dd class="field-even"><p>str, string to append to the release notes,
defaults to ‘’</p>
</dd>
<dt class="field-odd">$GHRELEASE_ASSETS</dt>
<dd class="field-odd"><p>iterable of str or functions, Extra assests to
upload to the GitHub release. This is ususally a tarball of the source
code or a binary package. If the asset is a string, it is interpreted
as a filename (and evalauated in the current environment). If the asset
is a function, the function is called with no arguments and should return
either a string filename or a list of string filenames. The asset
functions will usually generate or acquire the asset. By default, this
a tarball of the release tag will be uploaded.</p>
</dd>
<dt class="field-even">$GHRELEASE_TARGET</dt>
<dd class="field-even"><p>str or None, the git branch/commit to target for the release.
If this value is None, it will use the default branch name, as specified on
the GitHub repo.</p>
</dd>
</dl>
<p>Other environment variables that affect the behavior are:</p>
<dl class="field-list simple">
<dt class="field-odd">$GITHUB_CREDFILE</dt>
<dd class="field-odd"><p>the credential file to use.</p>
</dd>
<dt class="field-even">$GITHUB_ORG</dt>
<dd class="field-even"><p>the github organization that the project belongs to.</p>
</dd>
<dt class="field-odd">$GITHUB_REPO</dt>
<dd class="field-odd"><p>the github repository of the project.</p>
</dd>
<dt class="field-even">$REVER_CONFIG_DIR</dt>
<dd class="field-even"><p>the user’s config directory for rever, which
is where the GitHub credential files are stored by default.</p>
</dd>
<dt class="field-odd">$CHANGELOG_LATEST</dt>
<dd class="field-odd"><p>path to the latest release notes file
created by the changelog activity.</p>
</dd>
<dt class="field-even">$TAG_TEMPLATE</dt>
<dd class="field-even"><p>may used to find the tag name when creating the default
asset.</p>
</dd>
</dl>
<p>This activity’s defaults are equivalent to the following <code class="docutils literal notranslate"><span class="pre">rever.xsh</span></code> file:</p>
<div class="highlight-xonsh notranslate"><div class="highlight"><pre><span></span><span class="nv">$ACTIVITIES</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'ghrelease'</span><span class="p">]</span>
<span class="nv">$GHRELEASE_NAME</span> <span class="o">=</span> <span class="s1">'$VERSION'</span>
<span class="nv">$GHRELEASE_NOTES</span> <span class="o">=</span> <span class="kc">None</span>
<span class="nv">$GHRELEASE_PREPEND</span> <span class="o">=</span> <span class="s1">''</span>
<span class="nv">$GHRELEASE_APPEND</span> <span class="o">=</span> <span class="s1">''</span>
<span class="nv">$GHRELEASE_ASSETS</span> <span class="o">=</span> <span class="p">(</span><span class="o"><</span><span class="n">function</span> <span class="n">git_archive_asset</span> <span class="n">at</span> <span class="mh">0x7fa9816f60d0</span><span class="o">></span><span class="p">,</span> <span class="p">)</span>
<span class="nv">$GHRELEASE_TARGET</span> <span class="o">=</span> <span class="kc">None</span>
</pre></div>
</div>
<hr class="docutils" />
</div>
<div class="section" id="nose">
<span id="id27"></span><h3>Nose<a class="headerlink" href="#nose" title="Permalink to this headline">¶</a></h3>
<p>The Nose activity class is available via:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">rever.activities.nose</span> <span class="kn">import</span> <span class="n">Nose</span>
</pre></div>
</div>
<p>Runs nose tests inside of a container.</p>
<p>Environment variables that modify this activity’s behaviour are:</p>
<dl class="field-list simple">
<dt class="field-odd">$NOSE_COMMAND</dt>
<dd class="field-odd"><p>str, nose command to execute, defaults to ‘nosetests’.</p>
</dd>
<dt class="field-even">$NOSE_ARGS</dt>
<dd class="field-even"><p>str or list of str, additional arguments to send to the
nose command. By default no additional arguments are sent.</p>
</dd>
</dl>
<p>This activity’s defaults are equivalent to the following <code class="docutils literal notranslate"><span class="pre">rever.xsh</span></code> file:</p>
<div class="highlight-xonsh notranslate"><div class="highlight"><pre><span></span><span class="nv">$ACTIVITIES</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'nose'</span><span class="p">]</span>
<span class="nv">$NOSE_COMMAND</span> <span class="o">=</span> <span class="s1">'nosetests'</span>
<span class="nv">$NOSE_ARGS</span> <span class="o">=</span> <span class="p">()</span>
</pre></div>
</div>
<hr class="docutils" />
</div>
<div class="section" id="pushtag">
<span id="id28"></span><h3>PushTag<a class="headerlink" href="#pushtag" title="Permalink to this headline">¶</a></h3>
<p>The PushTag activity class is available via:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">rever.activities.push_tag</span> <span class="kn">import</span> <span class="n">PushTag</span>
</pre></div>
</div>
<p>Pushes the current tag up to a remote repository.</p>
<p>This activity takes the following parameters:</p>
<dl class="field-list simple">
<dt class="field-odd">$PUSH_TAG_REMOTE</dt>
<dd class="field-odd"><p>str or None, remote URL to push tags to. If <code class="docutils literal notranslate"><span class="pre">$REVER_VCS</span></code> is
set to <code class="docutils literal notranslate"><span class="pre">'git'</span></code> and both <code class="docutils literal notranslate"><span class="pre">$GITHUB_ORG</span></code> and <code class="docutils literal notranslate"><span class="pre">$GITHUB_REPO</span></code> are also set,
this variable will default to <code class="docutils literal notranslate"><span class="pre">git@github.com:$GITHUB_ORG/$GITHUB_REPO.git</span></code>.</p>
</dd>
<dt class="field-even">$PUSH_TAG_TARGET</dt>
<dd class="field-even"><p>str or None, remote branch to push to once the tag has been made.
The default is None, which uses the current branch.</p>
</dd>
<dt class="field-odd">$PUSH_TAG_PROTOCOL</dt>
<dd class="field-odd"><p>str or None, the protocol to use to for the push, if
None, use ssh. Available protocols are <code class="docutils literal notranslate"><span class="pre">http</span></code>, <code class="docutils literal notranslate"><span class="pre">https</span></code>, and <code class="docutils literal notranslate"><span class="pre">ssh</span></code></p>
</dd>
</dl>
<p>Other environment variables that affect the behavior are:</p>
<dl class="field-list simple">
<dt class="field-odd">$REVER_VCS</dt>
<dd class="field-odd"><p>str or None, is used to help specify default remote URLs.</p>
</dd>
<dt class="field-even">$GITHUB_ORG</dt>
<dd class="field-even"><p>str or None, GitHub org to push to if no <code class="docutils literal notranslate"><span class="pre">$PUSH_TAG_REMOTE</span></code></p>
</dd>
<dt class="field-odd">$GITHUB_REPO</dt>
<dd class="field-odd"><p>str or None GitHub repo to push to if no <code class="docutils literal notranslate"><span class="pre">$PUSH_TAG_REMOTE</span></code></p>
</dd>