source: project/wiki/eggref/4/egg-tarballs @ 34628

Last change on this file since 34628 was 34628, checked in by Mario Domenech Goulart, 3 years ago

egg-tarballs (wiki): release note for version 0.7.1

File size: 4.2 KB
Line 
1== egg-tarballs
2
3[[toc:]]
4
5=== Description
6
7A command line tool to generate tarballs and their respective sha1
8sums for eggs in [[/egg/henrietta-cache|henrietta cache]].
9
10
11=== Author
12
13[[/users/mario-domenech-goulart|Mario Domenech Goulart]]
14
15
16=== Repository
17
18[[https://github.com/mario-goulart/egg-tarballs|https://github.com/mario-goulart/egg-tarballs]]
19
20
21=== Requirements
22
23[[/egg/simple-sha1|simple-sha1]]
24
25
26=== Tools
27
28This egg provides two command line tools: {{egg-tarballs}} and
29{{egg-tarballs-index}}.
30
31==== egg-tarballs
32
33{{egg-tarballs}} generates tarballs for egg sources from a cache
34directory generated by [[/egg/henrietta-cache|henrietta-cache]].
35
36  $ egg-tarballs -help
37  Usage: egg-tarballs [-verbose] <henrietta cache dir> <tarballs dir>
38
39{{<henrietta cache dir>}} is the path to the henrietta cache directory
40containing egg sources.  {{<tarballs dir>}} is the directory where
41tarballs will be generated.
42
43
44==== egg-tarballs-index
45
46{{egg-tarballs-index}} generates index files for eggs.  Index files
47summarize information about all eggs (see the next subsection for
48their format).  {{egg-tarballs-index}} generates two index files: a
49small one ({{index-latest.scm}}), containing information about the
50latest egg versions only; and a bigger one ({{index.scm}}), containing
51information about all versions of all eggs.
52
53  $ egg-tarballs-index
54  Usage: egg-tarballs-index [-version] [-O|-out-dir <out dir>] <henrietta cache dir> <tarballs dir>
55 
56  If <out dir> is not provided, files are written to the current directory.
57 
58  This program must be run _after_ egg-tarballs, since it needs
59  information from tarballs and sum files.
60
61===== Index file format
62
63* The first line is the index format version
64
65* the following lines have this format:
66
67  (<egg> <version> <tarball size> <tarball SHA1 sum> <dependencies> <test dependencies>)
68
69
70=== Notes
71
72* Starting on version 1.0.0, [[/egg/henrietta-cache|henrietta-cache]]
73uses a new cache format (the egg sources directory layout no longer
74contains the {{tags}} directory).  The support for the new cache
75format has been added to egg-tarballs 0.5.0 (it also supports the
76old format).
77
78
79=== License
80
81 Copyright (c) 2011-2015, Mario Domenech Goulart
82 All rights reserved.
83 
84 Redistribution and use in source and binary forms, with or without
85 modification, are permitted provided that the following conditions are
86 met:
87 
88 Redistributions of source code must retain the above copyright
89 notice, this list of conditions and the following disclaimer.
90 
91 Redistributions in binary form must reproduce the above copyright
92 notice, this list of conditions and the following disclaimer in the
93 documentation and/or other materials provided with the distribution.
94 
95 Neither the name of the author nor the names of its contributors may
96 be used to endorse or promote products derived from this software
97 without specific prior written permission.
98 
99 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
100 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
101 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
102 FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
103 COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
104 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
105 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
106 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
107 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
108 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
109 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
110 OF THE POSSIBILITY OF SUCH DAMAGE.
111
112
113=== Version history
114
115===== version 0.7.1
116* Fix tests
117
118===== version 0.7.0
119* egg-tarballs-index: make sure that all dependencies are symbols
120* egg-tarballs-index: bump index format version to 2
121
122===== version 0.6.0
123* Add {{egg-tarballs-index}}
124
125===== version 0.5.0
126* Compatibility with both old and new henrietta-cache cache formats
127
128===== version 0.4.1
129* Fix tests so that they work for both [[/egg/salmonella|salmonella]] and {{chicken-install -test}} when CHICKEN tools are not in system's {{PATH}}
130
131===== version 0.4
132* More test fixes
133
134===== version 0.3
135* Test fixes
136
137===== version 0.2
138* Initial release
Note: See TracBrowser for help on using the repository browser.