|
1 |
| -# Change Log |
| 1 | +<!-- markdownlint-disable MD024 --> |
| 2 | +# Changelog |
2 | 3 |
|
3 |
| -Starting with v2.0.0, all notable changes to this project will be documented in this file. |
4 |
| -This project adheres to [Semantic Versioning](http://semver.org/). |
| 4 | +All notable changes to this project will be documented in this file. |
5 | 5 |
|
6 |
| -## v5.0.2 - 2023-09-29 |
7 |
| -* Correct a Digest call making this thread-safe and allowing for concurrent r10k deploys. |
8 |
| - Thanks to @cmd-ntrf for fixing it and to @baurmatt for tracking it down in the first place. |
| 6 | +The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). |
9 | 7 |
|
10 |
| -## v5.0.1 - 2023-07-10 |
11 |
| -* Update README to reflect accurate Ruby requirement and `faraday` gem dependency |
12 |
| -## v5.0.0 - 2023-05-07 |
| 8 | +## [v5.0.3](https://github.com/puppetlabs/forge-ruby/tree/v5.0.3) - 2023-10-13 |
13 | 9 |
|
14 |
| -* Ruby 3.2 support. |
15 |
| -* LRU caching for HTTP response caching. |
16 |
| -* Raise a ModuleNotFound error instead of just nil when a module is not found. |
| 10 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v5.0.1...v5.0.3) |
17 | 11 |
|
18 |
| -## v4.1.0 - 2023-02-21 |
| 12 | +## [v5.0.1](https://github.com/puppetlabs/forge-ruby/tree/v5.0.1) - 2023-07-10 |
19 | 13 |
|
20 |
| -* Add upload method functionality. |
21 |
| -* Allows the user to search by an array of endorsements. |
| 14 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v5.0.0...v5.0.1) |
22 | 15 |
|
23 |
| -## v4.0.0 - 2022-11-30 |
| 16 | +## [v5.0.0](https://github.com/puppetlabs/forge-ruby/tree/v5.0.0) - 2023-06-07 |
24 | 17 |
|
25 |
| -* Breaking: The `puppet_forge` gem now requires at least Ruby 2.6.0 |
26 |
| -* Update `faraday` gem to 2.x series |
| 18 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v4.1.0...v5.0.0) |
27 | 19 |
|
28 |
| -## v3.2.0 - 2021-11-09 |
| 20 | +## [v4.1.0](https://github.com/puppetlabs/forge-ruby/tree/v4.1.0) - 2023-02-21 |
29 | 21 |
|
30 |
| -* Allow requests to follow redirects |
31 |
| -* Remove the `gettext-setup` gem dependency, which was unused |
| 22 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v4.0.0...v4.1.0) |
32 | 23 |
|
33 |
| -## v3.1.0 - 2021-08-20 |
34 |
| - |
35 |
| -### Changed |
| 24 | +### Added |
36 | 25 |
|
37 |
| -* Update `PuppetForge::Connection.authorization` so that it prepends the |
38 |
| - required `Bearer ` string automatically to values that look like Forge API |
39 |
| - keys. This won't affect values that already include `Bearer `. |
| 26 | +- (CONT-643) Add upload method functionality [#102](https://github.com/puppetlabs/forge-ruby/pull/102) ([chelnak](https://github.com/chelnak)) |
40 | 27 |
|
41 |
| -## v3.0.0 - 2021-01-28 |
| 28 | +## [v4.0.0](https://github.com/puppetlabs/forge-ruby/tree/v4.0.0) - 2022-12-01 |
42 | 29 |
|
43 |
| -* Breaking: The `puppet_forge` gem now requires at least Ruby 2.4.0. |
44 |
| -* Update `faraday` and `faraday_middleware` gem dependencies to 1.x series. |
45 |
| -* Update optional `typhoeus` dependency to `>= 1.4` to maintain compatibility with `faraday`. |
| 30 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v3.2.0...v4.0.0) |
46 | 31 |
|
47 |
| -## v2.3.4 - 2020-03-31 |
| 32 | +## [v3.2.0](https://github.com/puppetlabs/forge-ruby/tree/v3.2.0) - 2021-11-09 |
48 | 33 |
|
49 |
| -* Update the forge API url to `forgeapi.puppet.com` (instead of using the older puppetlabs.com domain). |
50 |
| -* Allow versions of the `faraday_middleware` dependency up to 0.15. |
| 34 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v3.1.0...v3.2.0) |
51 | 35 |
|
52 |
| -## v2.3.3 - 2020-02-20 |
| 36 | +## [v3.1.0](https://github.com/puppetlabs/forge-ruby/tree/v3.1.0) - 2021-08-20 |
53 | 37 |
|
54 |
| -### Changed |
| 38 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v3.0.0...v3.1.0) |
55 | 39 |
|
56 |
| -* Allow versions of faraday up to 0.18 |
| 40 | +## [v3.0.0](https://github.com/puppetlabs/forge-ruby/tree/v3.0.0) - 2021-01-28 |
57 | 41 |
|
58 |
| -## v2.3.2 - 2020-02-05 |
| 42 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v2.3.4...v3.0.0) |
59 | 43 |
|
60 |
| -### Fixed |
| 44 | +## [v2.3.4](https://github.com/puppetlabs/forge-ruby/tree/v2.3.4) - 2020-03-31 |
61 | 45 |
|
62 |
| -* Catch and handle the new `Faraday::TimeoutError`s which are occasionally |
63 |
| - surfaced by the the typheous adapter with more recent verions of libcurl, and |
64 |
| - log them the same way that `Faraday::ConnectionFailed` errors are already |
65 |
| - logged. |
| 46 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v2.3.3...v2.3.4) |
66 | 47 |
|
67 |
| -### Changed |
| 48 | +## [v2.3.3](https://github.com/puppetlabs/forge-ruby/tree/v2.3.3) - 2020-02-20 |
68 | 49 |
|
69 |
| -* Allow for using `faraday_middleware` versions in the 0.13.x series. |
| 50 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v2.3.2...v2.3.3) |
70 | 51 |
|
71 |
| -## v2.3.1 - 2019-11-15 |
| 52 | +## [v2.3.2](https://github.com/puppetlabs/forge-ruby/tree/v2.3.2) - 2020-02-05 |
72 | 53 |
|
73 |
| -### Fixed |
| 54 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v2.3.1...v2.3.2) |
74 | 55 |
|
75 |
| -* Fixed an issue where proxy configurations were being ignored by expanding the range of acceptable versions of the `faraday` gem dependency and specifically excluding the version that was ignoring proxy configuration options. |
| 56 | +## [v2.3.1](https://github.com/puppetlabs/forge-ruby/tree/v2.3.1) - 2019-11-15 |
76 | 57 |
|
77 |
| -## v2.3.0 - 2019-07-09 |
| 58 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v2.3.0...v2.3.1) |
78 | 59 |
|
79 |
| -### Changed |
| 60 | +## [v2.3.0](https://github.com/puppetlabs/forge-ruby/tree/v2.3.0) - 2019-07-10 |
80 | 61 |
|
81 |
| -* Updated `PuppetForge::V3::Release#verify` method to use `file_sha256` checksum from Forge API when available. |
82 |
| -* Added an `allow_md5` param to `PuppetForge::V3::Release#verify` method to control whether or not fallback to MD5 checksum will be allowed in cases where SHA-256 checksum is not available. |
| 62 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v2.3.0.rc1...v2.3.0) |
83 | 63 |
|
84 |
| -## v2.2.9 - 2017-12-01 |
| 64 | +## [v2.3.0.rc1](https://github.com/puppetlabs/forge-ruby/tree/v2.3.0.rc1) - 2019-07-10 |
85 | 65 |
|
86 |
| -### Changed |
| 66 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v2.2.9...v2.3.0.rc1) |
87 | 67 |
|
88 |
| -* Loosened dependency on `faraday` and `faraday_middleware` gems to include recent releases. |
| 68 | +## [v2.2.9](https://github.com/puppetlabs/forge-ruby/tree/v2.2.9) - 2017-12-01 |
89 | 69 |
|
90 |
| -## v2.2.8 - 2017-11-09 |
| 70 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v2.2.8...v2.2.9) |
91 | 71 |
|
92 |
| -### Added |
| 72 | +## [v2.2.8](https://github.com/puppetlabs/forge-ruby/tree/v2.2.8) - 2017-11-09 |
93 | 73 |
|
94 |
| -Created PuppetForge::Util class with a single method, version_valid?, in order to |
95 |
| -drop the r10k dependency on semantic_puppet. |
| 74 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v2.2.7...v2.2.8) |
96 | 75 |
|
97 |
| -## v2.2.7 - 2017-06-30 |
| 76 | +### Added |
98 | 77 |
|
99 |
| -### Changed |
| 78 | +- (RK-306) Add helper method in puppet_forge for valid semantic version. [#51](https://github.com/puppetlabs/forge-ruby/pull/51) ([andersonmills](https://github.com/andersonmills)) |
100 | 79 |
|
101 |
| -* Updated dependency on `semantic_puppet` to `~> 1.0`. |
| 80 | +## [v2.2.7](https://github.com/puppetlabs/forge-ruby/tree/v2.2.7) - 2017-06-30 |
102 | 81 |
|
103 |
| -## v2.2.6 - 2017-06-27 |
| 82 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v2.2.6...v2.2.7) |
104 | 83 |
|
105 |
| -### Fixed |
| 84 | +## [v2.2.6](https://github.com/puppetlabs/forge-ruby/tree/v2.2.6) - 2017-06-27 |
106 | 85 |
|
107 |
| -* Fixed an issue when attempting to assign a non-String value to `PuppetForge.host`. |
| 86 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v2.2.5...v2.2.6) |
108 | 87 |
|
109 |
| -## v2.2.5 - 2017-06-26 |
| 88 | +## [v2.2.5](https://github.com/puppetlabs/forge-ruby/tree/v2.2.5) - 2017-06-26 |
110 | 89 |
|
111 |
| -### Fixed |
| 90 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v2.2.4...v2.2.5) |
112 | 91 |
|
113 |
| -* (FORGE-338) Fixed an issue where `V3::Release.download_url` returned an incorrect value when `PuppetForge.host` included |
114 |
| - a path prefix. (Thanks to [Jainish Shah](https://github.com/jainishshah17) for the report and initial fix proposal.) |
| 92 | +## [v2.2.4](https://github.com/puppetlabs/forge-ruby/tree/v2.2.4) - 2017-04-17 |
115 | 93 |
|
116 |
| -## v2.2.4 - 2017-04-17 |
| 94 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v2.2.3...v2.2.4) |
117 | 95 |
|
118 | 96 | ### Added
|
119 | 97 |
|
120 |
| -* PuppetForge::Connection now has .accept\_language and .accept\_language= class methods providing a way to set the |
121 |
| - 'Accept-Language' header for outbound requests. |
| 98 | +- (MAINT) Add ability to set Accept-Language header for API requests. [#43](https://github.com/puppetlabs/forge-ruby/pull/43) ([scotje](https://github.com/scotje)) |
122 | 99 |
|
123 |
| -## v2.2.3 - 2017-01-17 |
| 100 | +## [v2.2.3](https://github.com/puppetlabs/forge-ruby/tree/v2.2.3) - 2017-01-17 |
124 | 101 |
|
125 |
| -### Changed |
| 102 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v1.0.6...v2.2.3) |
126 | 103 |
|
127 |
| -* Fixed an issue that was preventing PuppetForge.host from honoring any given path prefix. |
128 |
| -* Upgraded gettext-setup dependency to 0.11 release. |
| 104 | +## [v1.0.6](https://github.com/puppetlabs/forge-ruby/tree/v1.0.6) - 2016-07-25 |
129 | 105 |
|
130 |
| -## v2.2.2 - 2016-07-06 |
| 106 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v2.2.2...v1.0.6) |
131 | 107 |
|
132 |
| -### Changed |
| 108 | +## [v2.2.2](https://github.com/puppetlabs/forge-ruby/tree/v2.2.2) - 2016-07-06 |
133 | 109 |
|
134 |
| -* Externalized all user facing strings with gettext to support future localization work. |
| 110 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v2.2.1...v2.2.2) |
135 | 111 |
|
136 |
| -## v2.2.1 - 2016-05-24 |
| 112 | +## [v2.2.1](https://github.com/puppetlabs/forge-ruby/tree/v2.2.1) - 2016-05-24 |
137 | 113 |
|
138 |
| -### Changed |
| 114 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v2.2.0...v2.2.1) |
139 | 115 |
|
140 |
| -* Fixed an issue where certain types of connection failures raised a spurious "method missing" error instead of the underlying |
141 |
| - exception. |
142 |
| -* When setting PuppetForge::Connection.proxy, an empty string will now be treated as nil. If no proxy has yet been configured, |
143 |
| - setting to an empty string will have no effect. If a proxy has already been configured, setting to nil will unset the existing |
144 |
| - value. |
| 116 | +## [v2.2.0](https://github.com/puppetlabs/forge-ruby/tree/v2.2.0) - 2016-05-10 |
145 | 117 |
|
146 |
| -## v2.2.0 - 2016-05-10 |
| 118 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v2.1.5...v2.2.0) |
147 | 119 |
|
148 |
| -### Changed |
| 120 | +## [v2.1.5](https://github.com/puppetlabs/forge-ruby/tree/v2.1.5) - 2016-04-13 |
149 | 121 |
|
150 |
| -* puppet\_forge's optional dependency on Typhoeus now searches for a gem matching '~> 1.0.1' so it will pick up more recent versions. |
151 |
| - NOTE: This means if you have a version of Typhoeus installed that is less than 1.0.1, puppet\_forge will no longer use the Typhoeus |
152 |
| - adapter and will fall back to Ruby's Net::HTTP library. |
| 122 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v2.1.4...v2.1.5) |
153 | 123 |
|
154 |
| -## v2.1.5 - 2016-04-13 |
| 124 | +## [v2.1.4](https://github.com/puppetlabs/forge-ruby/tree/v2.1.4) - 2016-04-01 |
155 | 125 |
|
156 |
| -### Added |
| 126 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v2.1.3...v2.1.4) |
157 | 127 |
|
158 |
| -* PuppetForge::Connection now has .proxy and .proxy= class methods providing a more reliable way of configuring an HTTP proxy. |
| 128 | +## [v2.1.3](https://github.com/puppetlabs/forge-ruby/tree/v2.1.3) - 2016-01-25 |
159 | 129 |
|
160 |
| -### Changed |
| 130 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v2.1.2...v2.1.3) |
161 | 131 |
|
162 |
| -* Cached connection objects will now be automatically discarded when proxy or authorization config has changed. |
| 132 | +## [v2.1.2](https://github.com/puppetlabs/forge-ruby/tree/v2.1.2) - 2015-12-17 |
163 | 133 |
|
164 |
| -## v2.1.4 - 2016-04-01 |
| 134 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v2.1.1...v2.1.2) |
165 | 135 |
|
166 |
| -### Changed |
| 136 | +## [v2.1.1](https://github.com/puppetlabs/forge-ruby/tree/v2.1.1) - 2015-10-06 |
167 | 137 |
|
168 |
| -* Bug in usage of minitar filenames led to ignored tar files with tar file length of >100 chars. |
| 138 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v2.1.0...v2.1.1) |
169 | 139 |
|
170 |
| -## v2.1.3 - 2016-01-25 |
| 140 | +## [v2.1.0](https://github.com/puppetlabs/forge-ruby/tree/v2.1.0) - 2015-08-27 |
171 | 141 |
|
172 |
| -### Changed |
| 142 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v2.0.0...v2.1.0) |
173 | 143 |
|
174 |
| -* PuppetForge::V3::Release.download will now use the "file\_uri" field of the Release API response to calculate the URI to download from. (Thanks to [ericparton](https://github.com/ericparton) for the contribution.) |
| 144 | +## [v2.0.0](https://github.com/puppetlabs/forge-ruby/tree/v2.0.0) - 2015-08-14 |
175 | 145 |
|
176 |
| -## v2.1.2 - 2015-12-16 |
| 146 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v1.0.5...v2.0.0) |
177 | 147 |
|
178 |
| -### Changed |
179 |
| - |
180 |
| -* Runtime dependency on "faraday\_middleware" gem updated to allow 0.10.x releases. |
| 148 | +### Added |
181 | 149 |
|
182 |
| -## v2.1.1 - 2015-10-06 |
| 150 | +- (CODEMGMT-308) Add hash keys to symbols middleware [#14](https://github.com/puppetlabs/forge-ruby/pull/14) ([austb](https://github.com/austb)) |
| 151 | +- (CODEMGMT-296) Add PaginatedCollection ORM for where request [#11](https://github.com/puppetlabs/forge-ruby/pull/11) ([austb](https://github.com/austb)) |
| 152 | +- Add ORM for individual item (User/Module/Release) [#10](https://github.com/puppetlabs/forge-ruby/pull/10) ([austb](https://github.com/austb)) |
183 | 153 |
|
184 |
| -### Changed |
| 154 | +## [v1.0.5](https://github.com/puppetlabs/forge-ruby/tree/v1.0.5) - 2015-07-23 |
185 | 155 |
|
186 |
| -* Bug in error message around missing release on forge caused inappropriate error. |
| 156 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v1.0.4...v1.0.5) |
187 | 157 |
|
188 |
| -## v2.1.0 - 2015-08-20 |
| 158 | +## [v1.0.4](https://github.com/puppetlabs/forge-ruby/tree/v1.0.4) - 2014-12-17 |
189 | 159 |
|
190 |
| -### Added |
| 160 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v1.0.3...v1.0.4) |
191 | 161 |
|
192 |
| -* PuppetForge::ReleaseForbidden added to acknowledge 403 status returned from release download request |
| 162 | +## [v1.0.3](https://github.com/puppetlabs/forge-ruby/tree/v1.0.3) - 2014-06-24 |
193 | 163 |
|
194 |
| -## v2.0.0 - 2015-08-13 |
| 164 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v1.0.2...v1.0.3) |
195 | 165 |
|
196 |
| -### Added |
| 166 | +## [v1.0.2](https://github.com/puppetlabs/forge-ruby/tree/v1.0.2) - 2014-06-16 |
197 | 167 |
|
198 |
| -* PuppetForge::V3::Release can now verify the md5, unpack, and install a release tarball. |
199 |
| -* PuppetForge::Middleware::SymbolifyJson to change Faraday response hash keys into symbols. |
200 |
| -* PuppetForge::V3::Metadata to represent a release's metadata as an object. |
201 |
| -* PuppetForge::Connection to provide Faraday connections. |
| 168 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v1.0.1...v1.0.2) |
202 | 169 |
|
203 |
| -### Changed |
| 170 | +## [v1.0.1](https://github.com/puppetlabs/forge-ruby/tree/v1.0.1) - 2014-06-02 |
204 | 171 |
|
205 |
| -* Failed API requests, such as those for a module that doesn't exist, throw a Faraday::ResourceNotFound error. |
206 |
| -* API requests are sent through Faraday directly rather than through Her. |
207 |
| -* PuppetForge::V3::Base#where and PuppetForge::V3::Base#all now send an API request immediately and return a paginated collection. |
| 172 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/v1.0.0...v1.0.1) |
208 | 173 |
|
209 |
| -### Removed |
| 174 | +## [v1.0.0](https://github.com/puppetlabs/forge-ruby/tree/v1.0.0) - 2014-05-16 |
210 | 175 |
|
211 |
| -* Dependency on Her (also removes dependency on ActiveSupport). |
| 176 | +[Full Changelog](https://github.com/puppetlabs/forge-ruby/compare/2f052f220f0b3f4e135d930491edecf222fc059f...v1.0.0) |
0 commit comments