Skip to content

Commit ae22f0d

Browse files
committed
Markdown linting
1 parent b49760b commit ae22f0d

1 file changed

Lines changed: 48 additions & 24 deletions

File tree

CHANGELOG.md

Lines changed: 48 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,238 +2,262 @@
22

33
All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/).
44

5+
<!-- markdownlint-configure-file
6+
{
7+
"no-duplicate-heading": {
8+
"siblings_only": true
9+
}
10+
}
11+
-->
12+
513
## [1.11.0] - 2021-11-20
614

715
### Added
16+
817
- 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.
918
- `BrewCaskInfoProvider` has been added to the list of deprecated AutoPkg processors.
1019
- More output when `check-git-config-email` fails.
1120

1221
## [1.10.1] - 2021-02-21
1322

1423
### Added
24+
1525
- In anticipation of AutoPkg 2.3, now supports checking YAML recipes (must have extension `.recipe.yaml`).
1626
- In anticipation of AutoPkg 2.3, supports additional AutoPkg plist extension `.recipe.plist`.
1727
- Supports JSON AutoPkg recipes (must have extension `.recipe.json`). NOTE: AutoPkg itself does not yet support JSON recipes.
1828
- Built placeholder for checking for unused AutoPkg recipe input variables in the future. Check is disabled for now.
1929

2030
### Fixed
31+
2132
- Fixed a bug preventing display of AutoPkg recipe path and identifier if duplicate identifier is found in the repo.
2233

2334
## [1.9.0] - 2021-01-18
2435

2536
### Added
37+
2638
- Added check for any unexpected processor arguments in any AutoPkg processor.
2739

2840
### Removed
41+
2942
- CodeSignatureVerifier processor argument verification (added in v1.8.2) has been replaced by the above.
3043

3144
## [1.8.2] - 2021-01-18
3245

3346
### Added
47+
3448
- Added check for unexpected processor arguments in CodeSignatureVerifier.
3549

3650
### Changed
51+
3752
- Renamed default branch to `main`.
3853

3954
## [1.8.1] - 2020-12-08
4055

4156
### Removed
57+
4258
- Removed warning about setting MinimumVersion of AutoPkg recipes to 2.0+.
4359
- Reverted 1.4 minimum version requirement for processors that use URLGetter (introduced in 1.7.0).
4460

45-
4661
## [1.8.0] - 2020-10-08
4762

4863
### Changed
49-
- Replaced `plistlib.readPlist()` with `plistlib.load()`
5064

65+
- Replaced `plistlib.readPlist()` with `plistlib.load()`
5166

5267
## [1.7.0] - 2020-10-06
5368

5469
### Added
70+
5571
- Added pre-commit-macadmin change log (this file)
5672
- 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
5773
- 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
5874
- Validate `minimum_os_version` and `maximum_os_version` keys in Munki pkginfo files
5975

6076
### Changed
77+
6178
- Set MinimumVersion needed for [C]URL* processors to 1.4, to ensure utilization of URLGetter
6279
- Updated valid Munki script shebangs to include Munki embedded Python symlink and path
6380

64-
6581
## [1.6.2] - 2020-01-20
6682

6783
### Fixed
68-
- Added missing sys module for Python version determination
6984

85+
- Added missing sys module for Python version determination
7086

7187
## [1.6.1] - 2019-12-26
7288

7389
### Fixed
74-
- Convert subprocess output to string
7590

91+
- Convert subprocess output to string
7692

7793
## [1.6.0] - 2019-12-26
7894

7995
### Added
96+
8097
- Validate possible values of RestartAction key in Munki pkginfo
8198
- New hook to check Git user email configuration (`git config user.email`)
8299

83-
84100
## [1.5.2] - 2019-11-26
85101

86102
### Fixed
103+
87104
- Removed redundant EndOfCheckPhase check
88105
- Added URLGetter minimum version (although we should never need this since URLGetter is not meant to be called directly)
89106

90-
91107
## [1.5.1] - 2019-09-21
92108

93109
### Added
94-
- Checking for downloader processors without EndOfCheckPhase
95110

111+
- Checking for downloader processors without EndOfCheckPhase
96112

97113
## [1.5.0] - 2019-09-17
98114

99115
### Added
116+
100117
- Warn if using deprecated AutoPkg processors (only one exists now: CURLDownloader)
101118
- Allow specifying multiple acceptable recipe prefixes
102119

103120
### Fixed
104-
- Updated minimum AutoPkg versions required for processors to only include significant digits for LooseVersion comparison
105121

122+
- Updated minimum AutoPkg versions required for processors to only include significant digits for LooseVersion comparison
106123

107124
## [1.4.0] - 2019-08-22
108125

109126
### Added
127+
110128
- Detect and warn on AutoPkg recipe identifier duplication
111129
- Warn if any Munki pkginfo script is missing a shebang
112130

113-
114131
## [1.3.0] - 2019-07-03
115132

116133
### Added
134+
117135
- `--strict` mode for check-autopkg-recipes hook, along with numerous conventions that it can validate
118136
- Catch identifier loops, where recipe and its parent have the same identifier
119137

120138
### Fixed
139+
121140
- Better handling of unicode
122141
- Fixed warning output when recipe list is invalid
123142
- Fixed shared FileWaveImporter processor identifier
124143

125144
### Changed
145+
126146
- Handle recipe lists that have prefixes
127147
- Allow pkg recipes with no process (stubs for software already in pkg format at time of download)
128148

129-
130149
## [1.2.1] - 2019-06-28
131150

132151
### Added
152+
133153
- Better parsing of MunkiPkg build-info files, and validation of keys
134154
- Better handle processors with missing Processor keys
135155
- Warn if MunkiPkg project target disk is not the startup disk
136156
- Validate required keys in MunkiPkg build-info files
137157
- Validate bundle identifier in MunkiPkg build-info files
138158

139-
140159
## [1.2.0] - 2019-06-27
141160

142161
### Added
162+
143163
- Checking AutoPkg recipe processors for missing Processor key
144164
- Validation of EndOfCheckPhase placement within download recipes
145165

146166
### Changed
167+
147168
- Created shared function for checking required keys for pkginfo files and AutoPkg recipes
148169
- No longer requiring an Input key for AutoPkg recipes
149170

150-
151171
## [1.1.4] - 2019-06-24
152172

153173
### Changed
154-
- Skip processor checks for AutoPkg recipes without a Process
155174

175+
- Skip processor checks for AutoPkg recipes without a Process
156176

157177
## [1.1.3] - 2019-06-24
158178

159179
### Added
180+
160181
- Added `--ignore-min-vers-before` argument to check-autopkg-recipes hook
161182
- Added checking for `%NAME%.app` in check-autopkg-recipes hook
162183

163-
164184
## [1.1.2] - 2019-06-22
165185

166186
### Added
187+
167188
- Added validation of AutoPkg recipe MinimumVersion in check-autopkg-recipes hook
168189

169190
### Changed
170-
- Fail early and stop processing files that don't parse
171191

192+
- Fail early and stop processing files that don't parse
172193

173194
## [1.1.1] - 2019-06-13
174195

175196
### Fixed
176-
- Fixed issue that returned wrong pass/fail result for check-munki-pkgsinfo and check-autopkg-recipes hooks
177197

198+
- Fixed issue that returned wrong pass/fail result for check-munki-pkgsinfo and check-autopkg-recipes hooks
178199

179200
## [1.1.0] - 2019-06-13
180201

181202
### Added
203+
182204
- Added a note about combining list arguments in yaml config
183205
- Added note about multi-line list args
184206
- Ensure no trailing slashes on items_to_copy in check-munki-pkgsinfo
185207

186208
### Changed
209+
187210
- Specified which yaml loader to use
188211
- Removed zip as an package extension
189212

190213
### Fixed
191-
- Fixed issue that caused incorrect pass/fail for check-munki-pkgsinfo and check-autopkg-recipes hooks
192214

215+
- Fixed issue that caused incorrect pass/fail for check-munki-pkgsinfo and check-autopkg-recipes hooks
193216

194217
## [1.0.5] - 2019-03-15
195218

196219
### Added
197-
- Added args documentation to read me
198220

221+
- Added args documentation to read me
199222

200223
## [1.0.4] - 2019-03-14
201224

202225
### Added
203-
- Added check for approved catalogs
204226

227+
- Added check for approved catalogs
205228

206229
## [1.0.3] - 2019-03-13
207230

208231
### Fixed
209-
- Fixed variable capitalization
210232

233+
- Fixed variable capitalization
211234

212235
## [1.0.2] - 2019-03-13
213236

214237
### Added
238+
215239
- Enabled basic type checking for pkginfo dicts
216240

217241
### Changed
242+
218243
- Adjusted required keys in check-munki-pkgsinfo to include name and description by default
219244
- Temporarily skipping top level plist type (dict) checking
220245

221-
222246
## [1.0.1] - 2019-03-03
223247

224248
### Added
249+
225250
- Added forbid-autopkg-trust-info hook
226251
- Added check for recipe prefix enforcement
227252

228253
### Fixed
229-
- Fixed bug in check-autopkg-recipes hook
230254

255+
- Fixed bug in check-autopkg-recipes hook
231256

232257
## 1.0.0 - 2019-03-01
233258

234259
- Initial release
235260

236-
237261
[Unreleased]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.10.2...HEAD
238262
[1.10.2]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.10.1...v1.10.2
239263
[1.10.1]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.9.0...v1.10.1

0 commit comments

Comments
 (0)