|
2 | 2 |
|
3 | 3 | All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). |
4 | 4 |
|
| 5 | +<!-- markdownlint-configure-file |
| 6 | +{ |
| 7 | + "no-duplicate-heading": { |
| 8 | + "siblings_only": true |
| 9 | + } |
| 10 | +} |
| 11 | +--> |
| 12 | + |
5 | 13 | ## [1.11.0] - 2021-11-20 |
6 | 14 |
|
7 | 15 | ### Added |
| 16 | + |
8 | 17 | - Added processor type conventions for [JamfUploader](https://grahamrpugh.com/2020/12/14/introducing-jamf-upload.html) (`.jamf`), [PkgSigner](https://derflounder.wordpress.com/2021/07/30/signing-autopkg-built-packages-using-a-sign-recipe/) (`.sign`), and [GPGSignatureVerifier](https://github.com/autopkg/gerardkok-recipes/blob/master/SharedProcessors/GPGSignatureVerifier.py) (`.verify`) families of recipes. |
9 | 18 | - `BrewCaskInfoProvider` has been added to the list of deprecated AutoPkg processors. |
10 | 19 | - More output when `check-git-config-email` fails. |
11 | 20 |
|
12 | 21 | ## [1.10.1] - 2021-02-21 |
13 | 22 |
|
14 | 23 | ### Added |
| 24 | + |
15 | 25 | - In anticipation of AutoPkg 2.3, now supports checking YAML recipes (must have extension `.recipe.yaml`). |
16 | 26 | - In anticipation of AutoPkg 2.3, supports additional AutoPkg plist extension `.recipe.plist`. |
17 | 27 | - Supports JSON AutoPkg recipes (must have extension `.recipe.json`). NOTE: AutoPkg itself does not yet support JSON recipes. |
18 | 28 | - Built placeholder for checking for unused AutoPkg recipe input variables in the future. Check is disabled for now. |
19 | 29 |
|
20 | 30 | ### Fixed |
| 31 | + |
21 | 32 | - Fixed a bug preventing display of AutoPkg recipe path and identifier if duplicate identifier is found in the repo. |
22 | 33 |
|
23 | 34 | ## [1.9.0] - 2021-01-18 |
24 | 35 |
|
25 | 36 | ### Added |
| 37 | + |
26 | 38 | - Added check for any unexpected processor arguments in any AutoPkg processor. |
27 | 39 |
|
28 | 40 | ### Removed |
| 41 | + |
29 | 42 | - CodeSignatureVerifier processor argument verification (added in v1.8.2) has been replaced by the above. |
30 | 43 |
|
31 | 44 | ## [1.8.2] - 2021-01-18 |
32 | 45 |
|
33 | 46 | ### Added |
| 47 | + |
34 | 48 | - Added check for unexpected processor arguments in CodeSignatureVerifier. |
35 | 49 |
|
36 | 50 | ### Changed |
| 51 | + |
37 | 52 | - Renamed default branch to `main`. |
38 | 53 |
|
39 | 54 | ## [1.8.1] - 2020-12-08 |
40 | 55 |
|
41 | 56 | ### Removed |
| 57 | + |
42 | 58 | - Removed warning about setting MinimumVersion of AutoPkg recipes to 2.0+. |
43 | 59 | - Reverted 1.4 minimum version requirement for processors that use URLGetter (introduced in 1.7.0). |
44 | 60 |
|
45 | | - |
46 | 61 | ## [1.8.0] - 2020-10-08 |
47 | 62 |
|
48 | 63 | ### Changed |
49 | | -- Replaced `plistlib.readPlist()` with `plistlib.load()` |
50 | 64 |
|
| 65 | +- Replaced `plistlib.readPlist()` with `plistlib.load()` |
51 | 66 |
|
52 | 67 | ## [1.7.0] - 2020-10-06 |
53 | 68 |
|
54 | 69 | ### Added |
| 70 | + |
55 | 71 | - Added pre-commit-macadmin change log (this file) |
56 | 72 | - Ensure no superclass processors (e.g. URLGetter) are used, as these are intended to be referred to by other processors rather than directly used in recipes |
57 | 73 | - Warn if setting a MinimumVersion greater than or equal to 2 in AutoPkg recipes, because some administrators may be running 1.4.1 and waiting for processor authors to add Python 3 compatibility |
58 | 74 | - Validate `minimum_os_version` and `maximum_os_version` keys in Munki pkginfo files |
59 | 75 |
|
60 | 76 | ### Changed |
| 77 | + |
61 | 78 | - Set MinimumVersion needed for [C]URL* processors to 1.4, to ensure utilization of URLGetter |
62 | 79 | - Updated valid Munki script shebangs to include Munki embedded Python symlink and path |
63 | 80 |
|
64 | | - |
65 | 81 | ## [1.6.2] - 2020-01-20 |
66 | 82 |
|
67 | 83 | ### Fixed |
68 | | -- Added missing sys module for Python version determination |
69 | 84 |
|
| 85 | +- Added missing sys module for Python version determination |
70 | 86 |
|
71 | 87 | ## [1.6.1] - 2019-12-26 |
72 | 88 |
|
73 | 89 | ### Fixed |
74 | | -- Convert subprocess output to string |
75 | 90 |
|
| 91 | +- Convert subprocess output to string |
76 | 92 |
|
77 | 93 | ## [1.6.0] - 2019-12-26 |
78 | 94 |
|
79 | 95 | ### Added |
| 96 | + |
80 | 97 | - Validate possible values of RestartAction key in Munki pkginfo |
81 | 98 | - New hook to check Git user email configuration (`git config user.email`) |
82 | 99 |
|
83 | | - |
84 | 100 | ## [1.5.2] - 2019-11-26 |
85 | 101 |
|
86 | 102 | ### Fixed |
| 103 | + |
87 | 104 | - Removed redundant EndOfCheckPhase check |
88 | 105 | - Added URLGetter minimum version (although we should never need this since URLGetter is not meant to be called directly) |
89 | 106 |
|
90 | | - |
91 | 107 | ## [1.5.1] - 2019-09-21 |
92 | 108 |
|
93 | 109 | ### Added |
94 | | -- Checking for downloader processors without EndOfCheckPhase |
95 | 110 |
|
| 111 | +- Checking for downloader processors without EndOfCheckPhase |
96 | 112 |
|
97 | 113 | ## [1.5.0] - 2019-09-17 |
98 | 114 |
|
99 | 115 | ### Added |
| 116 | + |
100 | 117 | - Warn if using deprecated AutoPkg processors (only one exists now: CURLDownloader) |
101 | 118 | - Allow specifying multiple acceptable recipe prefixes |
102 | 119 |
|
103 | 120 | ### Fixed |
104 | | -- Updated minimum AutoPkg versions required for processors to only include significant digits for LooseVersion comparison |
105 | 121 |
|
| 122 | +- Updated minimum AutoPkg versions required for processors to only include significant digits for LooseVersion comparison |
106 | 123 |
|
107 | 124 | ## [1.4.0] - 2019-08-22 |
108 | 125 |
|
109 | 126 | ### Added |
| 127 | + |
110 | 128 | - Detect and warn on AutoPkg recipe identifier duplication |
111 | 129 | - Warn if any Munki pkginfo script is missing a shebang |
112 | 130 |
|
113 | | - |
114 | 131 | ## [1.3.0] - 2019-07-03 |
115 | 132 |
|
116 | 133 | ### Added |
| 134 | + |
117 | 135 | - `--strict` mode for check-autopkg-recipes hook, along with numerous conventions that it can validate |
118 | 136 | - Catch identifier loops, where recipe and its parent have the same identifier |
119 | 137 |
|
120 | 138 | ### Fixed |
| 139 | + |
121 | 140 | - Better handling of unicode |
122 | 141 | - Fixed warning output when recipe list is invalid |
123 | 142 | - Fixed shared FileWaveImporter processor identifier |
124 | 143 |
|
125 | 144 | ### Changed |
| 145 | + |
126 | 146 | - Handle recipe lists that have prefixes |
127 | 147 | - Allow pkg recipes with no process (stubs for software already in pkg format at time of download) |
128 | 148 |
|
129 | | - |
130 | 149 | ## [1.2.1] - 2019-06-28 |
131 | 150 |
|
132 | 151 | ### Added |
| 152 | + |
133 | 153 | - Better parsing of MunkiPkg build-info files, and validation of keys |
134 | 154 | - Better handle processors with missing Processor keys |
135 | 155 | - Warn if MunkiPkg project target disk is not the startup disk |
136 | 156 | - Validate required keys in MunkiPkg build-info files |
137 | 157 | - Validate bundle identifier in MunkiPkg build-info files |
138 | 158 |
|
139 | | - |
140 | 159 | ## [1.2.0] - 2019-06-27 |
141 | 160 |
|
142 | 161 | ### Added |
| 162 | + |
143 | 163 | - Checking AutoPkg recipe processors for missing Processor key |
144 | 164 | - Validation of EndOfCheckPhase placement within download recipes |
145 | 165 |
|
146 | 166 | ### Changed |
| 167 | + |
147 | 168 | - Created shared function for checking required keys for pkginfo files and AutoPkg recipes |
148 | 169 | - No longer requiring an Input key for AutoPkg recipes |
149 | 170 |
|
150 | | - |
151 | 171 | ## [1.1.4] - 2019-06-24 |
152 | 172 |
|
153 | 173 | ### Changed |
154 | | -- Skip processor checks for AutoPkg recipes without a Process |
155 | 174 |
|
| 175 | +- Skip processor checks for AutoPkg recipes without a Process |
156 | 176 |
|
157 | 177 | ## [1.1.3] - 2019-06-24 |
158 | 178 |
|
159 | 179 | ### Added |
| 180 | + |
160 | 181 | - Added `--ignore-min-vers-before` argument to check-autopkg-recipes hook |
161 | 182 | - Added checking for `%NAME%.app` in check-autopkg-recipes hook |
162 | 183 |
|
163 | | - |
164 | 184 | ## [1.1.2] - 2019-06-22 |
165 | 185 |
|
166 | 186 | ### Added |
| 187 | + |
167 | 188 | - Added validation of AutoPkg recipe MinimumVersion in check-autopkg-recipes hook |
168 | 189 |
|
169 | 190 | ### Changed |
170 | | -- Fail early and stop processing files that don't parse |
171 | 191 |
|
| 192 | +- Fail early and stop processing files that don't parse |
172 | 193 |
|
173 | 194 | ## [1.1.1] - 2019-06-13 |
174 | 195 |
|
175 | 196 | ### Fixed |
176 | | -- Fixed issue that returned wrong pass/fail result for check-munki-pkgsinfo and check-autopkg-recipes hooks |
177 | 197 |
|
| 198 | +- Fixed issue that returned wrong pass/fail result for check-munki-pkgsinfo and check-autopkg-recipes hooks |
178 | 199 |
|
179 | 200 | ## [1.1.0] - 2019-06-13 |
180 | 201 |
|
181 | 202 | ### Added |
| 203 | + |
182 | 204 | - Added a note about combining list arguments in yaml config |
183 | 205 | - Added note about multi-line list args |
184 | 206 | - Ensure no trailing slashes on items_to_copy in check-munki-pkgsinfo |
185 | 207 |
|
186 | 208 | ### Changed |
| 209 | + |
187 | 210 | - Specified which yaml loader to use |
188 | 211 | - Removed zip as an package extension |
189 | 212 |
|
190 | 213 | ### Fixed |
191 | | -- Fixed issue that caused incorrect pass/fail for check-munki-pkgsinfo and check-autopkg-recipes hooks |
192 | 214 |
|
| 215 | +- Fixed issue that caused incorrect pass/fail for check-munki-pkgsinfo and check-autopkg-recipes hooks |
193 | 216 |
|
194 | 217 | ## [1.0.5] - 2019-03-15 |
195 | 218 |
|
196 | 219 | ### Added |
197 | | -- Added args documentation to read me |
198 | 220 |
|
| 221 | +- Added args documentation to read me |
199 | 222 |
|
200 | 223 | ## [1.0.4] - 2019-03-14 |
201 | 224 |
|
202 | 225 | ### Added |
203 | | -- Added check for approved catalogs |
204 | 226 |
|
| 227 | +- Added check for approved catalogs |
205 | 228 |
|
206 | 229 | ## [1.0.3] - 2019-03-13 |
207 | 230 |
|
208 | 231 | ### Fixed |
209 | | -- Fixed variable capitalization |
210 | 232 |
|
| 233 | +- Fixed variable capitalization |
211 | 234 |
|
212 | 235 | ## [1.0.2] - 2019-03-13 |
213 | 236 |
|
214 | 237 | ### Added |
| 238 | + |
215 | 239 | - Enabled basic type checking for pkginfo dicts |
216 | 240 |
|
217 | 241 | ### Changed |
| 242 | + |
218 | 243 | - Adjusted required keys in check-munki-pkgsinfo to include name and description by default |
219 | 244 | - Temporarily skipping top level plist type (dict) checking |
220 | 245 |
|
221 | | - |
222 | 246 | ## [1.0.1] - 2019-03-03 |
223 | 247 |
|
224 | 248 | ### Added |
| 249 | + |
225 | 250 | - Added forbid-autopkg-trust-info hook |
226 | 251 | - Added check for recipe prefix enforcement |
227 | 252 |
|
228 | 253 | ### Fixed |
229 | | -- Fixed bug in check-autopkg-recipes hook |
230 | 254 |
|
| 255 | +- Fixed bug in check-autopkg-recipes hook |
231 | 256 |
|
232 | 257 | ## 1.0.0 - 2019-03-01 |
233 | 258 |
|
234 | 259 | - Initial release |
235 | 260 |
|
236 | | - |
237 | 261 | [Unreleased]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.10.2...HEAD |
238 | 262 | [1.10.2]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.10.1...v1.10.2 |
239 | 263 | [1.10.1]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.9.0...v1.10.1 |
|
0 commit comments