Merge pull request #578 from phervieux/15.10
[puppet-modules/puppetlabs-apt.git] / CHANGELOG.md
1 ##Supported Release 2.2.1
2 ###Summary
3
4 Small release for support of newer PE versions. This increments the version of PE in the metadata.json file.
5
6 ##2015-09-29 - Supported Release 2.2.0
7 ###Summary
8
9 This release includes a few bugfixes.
10
11 ####Features
12 - Adds an `ensure` parameter for user control of proxy presence.
13 - Adds ability to set `notify_update` to `apt::conf` (MODULES-2269).
14 - Apt pins no longer trigger an `apt-get update` run.
15 - Adds support for creating pins from main class.
16
17 ####Bugfixes
18 - Updates to use the official Debian mirrors.
19 - Fixes path to `preferences` and `preferences.d`
20 - Fixes pinning for backports (MODULES-2446).
21 - Fixes the name/extension of the preferences files.
22
23 ##2015-07-28 - Supported Release 2.1.1
24 ###Summary
25
26 This release includes a few bugfixes.
27
28 ####Bugfixes
29 - Fix incorrect use of anchoring (MODULES-2190)
30 - Use correct comment type for apt.conf files
31 - Test fixes
32 - Documentation fixes
33
34 ##2015-06-16 - Supported Release 2.1.0
35 ###Summary
36
37 This release largely makes `apt::key` and `apt::source` API-compatible with the 1.8.x versions for ease in upgrading, and also addresses some compatibility issues with older versions of Puppet.
38
39 ####Features
40 - Add API compatibility to `apt::key` and `apt::source`
41 - Added `apt_reboot_required` fact
42
43 ####Bugfixes
44 - Fix compatibility with Puppet versions 3.0-3.4
45 - Work around future parser bug PUP-4133
46
47 ##2015-04-28 - Supported Release 2.0.1
48 ###Summary
49
50 This bug fixes a few compatibility issues that came up with the 2.0.0 release, and includes test and documentation updates.
51
52 ####Bugfixes
53 - Fix incompatibility with keyrings containing multiple keys
54 - Fix bugs preventing the module from working with Puppet < 3.5.0
55
56 ##2015-04-07 - Supported Release 2.0.0
57 ###Summary
58
59 This is a major rewrite of the apt module. Many classes and defines were removed, but all existing functionality should still work. Please carefully review documentation before upgrading.
60
61 ####Backwards-incompatible changes
62
63 As this is a major rewrite of the module there are a great number of backwards incompatible changes. Please review this and the updated README carefully before upgrading.
64
65 #####`apt_key`
66 - `keyserver_options` parameter renamed to `options`
67
68 #####`apt::backports`
69 - This no longer works out of the box on Linux Mint. If using this on mint, you must specify the `location`, `release`, `repos`, and `key` parameters. [Example](examples/backports.pp)
70
71 #####`apt::builddep`
72 - This define was removed. Functionality can be matched passing 'build-dep' to `install_options` in the package resource. [Example](examples/builddep.pp)
73
74 #####`apt::debian::testing`
75 - This class was removed. Manually add an `apt::source` instead. [Example](examples/debian_testing.pp)
76
77 #####`apt::debian::unstable`
78 - This class was removed. Manually add an `apt::source` instead. [Example](examples/debian_unstable.pp)
79
80 #####`apt::force`
81 - This define was removed. Functionallity can be matched by setting `install_options` in the package resource. See [here](examples/force.pp) for how to set the options.
82
83 #####`apt::hold`
84 - This define was removed. Simply use an `apt::pin` with `priority => 1001` for the same functionality.
85
86 #####`apt`
87 - `always_apt_update` - This parameter was removed. Use `update => { 'frequency' => 'always' }` instead.
88 - `apt_update_frequency` - This parameter was removed. Use `update => { 'frequency' => <frequency> }` instead.
89 - `disable_keys` - This parameter was removed. See this [example](examples/disable_keys.pp) if you need this functionality.
90 - `proxy_host` - This parameter was removed. Use `proxy => { 'host' => <host> }` instead.
91 - `proxy_port` - This parameter was removed. Use `proxy => { 'port' => <port> }` instead.
92 - `purge_sources_list` - This parameter was removed. Use `purge => { 'sources.list' => <bool> }` instead.
93 - `purge_sources_list_d` - This parameter was removed. Use `purge => { 'sources.list.d' => <bool> }` instead.
94 - `purge_preferences` - This parameter was removed. Use `purge => { 'preferences' => <bool> }` instead.
95 - `purge_preferences_d` - This parameter was removed. Use `purge => { 'preferences.d' => <bool> }` instead.
96 - `update_timeout` - This parameter was removed. Use `update => { 'timeout' => <timeout> }` instead.
97 - `update_tries` - This parameter was removed. Use `update => { 'tries' => <tries> }` instead.
98
99 #####`apt::key`
100 - `key` - This parameter was renamed to `id`.
101 - `key_content` - This parameter was renamed to `content`.
102 - `key_source` - This parameter was renamed to `source`.
103 - `key_server` - This parameter was renamed to `server`.
104 - `key_options` - This parameter was renamed to `options`.
105
106 #####`apt::release`
107 - This class was removed. See this [example](examples/release.pp) for how to achieve this functionality.
108
109 #####`apt::source`
110 - `include_src` - This parameter was removed. Use `include => { 'src' => <bool> }` instead. ***NOTE*** This now defaults to false.
111 - `include_deb` - This parameter was removed. Use `include => { 'deb' => <bool> }` instead.
112 - `required_packages` - This parameter was removed. Use package resources for these packages if needed.
113 - `key` - This can either be a key id or a hash including key options. If using a hash, `key => { 'id' => <id> }` must be specified.
114 - `key_server` - This parameter was removed. Use `key => { 'server' => <server> }` instead.
115 - `key_content` - This parameter was removed. Use `key => { 'content' => <content> }` instead.
116 - `key_source` - This parameter was removed. Use `key => { 'source' => <source> }` instead.
117 - `trusted_source` - This parameter was renamed to `allow_unsigned`.
118
119 #####`apt::unattended_upgrades`
120 - This class was removed and is being republished under the puppet-community namespace. The git repository is available [here](https://github.com/puppet-community/puppet-unattended_upgrades) and it will be published to the forge [here](https://forge.puppetlabs.com/puppet/unattended_upgrades).
121
122 ####Changes to default behavior
123 - By default purge unmanaged files in 'sources.list', 'sources.list.d', 'preferences', and 'preferences.d'.
124 - Changed default for `package_manage` in `apt::ppa` to `false`. Set to `true` in a single PPA if you need the package to be managed.
125 - `apt::source` will no longer include the `src` entries by default. 
126 - `pin` in `apt::source` now defaults to `undef` instead of `false`
127
128 ####Features
129 - Added the ability to pass hashes of `apt::key`s, `apt::ppa`s, and `apt::setting`s to `apt`.
130 - Added 'https' key to `proxy` hash to allow disabling `https_proxy` for the `apt::ppa` environment.
131 - Added `apt::setting` define to abstract away configuration.
132 - Added the ability to pass hashes to `pin` and `key` in `apt::backports` and `apt::source`.
133
134 ####Bugfixes
135 - Fixes for strict variables.
136
137 ##2015-03-17 - Supported Release 1.8.0
138 ###Summary
139
140 This is the last planned feature release of the 1.x series of this module. All new features will be evaluated for puppetlabs-apt 2.x.
141
142 This release includes many important features, including support for full fingerprints, and fixes issues where `apt_key` was not supporting user/password and `apt_has_updates` was not properly parsing the `apt-check` output.
143
144 ####Changes to default behavior
145 - The apt module will now throw warnings if you don't use full fingerprints for `apt_key`s
146
147 ####Features
148 - Use gpg to check keys to work around https://bugs.launchpad.net/ubuntu/+source/gnupg2/+bug/1409117 (MODULES-1675)
149 - Add 'oldstable' to the default update origins for wheezy
150 - Add utopic, vivid, and cumulus compatibility
151 - Add support for full fingerprints
152 - New parameter for `apt::source`
153   - `trusted_source`
154 - New parameters for `apt::ppa`
155   - `package_name`
156   - `package_manage`
157 - New parameter for `apt::unattended_upgrades`
158   - `legacy_origin`
159 - Separate `apt::pin` from `apt::backports` to allow pin by release instead of origin
160
161 ####Bugfixes
162 - Cleanup lint and future parser issues
163 - Fix to support username and passwords again for `apt_key` (MODULES-1119)
164 - Fix issue where `apt::force` `$install_check` didn't work with non-English locales (MODULES-1231)
165 - Allow 5 digit ports in `apt_key`
166 - Fix for `ensure => absent` in `apt_key` (MODULES-1661)
167 - Fix `apt_has_updates` not parsing `apt-check` output correctly
168 - Fix inconsistent headers across files (MODULES-1200)
169 - Clean up formatting for 50unattended-upgrades.erb
170
171 ##2014-10-28 - Supported Release 1.7.0
172 ###Summary
173
174 This release includes several new features, documentation and test improvements, and a few bug fixes.
175
176 ####Features
177 - Updated unit and acceptance tests
178 - Update module to work with Linux Mint
179 - Documentation updates
180 - Future parser / strict variables support
181 - Improved support for long GPG keys
182 - New parameters!
183   - Added `apt_update_frequency` to apt
184   - Added `cfg_files` and `cfg_missing` parameters to apt::force
185   - Added `randomsleep` to apt::unattended_upgrades
186 - Added `apt_update_last_success` fact
187 - Refactored facts for performance improvements
188
189 ####Bugfixes
190 - Update apt::builddep to require Exec['apt_update'] instead of notifying it
191 - Clean up lint errors
192
193 ##2014-08-20 - Supported Release 1.6.0
194 ###Summary
195
196 ####Features
197 - Allow URL or domain name for key_server parameter
198 - Allow custom comment for sources list
199 - Enable auto-update for Debian squeeze LTS
200 - Add facts showing available updates
201 - Test refactoring
202
203 ####Bugfixes
204 - Allow dashes in URL or domain for key_server parameter
205
206 ##2014-08-13 - Supported Release 1.5.3
207 ###Summary
208
209 This is a bugfix releases.  It addresses a bad regex, failures with unicode
210 characters, and issues with the $proxy_host handling in apt::ppa.
211
212 ####Features
213 - Synced files from Modulesync
214
215 ####Bugfixes
216 - Fix regex to follow APT requirements in apt::pin
217 - Fix for unicode characters
218 - Fix inconsistent $proxy_host handling in apt and apt::ppa
219 - Fix typo in README
220 - Fix broken acceptance tests
221
222 ##2014-07-15 - Supported Release 1.5.2
223 ###Summary
224
225 This release merely updates metadata.json so the module can be uninstalled and
226 upgraded via the puppet module command.
227
228 ##2014-07-10 - Supported Release 1.5.1
229 ###Summary
230
231 This release has added tests to ensure graceful failure on OSX.
232
233 ##2014-06-04 - Release 1.5.0
234 ###Summary
235
236 This release adds support for Ubuntu 14.04.  It also includes many new features 
237 and important bugfixes.  One huge change is that apt::key was replaced with
238 apt_key, which allows you to use puppet resource apt_key to inventory keys on
239 your system.
240
241 Special thanks to daenney, our intrepid unofficial apt maintainer!
242
243 ####Features
244 - Add support for Ubuntu Trusty!
245 - Add apt::hold define
246 - Generate valid *.pref files in apt::pin
247 - Made pin_priority configurable for apt::backports
248 - Add apt_key type and provider
249 - Rename "${apt_conf_d}/proxy" to "${apt_conf_d}/01proxy"
250 - apt::key rewritten to use apt_key type
251 - Add support for update_tries to apt::update
252
253 ####Bugfixes
254 - Typo fixes
255 - Fix unattended upgrades
256 - Removed bogus line when using purge_preferences
257 - Fix apt::force to upgrade allow packages to be upgraded to the pacakge from the specified release
258
259 ##2014-03-04 - Supported Release 1.4.2
260 ###Summary
261
262 This is a supported release. This release tidies up 1.4.1 and re-enables
263 support for Ubuntu 10.04
264
265 ####Features
266
267 ####Bugfixes
268 - Fix apt:ppa to include the -y Ubuntu 10.04 requires.
269 - Documentation changes.
270 - Test fixups.
271
272 ####Known Bugs
273
274 * No known issues.
275
276
277
278 ##2014-02-13 1.4.1
279 ###Summary
280 This is a bugfix release.
281
282 ####Bugfixes
283 - Fix apt::force unable to upgrade packages from releases other than its original
284 - Removed a few refeneces to aptitude instead of apt-get for portability
285 - Removed call to getparam() due to stdlib dependency
286 - Correct apt::source template when architecture is provided
287 - Retry package installs if apt is locked
288 - Use root to exec in apt::ppa
289 - Updated tests and converted acceptance tests to beaker
290
291 ##2013-10-08 - Release 1.4.0
292
293 ###Summary
294
295 Minor bugfix and allow the timeout to be adjusted.
296
297 ####Features
298 - Add an `updates_timeout` to apt::params
299
300 ####Bugfixes
301 - Ensure apt::ppa can read a ppa removed by hand.
302
303
304 ##2013-10-08 - Release 1.3.0
305 ###Summary
306
307 This major feature in this release is the new apt::unattended_upgrades class,
308 allowing you to handle Ubuntu's unattended feature.  This allows you to select
309 specific packages to automatically upgrade without any further user
310 involvement.
311
312 In addition we extend our Wheezy support, add proxy support to apt:ppa and do
313 various cleanups and tweaks.
314
315 ####Features
316 - Add apt::unattended_upgrades support for Ubuntu.
317 - Add wheezy backports support.
318 - Use the geoDNS http.debian.net instead of the main debian ftp server.
319 - Add `options` parameter to apt::ppa in order to pass options to apt-add-repository command.
320 - Add proxy support for apt::ppa (uses proxy_host and proxy_port from apt).
321
322 ####Bugfixes
323 - Fix regsubst() calls to quote single letters (for future parser).
324 - Fix lint warnings and other misc cleanup.
325
326
327 ##2013-07-03 - Release 1.2.0
328
329 ####Features
330 - Add geppetto `.project` natures
331 - Add GH auto-release
332 - Add `apt::key::key_options` parameter
333 - Add complex pin support using distribution properties for `apt::pin` via new properties:
334   - `apt::pin::codename`
335   - `apt::pin::release_version`
336   - `apt::pin::component`
337   - `apt::pin::originator`
338   - `apt::pin::label`
339 - Add source architecture support to `apt::source::architecture`
340
341 ####Bugfixes
342 - Use apt-get instead of aptitude in apt::force
343 - Update default backports location
344 - Add dependency for required packages before apt-get update
345
346
347 ##2013-06-02 - Release 1.1.1
348 ###Summary
349
350 This is a bug fix release that resolves a number of issues:
351
352 * By changing template variable usage, we remove the deprecation warnings
353   for Puppet 3.2.x
354 * Fixed proxy file removal, when proxy absent
355
356 Some documentation, style and whitespaces changes were also merged. This
357 release also introduced proper rspec-puppet unit testing on Travis-CI to help
358 reduce regression.
359
360 Thanks to all the community contributors below that made this patch possible.
361
362 #### Detail Changes
363
364 * fix minor comment type (Chris Rutter)
365 * whitespace fixes (Michael Moll)
366 * Update travis config file (William Van Hevelingen)
367 * Build all branches on travis (William Van Hevelingen)
368 * Standardize travis.yml on pattern introduced in stdlib (William Van Hevelingen)
369 * Updated content to conform to README best practices template (Lauren Rother)
370 * Fix apt::release example in readme (Brian Galey)
371 * add @ to variables in template (Peter Hoeg)
372 * Remove deprecation warnings for pin.pref.erb as well (Ken Barber)
373 * Update travis.yml to latest versions of puppet (Ken Barber)
374 * Fix proxy file removal (Scott Barber)
375 * Add spec test for removing proxy configuration (Dean Reilly)
376 * Fix apt::key listing longer than 8 chars (Benjamin Knofe)
377
378
379
380
381 ## Release 1.1.0
382 ###Summary
383
384 This release includes Ubuntu 12.10 (Quantal) support for PPAs.
385
386 ---
387
388 ##2012-05-25 - Puppet Labs <info@puppetlabs.com> - Release 0.0.4
389 ###Summary
390
391  * Fix ppa list filename when there is a period in the PPA name
392  * Add .pref extension to apt preferences files
393  * Allow preferences to be purged
394  * Extend pin support
395
396
397 ##2012-05-04 - Puppet Labs <info@puppetlabs.com> - Release 0.0.3
398 ###Summary
399  
400  * only invoke apt-get update once
401  * only install python-software-properties if a ppa is added
402  * support 'ensure => absent' for all defined types
403  * add apt::conf
404  * add apt::backports
405  * fixed Modulefile for module tool dependency resolution
406  * configure proxy before doing apt-get update
407  * use apt-get update instead of aptitude for apt::ppa
408  * add support to pin release
409
410
411 ##2012-03-26 - Puppet Labs <info@puppetlabs.com> - Release 0.0.2
412 ###Summary
413
414 * 41cedbb (#13261) Add real examples to smoke tests.
415 * d159a78 (#13261) Add key.pp smoke test
416 * 7116c7a (#13261) Replace foo source with puppetlabs source
417 * 1ead0bf Ignore pkg directory.
418 * 9c13872 (#13289) Fix some more style violations
419 * 0ea4ffa (#13289) Change test scaffolding to use a module & manifest dir fixture path
420 * a758247 (#13289) Clean up style violations and fix corresponding tests
421 * 99c3fd3 (#13289) Add puppet lint tests to Rakefile
422 * 5148cbf (#13125) Apt keys should be case insensitive
423 * b9607a4 Convert apt::key to use anchors
424
425
426 ##2012-03-07 - Puppet Labs <info@puppetlabs.com> - Release 0.0.1
427 ###Summary
428
429 * d4fec56 Modify apt::source release parameter test
430 * 1132a07 (#12917) Add contributors to README
431 * 8cdaf85 (#12823) Add apt::key defined type and modify apt::source to use it
432 * 7c0d10b (#12809) $release should use $lsbdistcodename and fall back to manual input
433 * be2cc3e (#12522) Adjust spec test for splitting purge
434 * 7dc60ae (#12522) Split purge option to spare sources.list
435 * 9059c4e Fix source specs to test all key permutations
436 * 8acb202 Add test for python-software-properties package
437 * a4af11f Check if python-software-properties is defined before attempting to define it.
438 * 1dcbf3d Add tests for required_packages change
439 * f3735d2 Allow duplicate $required_packages
440 * 74c8371 (#12430) Add tests for changes to apt module
441 * 97ebb2d Test two sources with the same key
442 * 1160bcd (#12526) Add ability to reverse apt { disable_keys => true }
443 * 2842d73 Add Modulefile to puppet-apt
444 * c657742 Allow the use of the same key in multiple sources
445 * 8c27963 (#12522) Adding purge option to apt class
446 * 997c9fd (#12529) Add unit test for apt proxy settings
447 * 50f3cca (#12529) Add parameter to support setting a proxy for apt
448 * d522877 (#12094) Replace chained .with_* with a hash
449 * 8cf1bd0 (#12094) Remove deprecated spec.opts file
450 * 2d688f4 (#12094) Add rspec-puppet tests for apt
451 * 0fb5f78 (#12094) Replace name with path in file resources
452 * f759bc0 (#11953) Apt::force passes $version to aptitude
453 * f71db53 (#11413) Add spec test for apt::force to verify changes to unless
454 * 2f5d317 (#11413) Update dpkg query used by apt::force
455 * cf6caa1 (#10451) Add test coverage to apt::ppa
456 * 0dd697d include_src parameter in example; Whitespace cleanup
457 * b662eb8 fix typos in "repositories"
458 * 1be7457 Fix (#10451) - apt::ppa fails to "apt-get update" when new PPA source is added
459 * 864302a Set the pin priority before adding the source (Fix #10449)
460 * 1de4e0a Refactored as per mlitteken
461 * 1af9a13 Added some crazy bash madness to check if the ppa is installed already. Otherwise the manifest tries to add it on every run!
462 * 52ca73e (#8720) Replace Apt::Ppa with Apt::Builddep
463 * 5c05fa0 added builddep command.
464 * a11af50 added the ability to specify the content of a key
465 * c42db0f Fixes ppa test.
466 * 77d2b0d reformatted whitespace to match recommended style of 2 space indentation.
467 * 27ebdfc ignore swap files.
468 * 377d58a added smoke tests for module.
469 * 18f614b reformatted apt::ppa according to recommended style.
470 * d8a1e4e Created a params class to hold global data.
471 * 636ae85 Added two params for apt class
472 * 148fc73 Update LICENSE.
473 * ed2d19e Support ability to add more than one PPA
474 * 420d537 Add call to apt-update after add-apt-repository in apt::ppa
475 * 945be77 Add package definition for python-software-properties
476 * 71fc425 Abs paths for all commands
477 * 9d51cd1 Adding LICENSE
478 * 71796e3 Heading fix in README
479 * 87777d8 Typo in README
480 * f848bac First commit