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