From 7908ae3942c94d33febcd69733593797a1fc5f5b Mon Sep 17 00:00:00 2001
From: Eliot Berriot <contact@eliotberriot.com>
Date: Sun, 6 May 2018 16:24:12 +0200
Subject: [PATCH] Version bump and changelog
---
CHANGELOG | 105 ++++++++++++++++++++
api/funkwhale_api/__init__.py | 2 +-
changes/changelog.d/109.enhancement | 1 -
changes/changelog.d/176.enhancement | 1 -
changes/changelog.d/178.doc | 1 -
changes/changelog.d/180.doc | 1 -
changes/changelog.d/182.bugfix | 1 -
changes/changelog.d/183.bugfix | 1 -
changes/changelog.d/183.enhancement | 1 -
changes/changelog.d/184.bugfix | 1 -
changes/changelog.d/185.doc | 1 -
changes/changelog.d/186.enhancement | 24 -----
changes/changelog.d/187.feature | 24 -----
changes/changelog.d/189.bugfix | 1 -
changes/changelog.d/actor-fetch.enhancement | 1 -
changes/changelog.d/apache.enhancement | 1 -
changes/changelog.d/optimization.doc | 11 --
changes/changelog.d/sidebar.enhancement | 1 -
18 files changed, 106 insertions(+), 73 deletions(-)
delete mode 100644 changes/changelog.d/109.enhancement
delete mode 100644 changes/changelog.d/176.enhancement
delete mode 100644 changes/changelog.d/178.doc
delete mode 100644 changes/changelog.d/180.doc
delete mode 100644 changes/changelog.d/182.bugfix
delete mode 100644 changes/changelog.d/183.bugfix
delete mode 100644 changes/changelog.d/183.enhancement
delete mode 100644 changes/changelog.d/184.bugfix
delete mode 100644 changes/changelog.d/185.doc
delete mode 100644 changes/changelog.d/186.enhancement
delete mode 100644 changes/changelog.d/187.feature
delete mode 100644 changes/changelog.d/189.bugfix
delete mode 100644 changes/changelog.d/actor-fetch.enhancement
delete mode 100644 changes/changelog.d/apache.enhancement
delete mode 100644 changes/changelog.d/optimization.doc
delete mode 100644 changes/changelog.d/sidebar.enhancement
diff --git a/CHANGELOG b/CHANGELOG
index a9d92f50cf..82c867bf89 100644
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -10,6 +10,111 @@ This changelog is viewable on the web at https://docs.funkwhale.audio/changelog.
.. towncrier
+0.11 (unreleased)
+-----------------
+
+Upgrade instructions are available at https://docs.funkwhale.audio/upgrading.html
+
+Special thanks for this release go to @renon:matrix.org (@Hazmo on Gitlab)
+for bringing Apache2 support to Funkwhale and contributing on other issues.
+Thank you!
+
+Features:
+
+- Funkwhale now works behind an Apache2 reverse proxy (!165)
+ check out the brand new documentation at https://docs.funkwhale.audio/installation/index.html#apache2
+ if you want to try it!
+- Users can now request password reset by email, assuming a SMTP server was
+ correctly configured (#187)
+
+Enhancements:
+
+- Added a fix_track_files command to run checks and fixes against library
+ (#183)
+- Avoid fetching Actor object on every request authentication
+- Can now relaunch errored jobs and batches (#176)
+- List pending requests by default, added a status filter for requests (#109)
+- More structured menus in sidebar, added labels with notifications
+- Sample virtual-host file for Apache2 reverse-proxy (!165)
+- Store high-level settings (such as federation or auth-related ones) in
+ database (#186)
+
+
+Bugfixes:
+
+- Ensure in place imported files get a proper mimetype (#183)
+- Federation cache suppression is now simpler and also deletes orphaned files
+ (#189)
+- Fixed small UI glitches/bugs in federation tabs (#184)
+- X-sendfile not working with in place import (#182)
+
+
+Documentation:
+
+- Added a documentation area for third-party projects (#180)
+- Added documentation for optimizing Funkwhale and reduce its memory footprint.
+- Document that the database should use an utf-8 encoding (#185)
+- Foundations for API documentation with Swagger (#178)
+
+
+Database storage for high-level settings
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Due to the work done in #186, the following environment variables have been
+deprecated:
+
+- FEDERATION_ENABLED
+- FEDERATION_COLLECTION_PAGE_SIZE
+- FEDERATION_MUSIC_NEEDS_APPROVAL
+- FEDERATION_ACTOR_FETCH_DELAY
+- PLAYLISTS_MAX_TRACKS
+- API_AUTHENTICATION_REQUIRED
+
+Configuration for this settings has been moved to database, as it will provide
+a better user-experience, by allowing you to edit these values on-the-fly,
+without restarting Funkwhale processes.
+
+You can leave those environment variables in your .env file for now, as the
+values will be used to populate the database entries. We'll make a proper
+announcement when the variables won't be used anymore.
+
+Please browse https://docs.funkwhale.audio/configuration.html#instance-settings
+for more information about instance configuration using the web interface.
+
+
+System emails
+^^^^^^^^^^^^^
+
+Starting from this release, Funkwhale will send two types
+of emails:
+
+- Email confirmation emails, to ensure a user's email is valid
+- Password reset emails, enabling user to reset their password without an admin's intervention
+
+Email sending is disabled by default, as it requires additional configuration.
+In this mode, emails are simply outputed on stdout.
+
+If you want to actually send those emails to your users, you should edit your
+.env file and tweak the EMAIL_CONFIG variable. See :ref:`setting-EMAIL_CONFIG`
+for more details.
+
+.. note::
+
+ As a result of these changes, the DJANGO_EMAIL_BACKEND variable,
+ which was not documented, has no effect anymore. You can safely remove it from
+ your .env file if it is set.
+
+
+Proxy headers for non-docker deployments
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+For non-docker deployments, add ``--proxy-headers`` at the end of the ``daphne``
+command in :file:`/etc/systemd/system/funkwhale-server.service`.
+
+This will ensure the application receive the correct IP address from the client
+and not the proxy's one.
+
+
0.10 (2018-04-23)
-----------------
diff --git a/api/funkwhale_api/__init__.py b/api/funkwhale_api/__init__.py
index 5969269191..4f62dd9b5b 100644
--- a/api/funkwhale_api/__init__.py
+++ b/api/funkwhale_api/__init__.py
@@ -1,3 +1,3 @@
# -*- coding: utf-8 -*-
-__version__ = '0.10'
+__version__ = '0.11'
__version_info__ = tuple([int(num) if num.isdigit() else num for num in __version__.replace('-', '.', 1).split('.')])
diff --git a/changes/changelog.d/109.enhancement b/changes/changelog.d/109.enhancement
deleted file mode 100644
index 60e740d738..0000000000
--- a/changes/changelog.d/109.enhancement
+++ /dev/null
@@ -1 +0,0 @@
-List pending requests by default, added a status filter for requests (#109)
diff --git a/changes/changelog.d/176.enhancement b/changes/changelog.d/176.enhancement
deleted file mode 100644
index 874aed7275..0000000000
--- a/changes/changelog.d/176.enhancement
+++ /dev/null
@@ -1 +0,0 @@
-Can now relaunch errored jobs and batches (#176)
diff --git a/changes/changelog.d/178.doc b/changes/changelog.d/178.doc
deleted file mode 100644
index 419e6984b8..0000000000
--- a/changes/changelog.d/178.doc
+++ /dev/null
@@ -1 +0,0 @@
-Foundations for API documentation with Swagger (#178)
diff --git a/changes/changelog.d/180.doc b/changes/changelog.d/180.doc
deleted file mode 100644
index ee79f3e3f9..0000000000
--- a/changes/changelog.d/180.doc
+++ /dev/null
@@ -1 +0,0 @@
-Added a documentation area for third-party projects (#180)
diff --git a/changes/changelog.d/182.bugfix b/changes/changelog.d/182.bugfix
deleted file mode 100644
index 6a880c4b02..0000000000
--- a/changes/changelog.d/182.bugfix
+++ /dev/null
@@ -1 +0,0 @@
-X-sendfile not working with in place import (#182)
diff --git a/changes/changelog.d/183.bugfix b/changes/changelog.d/183.bugfix
deleted file mode 100644
index 03a28e9c39..0000000000
--- a/changes/changelog.d/183.bugfix
+++ /dev/null
@@ -1 +0,0 @@
-Ensure in place imported files get a proper mimetype (#183)
diff --git a/changes/changelog.d/183.enhancement b/changes/changelog.d/183.enhancement
deleted file mode 100644
index 2549db810c..0000000000
--- a/changes/changelog.d/183.enhancement
+++ /dev/null
@@ -1 +0,0 @@
-Added a fix_track_files command to run checks and fixes against library (#183)
diff --git a/changes/changelog.d/184.bugfix b/changes/changelog.d/184.bugfix
deleted file mode 100644
index 354b691db2..0000000000
--- a/changes/changelog.d/184.bugfix
+++ /dev/null
@@ -1 +0,0 @@
-Fixed small UI glitches/bugs in federation tabs (#184)
diff --git a/changes/changelog.d/185.doc b/changes/changelog.d/185.doc
deleted file mode 100644
index 72144e343d..0000000000
--- a/changes/changelog.d/185.doc
+++ /dev/null
@@ -1 +0,0 @@
-Document that the database should use an utf-8 encoding (#185)
diff --git a/changes/changelog.d/186.enhancement b/changes/changelog.d/186.enhancement
deleted file mode 100644
index 36777c7865..0000000000
--- a/changes/changelog.d/186.enhancement
+++ /dev/null
@@ -1,24 +0,0 @@
-Store high-level settings (such as federation or auth-related ones) in database (#186)
-
-Changelog
-^^^^^^^^^
-Due to the work done in #186, the following environment variables have been
-deprecated:
-
-- FEDERATION_ENABLED
-- FEDERATION_COLLECTION_PAGE_SIZE
-- FEDERATION_MUSIC_NEEDS_APPROVAL
-- FEDERATION_ACTOR_FETCH_DELAY
-- PLAYLISTS_MAX_TRACKS
-- API_AUTHENTICATION_REQUIRED
-
-Configuration for this settings has been moved to database, as it will provide
-a better user-experience, by allowing you to edit these values on-the-fly,
-without restarting Funkwhale processes.
-
-You can leave those environment variables in your .env file for now, as the
-values will be used to populate the database entries. We'll make a proper
-announcement when the variables won't be used anymore.
-
-Please browse https://docs.funkwhale.audio/configuration.html#instance-settings
-for more information about instance configuration using the web interface.
diff --git a/changes/changelog.d/187.feature b/changes/changelog.d/187.feature
deleted file mode 100644
index 501331a193..0000000000
--- a/changes/changelog.d/187.feature
+++ /dev/null
@@ -1,24 +0,0 @@
-Users can now request password reset by email, assuming
-a SMTP server was correctly configured (#187)
-
-Update
-^^^^^^
-
-Starting from this release, Funkwhale will send two types
-of emails:
-
-- Email confirmation emails, to ensure a user's email is valid
-- Password reset emails, enabling user to reset their password without an admin's intervention
-
-Email sending is disabled by default, as it requires additional configuration.
-In this mode, emails are simply outputed on stdout.
-
-If you want to actually send those emails to your users, you should edit your
-.env file and tweak the EMAIL_CONFIG variable. See :ref:`setting-EMAIL_CONFIG`
-for more details.
-
-.. note::
-
- As a result of these changes, the DJANGO_EMAIL_BACKEND variable,
- which was not documented, has no effect anymore. You can safely remove it from
- your .env file if it is set.
diff --git a/changes/changelog.d/189.bugfix b/changes/changelog.d/189.bugfix
deleted file mode 100644
index 076058e636..0000000000
--- a/changes/changelog.d/189.bugfix
+++ /dev/null
@@ -1 +0,0 @@
-Federation cache suppression is now simpler and also deletes orphaned files (#189)
diff --git a/changes/changelog.d/actor-fetch.enhancement b/changes/changelog.d/actor-fetch.enhancement
deleted file mode 100644
index 17f3a88df2..0000000000
--- a/changes/changelog.d/actor-fetch.enhancement
+++ /dev/null
@@ -1 +0,0 @@
-Avoid fetching Actor object on every request authentication
diff --git a/changes/changelog.d/apache.enhancement b/changes/changelog.d/apache.enhancement
deleted file mode 100644
index 5aa4338051..0000000000
--- a/changes/changelog.d/apache.enhancement
+++ /dev/null
@@ -1 +0,0 @@
-Sample virtual-host file for Apache2 reverse-proxy (!165)
diff --git a/changes/changelog.d/optimization.doc b/changes/changelog.d/optimization.doc
deleted file mode 100644
index 929e148210..0000000000
--- a/changes/changelog.d/optimization.doc
+++ /dev/null
@@ -1,11 +0,0 @@
-Added documentation for optimizing Funkwhale and reduce its memory
-footprint.
-
-Changelog
-^^^^^^^^^
-
-For non-docker deployments, add ``--proxy-headers`` at the end of the ``daphne``
-command in :file:`/etc/systemd/system/funkwhale-server.service`.
-
-This will ensure the application receive the correct IP address from the client
-and not the proxy's one.
diff --git a/changes/changelog.d/sidebar.enhancement b/changes/changelog.d/sidebar.enhancement
deleted file mode 100644
index 1bc1a482f6..0000000000
--- a/changes/changelog.d/sidebar.enhancement
+++ /dev/null
@@ -1 +0,0 @@
-More structured menus in sidebar, added labels with notifications
--
GitLab