CHANGES.txt 12.9 KB
Newer Older
jim's avatar
jim committed
1 2
Status
******
jim's avatar
jim committed
3

jim's avatar
jim committed
4 5 6 7 8 9 10 11 12 13
The buildout system is under active development. Some near term
priorities include:

- Fixing `bugs <https://launchpad.net/products/zc.buildout/+bugs>`_

- Adding support for making distributions from buildouts

Change History
**************

14 15 16 17 18 19 20 21 22 23 24 25 26 27
1.0.0b25 (2007-05-??)
=====================

Feature Changes
---------------

- buildout changes to the buildout directory before running recipe
  install and update methods.

Bugs Fixed
----------

- 59270: Buggy recipes can cause failures in later recipes via chdir

28 29 30 31 32
- 61890: file:// urls don't seem to work in find-links

  setuptools requires that file urls that point to directories must
  end in a "/".  Added a workaround.

jim's avatar
jim committed
33
1.0.0b24 (2007-05-09)
jim's avatar
jim committed
34 35 36 37 38 39 40 41
=====================

Feature Changes
---------------

- Improved error reporting by showing which packages require other
  packages that can't be found or that cause version conflicts.

42 43 44
- Added an API for use by recipe writers to clean up created files
  when recipe errors occur.

jim's avatar
jim committed
45 46
- Log installed scripts.

47 48 49 50
Bugs Fixed
----------

- 92891: bootstrap crashes with recipe option in buildout section.
jim's avatar
jim committed
51

52 53 54 55
- 113085: Buildout exited with a zero exist status when internal errors
  occured.


jim's avatar
jim committed
56
1.0.0b23 (2007-03-19)
jim's avatar
jim committed
57 58
=====================

jim's avatar
jim committed
59 60 61 62 63 64 65 66 67
Feature Changes
---------------

- Added support for download caches.  A buildout can specify a cache
  for distribution downloads.  The cache can be shared among buildouts
  to reduce network access and to support creating source
  distributions for applications allowing install without network
  access. 

jim's avatar
jim committed
68 69 70
- Log scripts created, as suggested in:
  https://bugs.launchpad.net/zc.buildout/+bug/71353

jim's avatar
jim committed
71 72 73 74 75 76
Bugs Fixed
----------

- It wasn't possible to give options on the command line for sections
  not defined in a configuration file.

jim's avatar
jim committed
77
1.0.0b22 (2007-03-15)
jim's avatar
jim committed
78 79 80 81 82
=====================

Feature Changes
---------------

83
- Improved error reporting and debugging support:
84

85 86 87
  - Added "logical tracebacks" that show functionally what the buildout
    was doing when an error occurs.  Don't show a Python traceback
    unless the -D option is used.
jim's avatar
jim committed
88

89 90
  - Added a -D option that causes the buildout to print a traceback and
    start the pdb post-mortem debugger when an error occurs.
jim's avatar
jim committed
91

92 93 94 95 96 97 98 99 100 101
  - Warnings are printed for unused options in the buildout section and
    installed-part sections.  This should make it easier to catch option
    misspellings.

- Changed the way the installed database (.installed.cfg) is handled
  to avoid database corruption when a user breaks out of a buildout
  with control-c.

- Don't save an installed database if there are no installed parts or
  develop egg links.
102

103
1.0.0b21 (2007-03-06)
104 105 106 107 108
=====================

Feature Changes
---------------

109 110 111
- Added support for repeatable buildouts by allowing egg versions to
  be specified in a versions section.

jim's avatar
jim committed
112 113 114 115 116 117 118 119 120 121
- The easy_install module install and build functions now accept a
  versions argument that supplied to mapping from project name to
  version numbers.  This can be used to fix version numbers for
  required distributions and their depenencies.

  When a version isn't fixed, using either a versions option or using
  a fixed version number in a requirement, then a debug log message is
  emitted indicating the version picked.  This is useful for setting
  versions options.

122 123 124
  A default_versions function can be used to set a default value for
  this option.

125 126 127 128
- Adjusted the output for verbosity levels.  Using a single -v option
  no longer causes voluminous setuptools output.  Uisng -vv and -vvv
  now triggers extra setuptools output.

jim's avatar
jim committed
129 130
- Added a remove testing helper function that removes files or directories.

jim's avatar
jim committed
131
1.0.0b20 (2007-02-08)
jim's avatar
jim committed
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
=====================

Feature Changes
---------------

- Added a buildout newest option, to control whether the newest
  distributions should be sought to meet requirements.  This might
  also provide a hint to recipes that don't deal with
  distributions. For example, a recipe that manages subversion
  checkouts might not update a checkout if newest is set to "false".

- Added a *newest* keyword parameter to the
  zc.buildout.easy_install.install and zc.buildout.easy_install.build
  functions to control whether the newest distributions that meed
  given requirements should be sought.  If a false value is provided
  for this parameter and already installed eggs meet the given
  requirements, then no attempt will be made to search for newer
  distributions.
 
- The recipe-testing support setUp function now adds the name
  *buildout* to the test namespace with a value that is the path to
  the buildout script in the sample buildout.  This allows tests to
  use

    >>> print system(buildout),

  rather than:

    >>> print system(join('bin', 'buildout')),


Bugs Fixed
----------

- Paths returned from update methods replaced lists of installed files
  rather than augmenting them.

jim's avatar
jim committed
169 170 171 172 173 174 175 176 177 178
1.0.0b19 (2007-01-24)
=====================

Bugs Fixed
----------

- Explicitly specifying a Python executable failed if the output of
  running Python with the -V option included a 2-digit (rather than a
  3-digit) version number.

jim's avatar
jim committed
179
1.0.0b18 (2007-01-22)
180 181 182 183 184 185 186 187
=====================

Feature Changes
---------------

- Added documentation for some previously undocumented features of the 
  easy_install APIs.

jim's avatar
jim committed
188 189 190
- By popular demand, added a -o command-line option that is a short
  hand for the assignment buildout:offline=true.

191 192 193
Bugs Fixed
----------

jim's avatar
jim committed
194 195 196
- When deciding whether recipe develop eggs had changed, buildout
  incorrectly considered files in .svn and CVS directories.

197 198 199 200 201 202 203 204
1.0.0b17 (2006-12-07)
=====================

Feature Changes
---------------

- Configuration files can now be loaded from URLs.

jim's avatar
jim committed
205 206 207 208 209 210 211 212 213
Bugs Fixed
----------

- https://bugs.launchpad.net/products/zc.buildout/+bug/71246

  Buildout extensions installed as eggs couldn't be loaded in offline
  mode.


jim's avatar
jim committed
214
1.0.0b16 (2006-12-07)
215 216
=====================

jim's avatar
jim committed
217 218 219 220 221 222 223 224 225
Feature Changes
---------------

- A new command-line argument, -U, suppresses reading user defaults.

- You can now suppress use of an installed-part database
  (e.g. .installed.cfg) by sprifying an empty value for the buildout
  installed option.

226 227 228 229 230 231 232
Bugs Fixed
----------

- When the install command is used with a list of parts, only
  those parts are supposed to be installed, but the buildout was also
  building parts that those parts depended on.

jim's avatar
jim committed
233 234 235 236 237 238 239 240 241
1.0.0b15 (2006-12-06)
=====================

Bugs Fixed
----------

- Uninstall recipes weren't loaded correctly in cases where
  no parts in the (new) configuration used the recipe egg.

jim's avatar
jim committed
242
1.0.0b14 (2006-12-05)
jim's avatar
jim committed
243
=====================
amos's avatar
amos committed
244 245 246 247 248 249 250

Feature Changes
---------------

- Added uninstall recipes for dealing with complex uninstallation
  scenarios.

jim's avatar
jim committed
251 252 253 254 255 256 257 258 259
Bugs Fixed
----------

- Automatic upgrades weren't performed on Windows due to a bug that
  caused buildout to incorrectly determine that it wasn't running
  locally in a buildout.

- Fixed some spurious test failures on Windows.

260
1.0.0b13 (2006-12-04)
jim's avatar
jim committed
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
Feature Changes
---------------

- Variable substitutions now reflect option data written by recipes.

- A part referenced by a part in a parts list is now added to the parts
  list before the referencing part.  This means that you can omit
  parts from the parts list if they are referenced by other parts.

- Added a develop function to the easy_install module to aid in
  creating develop eggs with custom build_ext options.

- The build and develop functions in the easy_install module now
  return the path of the egg or egg link created.

- Removed the limitation that parts named in the install command can
  only name configured parts.

- Removed support ConfigParser-style variable substitutions
  (e.g. %(foo)s). Only the string-template style of variable
  (e.g. ${section:option}) substitutions will be supported.
  Supporting both violates "there's only one way to do it".

- Deprecated the buildout-section extendedBy option.

jim's avatar
jim committed
288 289 290 291 292 293 294 295 296
Bugs Fixed
----------

- We treat setuptools as a dependency of any distribution that
  (declares that it) uses namespace packages, whether it declares
  setuptools as a dependency or not.  This wasn't working for eggs
  intalled by virtue of being dependencies.


297 298 299 300 301 302 303 304 305 306
1.0.0b12 (2006-10-24)
=====================

Feature Changes
---------------

- Added an initialization argument to the
  zc.buildout.easy_install.scripts function to include initialization
  code in generated scripts.

jim's avatar
jim committed
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
1.0.0b11 (2006-10-24)
=====================

Bugs Fixed
----------

`67737 <https://launchpad.net/products/zc.buildout/+bug/67737>`_
     Verbose and quite output options caused errors when the 
     develop buildout option was used to create develop eggs.

`67871 <https://launchpad.net/products/zc.buildout/+bug/67871>`_
     Installation failed if the source was a (local) unzipped
     egg.

`67873 <https://launchpad.net/products/zc.buildout/+bug/67873>`_
     There was an error in producing an error message when part names
     passed to the install command weren't included in the
     configuration. 

jim's avatar
jim committed
326 327
1.0.0b10 (2006-10-16)
=====================
jim's avatar
jim committed
328 329 330 331

Feature Changes
---------------

jim's avatar
jim committed
332 333 334 335 336 337
- Renamed the runsetup command to setup. (The old name still works.)

- Added a recipe update method. Now install is only called when a part
  is installed for the first time, or after an uninstall. Otherwise, 
  update is called.  For backward compatibility, recipes that don't
  define update methiods are still supported.
jim's avatar
jim committed
338

339 340 341 342 343
- If a distribution defines namespace packages but fails to declare 
  setuptools as one of its dependencies, we now treat setuptools as an 
  implicit dependency.  We generate a warning if the distribution
  is a develop egg.

jim's avatar
jim committed
344 345
- You can now create develop eggs for setup scripts that don't use setuptools.

346 347 348 349 350 351
Bugs Fixed
----------

- Egg links weren't removed when corresponding entries were removed
  from develop sections.

352 353 354 355 356
- Running a non-local buildout command (one not installed in the
  buildout) ket to a hang if there were new versions of zc.buildout or
  setuptools were available.  Now we issue a warning and don't
  upgrade.

jim's avatar
jim committed
357 358
- When installing zip-safe eggs from local directories, the eggs were
  moved, rather than copied, removing them from the source directory.
359

jim's avatar
jim committed
360 361 362 363 364 365 366 367
1.0.0b9 (2006-10-02)
====================

Bugs Fixed
----------

Non-zip-safe eggs were not unzipped when they were installed.

jim's avatar
jim committed
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
1.0.0b8 (2006-10-01)
====================

Bugs Fixed
----------

- Installing source distributions failed when using alternate Python
  versions (depending on the versions of Python used.)

- Installing eggs wasn't handled as efficiently as possible due to a
  bug in egg URL parsing.

- Fixed a bug in runsetup that caused setup scripts that introspected
  __file__ to fail.

jim's avatar
jim committed
383 384 385 386 387 388 389 390 391
1.0.0b7
=======

Added a documented testing framework for use by recipes. Refactored
the buildout tests to use it.

Added a runsetup command run a setup script.  This is handy if, like
me, you don't install setuptools in your system Python.

jim's avatar
jim committed
392 393 394 395 396 397 398 399 400
1.0.0b6
=======

Fixed https://launchpad.net/products/zc.buildout/+bug/60582
Use of extension options caused bootstrapping to fail if the eggs
directory didn't already exist.  We no longer use extensions for
bootstrapping.  There really isn't any reason to anyway.


jim's avatar
jim committed
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
1.0.0b5
=======

Refactored to do more work in buildout and less work in easy_install.
This makes things go a little faster, makes errors a little easier to
handle, and allows extensions (like the sftp extension) to influence
more of the process. This was done to fix a problem in using the sftp
support.

1.0.0b4
=======

- Added an **experimental** extensions mechanism, mainly to support
  adding sftp support to buildouts that need it.

- Fixed buildout self-updating on Windows.

1.0.0b3
=======

- Added a help option (-h, --help)

- Increased the default level of verbosity.

- Buildouts now automatically update themselves to new versions of
  zc.buildout and setuptools.

- Added Windows support.

- Added a recipe API for generating user errors.

- No-longer generate a py_zc.buildout script.

- Fixed some bugs in variable substitutions.  

  The characters "-", "." and " ", weren't allowed in section or
  option names.

  Substitutions with invalid names were ignored, which caused
  missleading failures downstream.

- Improved error handling.  No longer show tracebacks for user errors.

- Now require a recipe option (and therefore a section) for every part.

- Expanded the easy_install module API to:

  - Allow extra paths to be provided

  - Specify explicit entry points

  - Specify entry-point arguments

1.0.0b2
=======

Added support for specifying some build_ext options when installing eggs
from source distributions.

1.0.0b1
=======

- Changed the bootstrapping code to only install setuptools and
  zc.buildout. The bootstrap code no-longer runs the buildout itself.
  This was to fix a bug that caused parts to be recreated
  unnecessarily because the recipe signature in the initial buildout
  reflected temporary locations for setuptools and zc.buildout.

- Now create a minimal setup.py if it doesn't exist and issue a
  warning that it is being created.

- Fixed bug in saving installed configuration data.  %'s and extra
  spaces weren't quoted.

1.0.0a1
=======

Initial public version