3 All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
4 and this project adheres to [Semantic Versioning](http://semver.org).
6 ## Supported Release [4.3.0]
9 This release is adding Tasks to the apt module.
12 - Add a task that allows apt-get update and upgrade
14 ## Supported Release [4.2.0]
17 This release is primarily to fix an error around GPG keys in Debian 9, but includes some other small features and fixes as well.
20 - `apt_package_security_updates` fact
21 - The ability to modify the loglevel of `Exec['apt_update'}`
25 - Ubuntu 16.04 now uses `software-priorities-common`
28 - Debian 6, Ubuntu 10.04 and 12.04 support. Existing compatibility remains intact but bugs will not be prioritized for these OSes.
31 - **[(MODULES-4686)](https://tickets.puppetlabs.com/browse/MODULES-4686) an error that was causing GPG keyserver imports to fail on Debian 9**
33 ## Supported Release 4.1.0
36 This release removes Data in Modules due to current compatibility issues and reinstates the params.pp file. Also includes a couple of bug fixes.
39 - (MODULES-4973) Data in Modules which was introduced in the last release has now been reverted due to compatibility issues.
42 - Now apt_key only sends the auth basic header when userinfo can be parsed from the URL.
43 - Reverted the removal of Evolving Web's attribution in NOTICE file.
44 - Test added to ensure empty string allowed for $release in apt::source.
47 ## Supported Release 3.0.0 and 4.0.0
50 This release adds new Puppet 4 features: data in modules, EPP templates, the $facts hash, and data types. This release is fully backwards compatible to existing Puppet 4 configurations and provides you with deprecation warnings for every argument that will not work as expected with the final 4.0.0 release. See the stdlib docs here for an in-depth discussion of this: https://github.com/puppetlabs/puppetlabs-stdlib#validate_legacy
52 If you want to learn more about the new features used or you wish to upgrade a module yourself, have a look at the NTP: A Puppet 4 language update blog post.
54 If you're still running Puppet 3, remain on the latest puppetlabs-apt 2.x release for now, and see the documentation to upgrade to Puppet 4.
58 Data in modules: Moves all distribution and OS-dependent defaults into YAML files in data/, alleviating the need for a params class. Note that while this feature is currently still classed as experimental, the final implementation will support the changes here.
59 EPP templating: Uses the Puppet language as a base for templates to create simpler and safer templates. No need for Ruby anymore!
60 The $facts hash: Makes facts visibly distinct from other variables for more readable and maintainable code. This helps eliminate confusion if you use a local variable whose name happens to match that of a common fact.
61 Data types for validation: Helps you find and replace deprecated code in existing validate functions with stricter, more readable data type notation. First upgrade to the 3.0.0 release of this module, and address all deprecation warnings before upgrading to the final 4.0.0 release. Please see the stdlib docs for an in-depth discussion of this process.
64 - Fix apt::source epp template regression introduced in 3.0.0 for the architecture parameter
66 ## Supported Release 2.4.0
68 A release that includes only a couple of additional features, but includes several cleanups and bugfixes around existing issues.
71 - Tests updated to check for idempotency.
72 - (MODULES-4224) Implementation of beaker-module_install_helper.
73 - Deprecation warnings are now handled by the deprecation function in stdlib.
76 - Now http and https sources fixed for apt_key and can take a userinfo.
78 - Notify_update param now defaults to true to avoid validation errors.
79 - Implement retry on tests which pull key from a key server which sometimes times out (transient error).
80 - String comparison error now comphensated for in update.pp.
81 - (MODULES-4104) Removal of the port number from repository location in order to get the host name of the repository.
82 - Puppet lint warnings addressed.
83 - A few small readme issues addressed.
85 ## Supported Release 2.3.0
87 A release containing many bugfixes with additional features.
90 - Apt_updates facts now use /usr/bin/apt-get.
91 - Addition of notify update to apt::source.
92 - Update to newest modulesync_configs.
93 - Installs software-properties-common for Xenial.
95 - Add ability to specify a hash of apt::conf defines.
98 - A clean up of spec/defines/key_compat_specs, also now runs under STRICT_VARIABLES.
99 - Apt::setting expects priority to be an integer, set defaults accordingly.
100 - Fixed version check for Ubuntu on 16.04.
101 - Now uses hkps.pool.sks-keyservers.net instead of pgp.mit.edu.
102 - Updates and fixes to tests. General cleanup.
103 - Fixed regexp for $ensure params.
104 - Apt/params: Remove unused LSB facts.
105 - Replaced `-s` with `-f` in ppa rspec tests - After the repository is added, the "${::apt::sources_list_d}/${sources_list_d_filename}" file is created as an empty file. The unless condition of Exec["add-apt-repository-${name}"] calls test -s, which returns 1 if the file is empty. Because the file is empty, the unless condition is never true and the repository is added on every execution. This change replaces the -s test condition with -f, which is true if the file exists or false otherwise.
106 - Limit non-strict parsing to pre-3.5.0 only - Puppet 3.5.0 introduced strict variables and the module handles strict variables by using the defined() function. This does not work on prior versions of puppet so we now gate based on that version. Puppet 4 series has a new setting `strict` that may be set to enforce strict variables while `strict_variables` remains unset (see PUP-6358) which causes the conditional in manifests/params.pp to erroniously use non-strict 3.5-era parsing and fail. This new conditional corrects the cases such that strict variable behavior happens on versions 3.5.0 and later.
108 ## Supported Release 2.2.2
111 Several bug fixes and the addition of support updates to Debian 8 and Ubuntu Wily.
114 - Small fixes to descriptions within the readme and the addition of some examples.
115 - Updates to run on Ubuntu Wily.
116 - Fixed apt_key tempfile race condition.
117 - Run stages limitation added to the documentation.
118 - Remove unneeded whitespace in source.list template.
119 - Handle PPA names that contain a plus character.
120 - Update to current msync configs.
121 - Avoid duplicate package resources when package_manage => true.
122 - Avoid multiple package resource declarations.
123 - Ensure PPAs in tests have valid form.
124 - Look for correct sources.list.d file for apt::ppa.
125 - Debian 8 support addiiton to metadata.
127 ## Supported Release 2.2.1
130 Small release for support of newer PE versions. This increments the version of PE in the metadata.json file.
132 ## 2015-09-29 - Supported Release 2.2.0
135 This release includes a few bugfixes.
138 - Adds an `ensure` parameter for user control of proxy presence.
139 - Adds ability to set `notify_update` to `apt::conf` (MODULES-2269).
140 - Apt pins no longer trigger an `apt-get update` run.
141 - Adds support for creating pins from main class.
144 - Updates to use the official Debian mirrors.
145 - Fixes path to `preferences` and `preferences.d`
146 - Fixes pinning for backports (MODULES-2446).
147 - Fixes the name/extension of the preferences files.
149 ## 2015-07-28 - Supported Release 2.1.1
152 This release includes a few bugfixes.
155 - Fix incorrect use of anchoring (MODULES-2190)
156 - Use correct comment type for apt.conf files
158 - Documentation fixes
160 ## 2015-06-16 - Supported Release 2.1.0
163 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.
166 - Add API compatibility to `apt::key` and `apt::source`
167 - Added `apt_reboot_required` fact
170 - Fix compatibility with Puppet versions 3.0-3.4
171 - Work around future parser bug PUP-4133
173 ## 2015-04-28 - Supported Release 2.0.1
176 This bug fixes a few compatibility issues that came up with the 2.0.0 release, and includes test and documentation updates.
179 - Fix incompatibility with keyrings containing multiple keys
180 - Fix bugs preventing the module from working with Puppet < 3.5.0
182 ## 2015-04-07 - Supported Release 2.0.0
185 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.
187 #### Backwards-incompatible changes
189 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.
192 - `keyserver_options` parameter renamed to `options`
194 ##### `apt::backports`
195 - 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)
197 ##### `apt::builddep`
198 - This define was removed. Functionality can be matched passing 'build-dep' to `install_options` in the package resource. [Example](examples/builddep.pp)
200 ##### `apt::debian::testing`
201 - This class was removed. Manually add an `apt::source` instead. [Example](examples/debian_testing.pp)
203 ##### `apt::debian::unstable`
204 - This class was removed. Manually add an `apt::source` instead. [Example](examples/debian_unstable.pp)
207 - 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.
210 - This define was removed. Simply use an `apt::pin` with `priority => 1001` for the same functionality.
213 - `always_apt_update` - This parameter was removed. Use `update => { 'frequency' => 'always' }` instead.
214 - `apt_update_frequency` - This parameter was removed. Use `update => { 'frequency' => <frequency> }` instead.
215 - `disable_keys` - This parameter was removed. See this [example](examples/disable_keys.pp) if you need this functionality.
216 - `proxy_host` - This parameter was removed. Use `proxy => { 'host' => <host> }` instead.
217 - `proxy_port` - This parameter was removed. Use `proxy => { 'port' => <port> }` instead.
218 - `purge_sources_list` - This parameter was removed. Use `purge => { 'sources.list' => <bool> }` instead.
219 - `purge_sources_list_d` - This parameter was removed. Use `purge => { 'sources.list.d' => <bool> }` instead.
220 - `purge_preferences` - This parameter was removed. Use `purge => { 'preferences' => <bool> }` instead.
221 - `purge_preferences_d` - This parameter was removed. Use `purge => { 'preferences.d' => <bool> }` instead.
222 - `update_timeout` - This parameter was removed. Use `update => { 'timeout' => <timeout> }` instead.
223 - `update_tries` - This parameter was removed. Use `update => { 'tries' => <tries> }` instead.
226 - `key` - This parameter was renamed to `id`.
227 - `key_content` - This parameter was renamed to `content`.
228 - `key_source` - This parameter was renamed to `source`.
229 - `key_server` - This parameter was renamed to `server`.
230 - `key_options` - This parameter was renamed to `options`.
233 - This class was removed. See this [example](examples/release.pp) for how to achieve this functionality.
236 - `include_src` - This parameter was removed. Use `include => { 'src' => <bool> }` instead. ***NOTE*** This now defaults to false.
237 - `include_deb` - This parameter was removed. Use `include => { 'deb' => <bool> }` instead.
238 - `required_packages` - This parameter was removed. Use package resources for these packages if needed.
239 - `key` - This can either be a key id or a hash including key options. If using a hash, `key => { 'id' => <id> }` must be specified.
240 - `key_server` - This parameter was removed. Use `key => { 'server' => <server> }` instead.
241 - `key_content` - This parameter was removed. Use `key => { 'content' => <content> }` instead.
242 - `key_source` - This parameter was removed. Use `key => { 'source' => <source> }` instead.
243 - `trusted_source` - This parameter was renamed to `allow_unsigned`.
245 ##### `apt::unattended_upgrades`
246 - 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).
248 #### Changes to default behavior
249 - By default purge unmanaged files in 'sources.list', 'sources.list.d', 'preferences', and 'preferences.d'.
250 - 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.
251 - `apt::source` will no longer include the `src` entries by default.
252 - `pin` in `apt::source` now defaults to `undef` instead of `false`
255 - Added the ability to pass hashes of `apt::key`s, `apt::ppa`s, and `apt::setting`s to `apt`.
256 - Added 'https' key to `proxy` hash to allow disabling `https_proxy` for the `apt::ppa` environment.
257 - Added `apt::setting` define to abstract away configuration.
258 - Added the ability to pass hashes to `pin` and `key` in `apt::backports` and `apt::source`.
261 - Fixes for strict variables.
263 ## 2015-03-17 - Supported Release 1.8.0
266 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.
268 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.
270 #### Changes to default behavior
271 - The apt module will now throw warnings if you don't use full fingerprints for `apt_key`s
274 - Use gpg to check keys to work around https://bugs.launchpad.net/ubuntu/+source/gnupg2/+bug/1409117 (MODULES-1675)
275 - Add 'oldstable' to the default update origins for wheezy
276 - Add utopic, vivid, and cumulus compatibility
277 - Add support for full fingerprints
278 - New parameter for `apt::source`
280 - New parameters for `apt::ppa`
283 - New parameter for `apt::unattended_upgrades`
285 - Separate `apt::pin` from `apt::backports` to allow pin by release instead of origin
288 - Cleanup lint and future parser issues
289 - Fix to support username and passwords again for `apt_key` (MODULES-1119)
290 - Fix issue where `apt::force` `$install_check` didn't work with non-English locales (MODULES-1231)
291 - Allow 5 digit ports in `apt_key`
292 - Fix for `ensure => absent` in `apt_key` (MODULES-1661)
293 - Fix `apt_has_updates` not parsing `apt-check` output correctly
294 - Fix inconsistent headers across files (MODULES-1200)
295 - Clean up formatting for 50unattended-upgrades.erb
297 ## 2014-10-28 - Supported Release 1.7.0
300 This release includes several new features, documentation and test improvements, and a few bug fixes.
303 - Updated unit and acceptance tests
304 - Update module to work with Linux Mint
305 - Documentation updates
306 - Future parser / strict variables support
307 - Improved support for long GPG keys
309 - Added `apt_update_frequency` to apt
310 - Added `cfg_files` and `cfg_missing` parameters to apt::force
311 - Added `randomsleep` to apt::unattended_upgrades
312 - Added `apt_update_last_success` fact
313 - Refactored facts for performance improvements
316 - Update apt::builddep to require Exec['apt_update'] instead of notifying it
317 - Clean up lint errors
319 ## 2014-08-20 - Supported Release 1.6.0
323 - Allow URL or domain name for key_server parameter
324 - Allow custom comment for sources list
325 - Enable auto-update for Debian squeeze LTS
326 - Add facts showing available updates
330 - Allow dashes in URL or domain for key_server parameter
332 ## 2014-08-13 - Supported Release 1.5.3
335 This is a bugfix releases. It addresses a bad regex, failures with unicode
336 characters, and issues with the $proxy_host handling in apt::ppa.
339 - Synced files from Modulesync
342 - Fix regex to follow APT requirements in apt::pin
343 - Fix for unicode characters
344 - Fix inconsistent $proxy_host handling in apt and apt::ppa
346 - Fix broken acceptance tests
348 ## 2014-07-15 - Supported Release 1.5.2
351 This release merely updates metadata.json so the module can be uninstalled and
352 upgraded via the puppet module command.
354 ## 2014-07-10 - Supported Release 1.5.1
357 This release has added tests to ensure graceful failure on OSX.
359 ## 2014-06-04 - Release 1.5.0
362 This release adds support for Ubuntu 14.04. It also includes many new features
363 and important bugfixes. One huge change is that apt::key was replaced with
364 apt_key, which allows you to use puppet resource apt_key to inventory keys on
367 Special thanks to daenney, our intrepid unofficial apt maintainer!
370 - Add support for Ubuntu Trusty!
371 - Add apt::hold define
372 - Generate valid *.pref files in apt::pin
373 - Made pin_priority configurable for apt::backports
374 - Add apt_key type and provider
375 - Rename "${apt_conf_d}/proxy" to "${apt_conf_d}/01proxy"
376 - apt::key rewritten to use apt_key type
377 - Add support for update_tries to apt::update
381 - Fix unattended upgrades
382 - Removed bogus line when using purge_preferences
383 - Fix apt::force to upgrade allow packages to be upgraded to the pacakge from the specified release
385 ## 2014-03-04 - Supported Release 1.4.2
388 This is a supported release. This release tidies up 1.4.1 and re-enables
389 support for Ubuntu 10.04
394 - Fix apt:ppa to include the -y Ubuntu 10.04 requires.
395 - Documentation changes.
406 This is a bugfix release.
409 - Fix apt::force unable to upgrade packages from releases other than its original
410 - Removed a few refeneces to aptitude instead of apt-get for portability
411 - Removed call to getparam() due to stdlib dependency
412 - Correct apt::source template when architecture is provided
413 - Retry package installs if apt is locked
414 - Use root to exec in apt::ppa
415 - Updated tests and converted acceptance tests to beaker
417 ## 2013-10-08 - Release 1.4.0
421 Minor bugfix and allow the timeout to be adjusted.
424 - Add an `updates_timeout` to apt::params
427 - Ensure apt::ppa can read a ppa removed by hand.
430 ## 2013-10-08 - Release 1.3.0
433 This major feature in this release is the new apt::unattended_upgrades class,
434 allowing you to handle Ubuntu's unattended feature. This allows you to select
435 specific packages to automatically upgrade without any further user
438 In addition we extend our Wheezy support, add proxy support to apt:ppa and do
439 various cleanups and tweaks.
442 - Add apt::unattended_upgrades support for Ubuntu.
443 - Add wheezy backports support.
444 - Use the geoDNS http.debian.net instead of the main debian ftp server.
445 - Add `options` parameter to apt::ppa in order to pass options to apt-add-repository command.
446 - Add proxy support for apt::ppa (uses proxy_host and proxy_port from apt).
449 - Fix regsubst() calls to quote single letters (for future parser).
450 - Fix lint warnings and other misc cleanup.
453 ## 2013-07-03 - Release 1.2.0
456 - Add geppetto `.project` natures
457 - Add GH auto-release
458 - Add `apt::key::key_options` parameter
459 - Add complex pin support using distribution properties for `apt::pin` via new properties:
460 - `apt::pin::codename`
461 - `apt::pin::release_version`
462 - `apt::pin::component`
463 - `apt::pin::originator`
465 - Add source architecture support to `apt::source::architecture`
468 - Use apt-get instead of aptitude in apt::force
469 - Update default backports location
470 - Add dependency for required packages before apt-get update
473 ## 2013-06-02 - Release 1.1.1
476 This is a bug fix release that resolves a number of issues:
478 * By changing template variable usage, we remove the deprecation warnings
480 * Fixed proxy file removal, when proxy absent
482 Some documentation, style and whitespaces changes were also merged. This
483 release also introduced proper rspec-puppet unit testing on Travis-CI to help
486 Thanks to all the community contributors below that made this patch possible.
490 * fix minor comment type (Chris Rutter)
491 * whitespace fixes (Michael Moll)
492 * Update travis config file (William Van Hevelingen)
493 * Build all branches on travis (William Van Hevelingen)
494 * Standardize travis.yml on pattern introduced in stdlib (William Van Hevelingen)
495 * Updated content to conform to README best practices template (Lauren Rother)
496 * Fix apt::release example in readme (Brian Galey)
497 * add @ to variables in template (Peter Hoeg)
498 * Remove deprecation warnings for pin.pref.erb as well (Ken Barber)
499 * Update travis.yml to latest versions of puppet (Ken Barber)
500 * Fix proxy file removal (Scott Barber)
501 * Add spec test for removing proxy configuration (Dean Reilly)
502 * Fix apt::key listing longer than 8 chars (Benjamin Knofe)
510 This release includes Ubuntu 12.10 (Quantal) support for PPAs.
514 ## 2012-05-25 - Puppet Labs <info@puppetlabs.com> - Release 0.0.4
517 * Fix ppa list filename when there is a period in the PPA name
518 * Add .pref extension to apt preferences files
519 * Allow preferences to be purged
523 ## 2012-05-04 - Puppet Labs <info@puppetlabs.com> - Release 0.0.3
526 * only invoke apt-get update once
527 * only install python-software-properties if a ppa is added
528 * support 'ensure => absent' for all defined types
531 * fixed Modulefile for module tool dependency resolution
532 * configure proxy before doing apt-get update
533 * use apt-get update instead of aptitude for apt::ppa
534 * add support to pin release
537 ## 2012-03-26 - Puppet Labs <info@puppetlabs.com> - Release 0.0.2
540 * 41cedbb (#13261) Add real examples to smoke tests.
541 * d159a78 (#13261) Add key.pp smoke test
542 * 7116c7a (#13261) Replace foo source with puppetlabs source
543 * 1ead0bf Ignore pkg directory.
544 * 9c13872 (#13289) Fix some more style violations
545 * 0ea4ffa (#13289) Change test scaffolding to use a module & manifest dir fixture path
546 * a758247 (#13289) Clean up style violations and fix corresponding tests
547 * 99c3fd3 (#13289) Add puppet lint tests to Rakefile
548 * 5148cbf (#13125) Apt keys should be case insensitive
549 * b9607a4 Convert apt::key to use anchors
552 ## 2012-03-07 - Puppet Labs <info@puppetlabs.com> - Release 0.0.1
555 * d4fec56 Modify apt::source release parameter test
556 * 1132a07 (#12917) Add contributors to README
557 * 8cdaf85 (#12823) Add apt::key defined type and modify apt::source to use it
558 * 7c0d10b (#12809) $release should use $lsbdistcodename and fall back to manual input
559 * be2cc3e (#12522) Adjust spec test for splitting purge
560 * 7dc60ae (#12522) Split purge option to spare sources.list
561 * 9059c4e Fix source specs to test all key permutations
562 * 8acb202 Add test for python-software-properties package
563 * a4af11f Check if python-software-properties is defined before attempting to define it.
564 * 1dcbf3d Add tests for required_packages change
565 * f3735d2 Allow duplicate $required_packages
566 * 74c8371 (#12430) Add tests for changes to apt module
567 * 97ebb2d Test two sources with the same key
568 * 1160bcd (#12526) Add ability to reverse apt { disable_keys => true }
569 * 2842d73 Add Modulefile to puppet-apt
570 * c657742 Allow the use of the same key in multiple sources
571 * 8c27963 (#12522) Adding purge option to apt class
572 * 997c9fd (#12529) Add unit test for apt proxy settings
573 * 50f3cca (#12529) Add parameter to support setting a proxy for apt
574 * d522877 (#12094) Replace chained .with_* with a hash
575 * 8cf1bd0 (#12094) Remove deprecated spec.opts file
576 * 2d688f4 (#12094) Add rspec-puppet tests for apt
577 * 0fb5f78 (#12094) Replace name with path in file resources
578 * f759bc0 (#11953) Apt::force passes $version to aptitude
579 * f71db53 (#11413) Add spec test for apt::force to verify changes to unless
580 * 2f5d317 (#11413) Update dpkg query used by apt::force
581 * cf6caa1 (#10451) Add test coverage to apt::ppa
582 * 0dd697d include_src parameter in example; Whitespace cleanup
583 * b662eb8 fix typos in "repositories"
584 * 1be7457 Fix (#10451) - apt::ppa fails to "apt-get update" when new PPA source is added
585 * 864302a Set the pin priority before adding the source (Fix #10449)
586 * 1de4e0a Refactored as per mlitteken
587 * 1af9a13 Added some crazy bash madness to check if the ppa is installed already. Otherwise the manifest tries to add it on every run!
588 * 52ca73e (#8720) Replace Apt::Ppa with Apt::Builddep
589 * 5c05fa0 added builddep command.
590 * a11af50 added the ability to specify the content of a key
591 * c42db0f Fixes ppa test.
592 * 77d2b0d reformatted whitespace to match recommended style of 2 space indentation.
593 * 27ebdfc ignore swap files.
594 * 377d58a added smoke tests for module.
595 * 18f614b reformatted apt::ppa according to recommended style.
596 * d8a1e4e Created a params class to hold global data.
597 * 636ae85 Added two params for apt class
598 * 148fc73 Update LICENSE.
599 * ed2d19e Support ability to add more than one PPA
600 * 420d537 Add call to apt-update after add-apt-repository in apt::ppa
601 * 945be77 Add package definition for python-software-properties
602 * 71fc425 Abs paths for all commands
603 * 9d51cd1 Adding LICENSE
604 * 71796e3 Heading fix in README
605 * 87777d8 Typo in README
606 * f848bac First commit
609 [4.2.0]:https://github.com/puppetlabs/puppetlabs-apt/compare/4.1.0...4.2.0