Skip to content

Latest commit

 

History

History
109 lines (85 loc) · 6.57 KB

CHANGELOG.md

File metadata and controls

109 lines (85 loc) · 6.57 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

Unreleased

Added

  • BREAKING CHANGE Added HideRemindMeLaterButton() to IUpdateAvailable
  • BREAKING CHANGE Added HideSkipButton() to IUpdateAvailable
  • Added HideRemindMeLaterButton to the NetSparkle class. Defaults to false. Set to true to make NetSparkle call HideRemindMeLaterButton() when showing the update window.
  • Added HideSkipButton to the NetSparkle class. Defaults to false. Set to true to make NetSparkle call HideSkipButton() when showing the update window.

Changed

  • Release notes are now downloaded asynchronously, which should speed up the time it takes to show the download window
  • Release note date is now Date.ToString("D") instead of "dd MMM yyyy" so that release notes show localized date strings
  • POTENTIALLY BREAKING CHANGE Fixed bug where ValidationResult.Unchecked was not returned properly from OnDownloadFinished if download file signature is null (@keithclanton)

Removed

0.12.0 - 2017-08-02

Added

  • Added new LogWriter class for printing diagnostic messages to the console. You can now create your own child class that inherits from LogWriter to customize how information is logged to the console (or file, or wherever else you want diagnostic messages sent!)!
  • Added .gitattributes file for line ending consistency for all developers (@stephenwade)

Changed

  • Moved UpdateStatus enum to NetSparkle.Enums
  • Moved UpdateInfo class to its own file
  • Fixed bug in Configuration.cs where a few values were not set properly in the constructor due to InitWithDefaultValues being called at the wrong time (@devstudiosoft)
  • BREAKING CHANGE Fixed bug in AssemblyDiagnosticsAccessor where AssemblyProduct returned the assembly version and not the assembly name (@devstudiosoft)

Removed

  • BREAKING CHANGE Removed public void NetSparkle.ReportDiagnosticMessage in lieu of new LogWriter class.

0.11.0 - 2017-07-16

Added

  • Refactored logic to quit application to a separate QuitApplication() function

Changed

  • RunDownloadedInstaller() is now virtual and protected
  • Renamed some files and variables
  • Moved SecurityMode and ValidationResult enums to the NetSparkle.Enums namespace

0.10.0 - 2017-07-11

Added

  • This changelog
  • Sparkle class documentation to the readme
  • Section about how the appcast works to the readme

Changed

Much thanks to @stephenwade for his contributions to 0.10.0

  • Cleaned up and added documentation comments throughout the code (@stephenwade)
  • Renamed lots of identifiers throughout the project to remove "NetSparkle" (i.e., NetSparkleAppCast to AppCast, NetSparkleConfiguration to Configuration, etc.) (@stephenwade)
  • Renamed property UseSyncronizedForms to ShowsUIOnMainThread to better represent what it does (@stephenwade)
  • Renamed events CloseWPFSoftware and CloseWPFSoftwareAsync to CloseApplication and CloseApplicationAsync (@stephenwade)
    • These events are now always run, if present (instead of only on RunningFromWPF)
    • If one of these events is set, it will be run instead of quitting your app (to allow you a custom quit procedure), so these events should take care of quitting your app.
  • Renamed DSAVerificator to DSAChecker (@stephenwade)
  • Folder output changed to be more organized
  • Updated LICENSE file
  • Update NuGet package items

Removed

  • deprecated property EnableSilentMode
  • property RunningFromWPF

0.9.1.1 - 2017-06-06

Added

  • ClearOldInstallers Action that you can implement on your own to remove old installers. Use this if you download installers to a custom folder and need to erase them later.

Changed

  • Fixed compilation issue with EnableSilentMode (not sure how I never came across this!)

0.9.1 - 2017-03-30

Added

  • UpdateSize to NetSparkleAppCastItem, analogous to the length field within the <enclosure> tag
  • IsCriticalUpdate to NetSparkleAppCastItem
    • To use, add sparkle:criticalUpdate="true" as an attribute to the <enclosure> tag
    • When any update that the user needs is marked as critical, the skip and remind me later buttons are disabled
    • When an update is marked as critical, the release notes for that version state that the update is critical
    • To do something about a critical update in your own software, check Sparkle.LatestAppCastItems or Sparkle.UpdateMarkedCritical to see if an update in the list of updates that the user needs is critical

0.9 - 2017-03-28

Added

  • Several more diagnostic messages for debugging on the console
  • New SilentMode option to allow for the "normal" update process (NotSilent), completely silent updates (DownloadAndInstall), or silent downloads that you as the developer initiate the start of the update manually (DownloadNoInstall)
    • DownloadAndInstall may be quite jarring to your users if you don't tell them the software is about to quit to restart. Use AboutToExitForInstallerRun or AboutToExitForInstallerRunAsync to monitor for these events.
    • For proper DownloadNoInstall use, monitor the DownloadedFileReady event to know when things are ready. At some later time, call _sparkle.ShowUpdateNeededUI(true); to show the software update window. You may want to monitor other events as well to keep your user from performing another update check while a software update is downloading.
  • TmpDownloadFilePath to redirect the download location. This should be a folder, not a full path. Note that you still need to manually delete files that are downloaded here.

Changed

  • Deprecated EnableSilentMode in lieu of SilentMode
  • Stopped the software from redownloading the installer if it already exists on disk (saves bandwidth and time on the user's part)
    • Note that NetSparkle does not perform resumable downloads in between software instances
  • Fixed potential infinite software update download loop if the software keeps downloading corrupted files (corrupt files or ones that don't pass the DSA check).

Older

For older changes, see HISTORY.md.