From 3e5a164f83b704e856e881011a1893347422cd9b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jaime=20Pe=CC=81rez=20Crespo?= <jaime.perez@uninett.no>
Date: Tue, 24 Sep 2019 16:53:22 +0200
Subject: [PATCH] Update the changelog and upgrade notes.
---
docs/simplesamlphp-changelog.md | 38 +++++++-----------------
docs/simplesamlphp-upgrade-notes-1.18.md | 22 ++++++++++----
2 files changed, 28 insertions(+), 32 deletions(-)
diff --git a/docs/simplesamlphp-changelog.md b/docs/simplesamlphp-changelog.md
index b3e0ed9e6..c7be70b31 100644
--- a/docs/simplesamlphp-changelog.md
+++ b/docs/simplesamlphp-changelog.md
@@ -17,15 +17,17 @@ Released TBD
Released 2019-09-xx
+ * Fixed an issue with warnings being logged when using PHP 7.2 or newer (#1168).
+ * Fixed an issue with web server aliases or rewritten URLs not working (#1023, #1093).
+ * Fixed an issue that prevented errors to be logged if the log file was not writeable (#1194).
* Replace custom Email class with the phpmailer library.
- * Allow to log to STDERR in the logging.handler option.
+ * Allow logging to STDERR in the `logging.handler` option by setting it to `stderr`.
* Allow use of stream wrappers (e.g. s3://) in paths.
- * Improve 'update or insert' handling for different SQL drivers
- * The default algorithm within the TimeLimitedToken-class has been bumped from SHA-1 to SHA-256
- as announced by deprecation notice in 1.15-RC1
+ * Improved 'update or insert' handling for different SQL drivers.
+ * The default algorithm within the TimeLimitedToken class has been bumped from SHA-1 to SHA-256
+ as announced by deprecation notice in 1.15-RC1.
* Most modules have been externalized. They will not be included in our future releases by default,
- but will be easily installable using Composer.
- * The saml2-libary has been updated to v3.4.1
+ but will be easily installable using Composer. For now, they are still included in the package.
* Many minor fixes to code, css, documentation
### metarefresh
@@ -34,29 +36,11 @@ Released 2019-09-xx
configuration option.
### saml
- * Make the id of the generated signed metadata only change when metadata
- content changes.
- * New SP options `AssertionConsumerService` and `SingleLogoutServiceLocation`
- that allow to override the default URL paths.
+ * Make the id of the generated signed metadata only change when metadata content changes.
+ * New SP metadata configuration options `AssertionConsumerService` and `SingleLogoutServiceLocation`
+ to allow overriding the default URL paths.
* Added support for per-IDP configurable `AuthnContextClassRef`/`AuthnContextComparison`.
-### Interoperability
- * The minimum PHP version required is now 5.6.
- * Windows CI was added using Appveyor
- * The codebase is now completely covered by Psalm static analysis
- * Test coverage has increased by 3%
-
-### Deprecation
- * Support for SAML1.1 / Shibboleth 1.3 will be discontinued in a future release
- * The class SimpleSAML\Auth\TimeLimitedToken is now deprecated and will be removed in a future release
- If your custom module relies on this class, be sure to make a copy into your repository and
- make sure to also copy the unit tests that come along.
- * Setting 'privacypolicy' in metadata-files will be removed in a future release. It was only used
- by the consent-module, which supports UIInfo's PrivacyStatementURL.
- See https://simplesamlphp.org/docs/stable/simplesamlphp-metadata-extensions-ui on how to configure this.
- * The use of the PHP memcache-extension was deprecated in favour of memcached-extension.
- The former is considered abandoned and it's safe use can no longer be guaranteed.
-
## Version 1.17.6
Released 2019-08-29
diff --git a/docs/simplesamlphp-upgrade-notes-1.18.md b/docs/simplesamlphp-upgrade-notes-1.18.md
index 02daff43d..9638f6216 100644
--- a/docs/simplesamlphp-upgrade-notes-1.18.md
+++ b/docs/simplesamlphp-upgrade-notes-1.18.md
@@ -3,12 +3,24 @@ Upgrade notes for SimpleSAMLphp 1.18
The minimum PHP version required is now PHP 5.6.
-The use of the PHP Memcache-extension was deprecated in favour of the Memcached-extension.
-In order to keep using Memcache-functionality you have to move to the PHP Memchached-extension,
- which is available from PECL; see https://pecl.php.net/package/memcached
+### Deprecations
+
+* The use of the PHP `memcache` extension was deprecated in favour of `memcached`.
+In order to keep using memcache functionality you have to move to the PHP `memchached` extension,
+which is available from PECL; see https://pecl.php.net/package/memcached. The former is considered abandoned
+and it's safe use can no longer be guaranteed.
There are a few options here:
- - Depending on your distribution, the package may just be available to install
- - You could use the package from the REMI-repository if you're on RHEL; https://rpms.remirepo.net/
+ - Depending on your distribution, the package may just be available for you to install
+ - You could use the package from the REMI repository if you're on RHEL; https://rpms.remirepo.net/
- Download the source from https://pecl.php.net/package/memcached and compile the source as a PHP-extension manually;
https://www.php.net/manual/en/install.pecl.phpize.php
+
+* Support for SAML1.1 / Shibboleth 1.3 will be discontinued in a future release.
+* The class `SimpleSAML\Auth\TimeLimitedToken` is now deprecated and will be removed in a future release
+ If your custom module relies on this class, be sure to make a copy into your repository and
+ make sure to also copy the unit tests that come along.
+* Setting `privacypolicy` in metadata files will be removed in a future release. It was only used
+ by the consent module, which supports `UIInfo`'s `PrivacyStatementURL`.
+ See https://simplesamlphp.org/docs/stable/simplesamlphp-metadata-extensions-ui on how to configure this.
+
--
GitLab