Nudge 2.0 Official Release Merge

.github/workflows/build_nudge_pr.yml

@@ -6,7 +6,7 @@ on:
 
 jobs:
   build:
-    runs-on: macos-13
+    runs-on: macos-14
     if: contains(github.event.pull_request.labels.*.name, 'safe to test')
 
     steps:

.github/workflows/build_nudge_prerelease.yml

@@ -15,7 +15,7 @@ on:
 
 jobs:
   build:
-    runs-on: macos-13
+    runs-on: macos-14
 
     steps:
     - name: Checkout nudge repo

.github/workflows/build_nudge_prerelease_manual.yml

@@ -7,7 +7,7 @@ on: [workflow_dispatch]
 
 jobs:
   build:
-    runs-on: macos-13
+    runs-on: macos-14
 
     steps:
     - name: Checkout nudge repo

.github/workflows/build_nudge_release.yml

@@ -15,7 +15,7 @@ on:
 
 jobs:
   build:
-    runs-on: macos-13
+    runs-on: macos-14
 
     steps:
     - name: Checkout nudge repo

.github/workflows/build_nudge_release_manual.yml

@@ -7,7 +7,7 @@ on: [workflow_dispatch]
 
 jobs:
   build:
-    runs-on: macos-13
+    runs-on: macos-14
 
     steps:
     - name: Checkout nudge repo

CHANGELOG.md

@@ -4,6 +4,100 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.0.0] - 2024-07-18
+Requires macOS 12.0 and higher.
+
+### Breaking Changes
+- **macOS 11 is now unsupported**
+  - Please use Nudge 1.x releases for macOS 11
+- Due to implementing markdown support, many of the elements within Nudge may no longer be in **bold** if you customize them.
+  - To work around this please add `**` elements to these customizations
+  - For example: The `mainContentNote` value of `Important Notes` would become `**Important Notes**`
+- The SOFA feed is **opt-out**, which included the new `Unsupported UI`. If you do not want the Unsupported UI features, you will need to actively opt-out of these options.
+
+### Changed
+- Now built on Swift 5.10, Xcode 15.4 and macOS 14
+- New Xcode Scheme `-bundle-mode-profile` to test profile logic
+  - `-bundle-mode` has been renamed to `-bundle-mode-json`
+- You can now pass two formats of **strings** to `requiredInstallationDate`
+  - `2025-01-01T00:00:00Z` for UTC
+  - `2025-01-01T00:00:00` for local time
+  - If you are using a MDM profile and passing the original `Date` key, you must change to utilizing `String` as Apple requires ISO8601 formatted dates
+- You can now pass the strings `latest`, `latest-supported` and `latest-minor` in the `requiredMinimumOSVersion` key
+  - `latest`: always force latest release and if the machine can't this version, show the new "unsupported device" user interface
+  - `latest-supported`: always get the latest version sofa shows that is supported by this device
+  - `latest-minor`: stay in the current major release and get the latest minor updates available
+  - This requires utilizing the SOFA feed features to properly work, which is opt-out by default
+  - Nudge will then utilize two date integers to automatically calculate the `requiredInstallationDate`
+    - `activelyExploitedCVEsMajorUpgradeSLA` under the `osVersionRequirement` key will default to 14 days
+    - `activelyExploitedCVEsMinorUpdateSLA` under the `osVersionRequirement` key will default to 14 days
+    - `nonActivelyExploitedCVEsMajorUpgradeSLA` under the `osVersionRequirement` key will default to 21 days
+    - `nonActivelyExploitedCVEsMinorUpdateSLA` under the `osVersionRequirement` key will default to 21 days
+    - `standardMajorUpgradeSLA` under the `osVersionRequirement` key will default to 28 days
+    - `standardMinorUpdateSLA` under the `osVersionRequirement` key will default to 28 days
+    - These dates are calculated against the `ReleaseDate` key in the SOFA feed, which is UTC formatted. Local timezones will **not be supported** with the automatic sofa feed unless you use a custom feed and change this value yourself, following ISO-8601 date formats
+      - To artificially delay the SOFA nudge events, see the details below for `nudgeMajorUpgradeEventLaunchDelay` and `nudgeMinorUpdateEventLaunchDelay`
+    - If you'd like to not have nudge events for releases without any known CVEs, please configure the `disableNudgeForStandardInstalls` key under `optionalFeatures` to true
+- You can now disable the `Days Remaining To Update:` item on the left side of the UI.
+  - Configure the `showDaysRemainingToUpdate` key under `userInterface` to false
+
+### Fixed
+- `screenshotDisplay` view had a bug that may result in the screenshot being partially cut off or zoomable
+- `fallbackLanguage` would return the wrong language even when specified in the configuration
+  - Fixes [582](https://github.com/macadmins/nudge/issues/582)
+- The timer controller logic was utilizing hours remaining vs seconds, which resulted in the `elapsedRefreshCycle` being used at the final hour of the nudge event vs the `imminentRefreshCycle`. This has been corrected to calculate the seconds remaining.
+  - Fixes [568](https://github.com/macadmins/nudge/issues/568)
+- More descriptive logs when loading json/mdm profile keys
+- Refactor portions of the `softwareupdate` logic to reduce potential errors
+- Fixed errors when moving to Swift 5.10
+- Fixed wrong `requiredInstallationDate` calculations when using [Non-Gregorian calendars](https://github.com/macadmins/nudge/issues/509)
+- Fixed UI logic when requiredInstallationDate is under an hour and `allowLaterDeferralButton` is set to false
+  - Issue [475](https://github.com/macadmins/nudge/issues/475)
+
+### Added
+- To artificially change the `requredInstallationDate` thereby giving your users a default grace period for all Nudge events updates, please configure the `nudgeMajorUpgradeEventLaunchDelay` and `nudgeMinorUpdateEventLaunchDelay` keys under `userExperience` in amount of days.
+- A local image path can now be specified for the notification event when Nudge terminates and application
+  - Please configure the `applicationTerminatedNotificationImagePath` key under `userInterface`
+  - Due to limitations within Apple's API, a local path is only supported at this time
+- An admin can now alter the text when Nudge terminates and application
+  - Please configure the `applicationTerminatedTitleText` and `applicationTerminatedBodyText` keys under the `updateElements` key in `UserInterface` 
+- Remote URLs can now be used on `iconDarkPath`, `iconLightPath`, `screenShotDarkPath` and `screenShotLightPath`
+  - Please note that these files will be downloaded each time Nudge is ran and there is currently not a way to cache these objects.
+  - If these files fail to download, a default company logo will be shown.
+- Actively Exploited CVEs in the left sidebar
+  - To disable this item, please configure the `showActivelyExploitedCVEs` key under `userInterface` to false
+- An admin can now allow users to move the Nudge window with `userExperience` key `allowMovableWindow`
+- To ease testing, you can now pass `-disable-randomDelay` as an argument to ignore the `randomDelay` key if it is set by a JSON or mobileconfig
+- Basic SwiftUI support for Markdown text options
+  - Utilizing Apple's markdown features, you can now utilize, bold, italic, underline, subscript and url links directly into any of the text fields
+- [SOFA](https://github.com/macadmins/sofa) feed support
+  - Set the `utilizeSOFAFeed` key `false` under `optionalFeatures` to disable this feature 
+  - Nudge will by default check the feed every 24 hours and save a cache file under `~/Library/Application Support/com.github.macadmins.Nudge/sofa-macos_data_feed.json`
+  - In order to change this, please configure the `refreshSOFAFeedTime` key under `optionalFeatures` in seconds
+  - If you are utilizing a custom sofa feed, please configure the `customSOFAFeedURL` key under `optionalFeatures`
+- "Unsupported device" UI in standard mode that utilizes the SOFA feed
+  - Set the `attemptToCheckForSupportedDevice` key `false` under `optionalFeatures` to disable this feature 
+  - There are new keys to set all of text fields: `actionButtonTextUnsupported`, `mainContentHeaderUnsupported`, `mainContentNoteUnsupported`, `mainContentSubHeaderUnsupported`, `mainContentTextUnsupported`, `subHeaderUnsupported` under the `updateElements` key in `UserInterface` 
+  - `unsupportedURL` and `unsupportedURLs` can change the information button itself, but it will remain in the `osVersionRequirement` key with `unsupportedURLs` and `unsupportedURLs`.
+  - An icon will appear as an overlay on top of the company image to further emphasize the device is no longer supported
+- An admin can now show the `requiredInstallationDate` as a item on the left side of nudge.
+  - To enable this, please configure the `showRequiredDate` key under `userInterface` to true
+  - You can also expirement with the format of this date through the key `requiredInstallationDisplayFormat` under `userInterface`
+  - Be aware that the format you desire may not look good on the UI.
+- Nudge can now honor the current cycle timers when user's press the `Quit` button.
+  - Set the `honorCycleTimersOnExit` key to `true` under `optionalFeatures` to enable this feature
+  - [Issue 548](https://github.com/macadmins/nudge/issues/548)
+- When the device is running macOS 12.3 or higher, Nudge uses the delta logic for macOS Upgrades
+  - [Issue 417](https://github.com/macadmins/nudge/issues/417)
+- Nudge can now bypass activations and re-activations when a macOS update is `Downloading`, `Preparing` or `Staged` for installation.
+  - To disable this, please configure the `acceptableUpdatePreparingUsage` key under `optionalFeatures` to false
+  - Issue [555](https://github.com/macadmins/nudge/issues/555) and [571](https://github.com/macadmins/nudge/issues/571)
+- Nudge can now attempt to honor DoNotDisturb/Focus times
+  - To enable this, please configure the `honorFocusModes` key in `optionalFeatures` to true
+  - This is an **expiremental feature** and may not work due to significant changes that Apple has designed for detecting these events.
+- Nudge now attempts to reload the preferences if the MDM profile is updated
+  - Issue [370](https://github.com/macadmins/nudge/issues/370)
+
 ## [1.1.16] - 2024-03-13
 This will be the **final Nudge release** for macOS 11 and potentially other versions of macOS.
 
@@ -197,7 +291,7 @@ Almost all of these changes were sent by others. Thank you for continuing to sup
 - `attemptToBlockApplicationLaunches`
   - When enabled, Nudge will attempt to block application launches after the required installation date. This key must be used in conjunction with `blockedApplicationBundleIDs`.
 - `blockedApplicationBundleIDs`
-  - The application Bundle ID which Nudge disallows from lauching after the required installation date. You can specify one or more Bundle ID.
+  - The application Bundle ID which Nudge disallows from launching after the required installation date. You can specify one or more Bundle ID.
 - `terminateApplicationsOnLaunch`
   - When enabled, Nudge will terminate the applications listed in blockedApplicationBundleIDs upon initial launch.
 

Example Assets/com.github.macadmins.Nudge.tester.plist

@@ -0,0 +1,121 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>optionalFeatures</key>
+	<dict>
+		<key>acceptableAssertionApplicationNames</key>
+		<array>
+			<string>zoom.us</string>
+			<string>Meeting Center</string>
+			<string>Google Chrome</string>
+			<string>Safari</string>
+		</array>
+		<key>acceptableAssertionUsage</key>
+		<true/>
+		<key>acceptableCameraUsage</key>
+		<true/>
+		<key>acceptableScreenSharingUsage</key>
+		<true/>
+		<key>attemptToBlockApplicationLaunches</key>
+		<true/>
+		<key>blockedApplicationBundleIDs</key>
+		<array>
+			<string>com.microsoft.VSCode</string>
+			<string>us.zoom.xos</string>
+		</array>
+		<key>terminateApplicationsOnLaunch</key>
+		<false/>
+		<key>utilizeSOFAFeed</key>
+		<true/>
+	</dict>
+	<key>osVersionRequirements</key>
+	<array>
+		<dict>
+			<key>aboutUpdateURL</key>
+			<string>https://apple.com</string>
+			<key>requiredMinimumOSVersion</key>
+			<string>latest-supported</string>
+			<key>unsupportedURL</key>
+			<string>https://google.com</string>
+		</dict>
+	</array>
+	<key>userExperience</key>
+	<dict>
+		<key>elapsedRefreshCycle</key>
+		<integer>10</integer>
+		<key>initialRefreshCycle</key>
+		<integer>10</integer>
+		<key>loadLaunchAgent</key>
+		<false/>
+		<key>nudgeRefreshCycle</key>
+		<integer>5</integer>
+		<key>randomDelay</key>
+		<false/>
+	</dict>
+	<key>userInterface</key>
+	<dict>
+		<key>iconDarkPath</key>
+		<string>https://github.com/macadmins/nudge/blob/main/assets/NudgeIconInverted.png?raw=true</string>
+		<key>iconLightPath</key>
+		<string>https://github.com/macadmins/nudge/blob/main/assets/NudgeIcon.png?raw=true</string>
+		<key>screenShotDarkPath</key>
+		<string>https://github.com/macadmins/nudge/blob/main/assets/standard_mode/demo_dark_1_icon.png?raw=true</string>
+		<key>screenShotLightPath</key>
+		<string>https://github.com/macadmins/nudge/blob/main/assets/standard_mode/demo_light_1_icon.png?raw=true</string>
+		<key>simpleMode</key>
+		<false/>
+		<key>updateElements</key>
+		<array>
+			<dict>
+				<key>_language</key>
+				<string>en</string>
+				<key>actionButtonText</key>
+				<string>actionButtonText</string>
+				<key>customDeferralButtonText</key>
+				<string>customDeferralButtonText</string>
+				<key>customDeferralDropdownText</key>
+				<string>customDeferralDropdownText</string>
+				<key>informationButtonText</key>
+				<string>informationButtonText</string>
+				<key>actionButtonTextUnsupported</key>
+				<string>actionButtonTextUnsupported</string>
+				<key>mainContentHeader</key>
+				<string>mainContentHeader</string>
+				<key>mainContentHeaderUnsupported1</key>
+				<string>mainContentHeaderUnsupported</string>
+				<key>mainContentNote</key>
+				<string>mainContentNote</string>
+				<key>mainContentNoteUnsupported1</key>
+				<string>mainContentNoteUnsupported</string>
+				<key>mainContentSubHeader</key>
+				<string>mainContentSubHeader</string>
+				<key>mainContentSubHeaderUnsupported1</key>
+				<string>mainContentSubHeaderUnsupported</string>
+				<key>mainContentText</key>
+				<string>mainContentText</string>
+				<key>mainContentTextUnsupported1</key>
+				<string>mainContentTextUnsupported</string>
+				<key>mainHeader</key>
+				<string>mainHeader</string>
+				<key>mainHeaderUnsupported1</key>
+				<string>mainHeaderUnsupported</string>
+				<key>oneDayDeferralButtonText</key>
+				<string>oneDayDeferralButtonText</string>
+				<key>oneHourDeferralButtonText</key>
+				<string>oneHourDeferralButtonText</string>
+				<key>primaryQuitButtonText</key>
+				<string>primaryQuitButtonText</string>
+				<key>screenShotAltText</key>
+				<string>Click to zoom into screenshot</string>
+				<key>secondaryQuitButtonText</key>
+				<string>secondaryQuitButtonText</string>
+				<key>subHeader</key>
+				<string>subHeader</string>
+				<key>subHeaderUnsupported1</key>
+				<string>subHeaderUnsupported</string>
+			</dict>
+		</array>
+	</dict>
+</dict>
+</plist>