From a035a1b833e13676b2f251f07fd03ed27dd97e75 Mon Sep 17 00:00:00 2001 From: Harald Nagel Date: Thu, 17 Nov 2022 13:33:25 -0700 Subject: [PATCH] Release v4.3.17 --- .github/workflows/build.yml | 4 +- CHANGELOG.md | 36 ++++++----------- appveyor.yml | 2 +- dev/README.md | 2 +- dev/initial-developer-setup.md | 2 +- manual/conf.py | 4 +- manual/installation/configuration.md | 4 +- manual/installation/install-the-software.md | 4 +- manual/installation/system-requirements.md | 9 ++--- manual/installation/upgrading.md | 2 +- manual/technical/appsettings.md | 2 +- re/4.3/Release Notes 4.3.17.md | 39 +++++++++++++++++++ src/GRA.Controllers/GRA.Controllers.csproj | 2 +- src/GRA.Data.SQLite/GRA.Data.SQLite.csproj | 2 +- .../GRA.Data.SqlServer.csproj | 2 +- src/GRA.Data/GRA.Data.csproj | 2 +- src/GRA.Domain.Model/GRA.Domain.Model.csproj | 2 +- .../GRA.Domain.Report.csproj | 2 +- .../GRA.Domain.Repository.csproj | 2 +- .../GRA.Domain.Service.csproj | 4 +- src/GRA.Security/GRA.Security.csproj | 2 +- src/GRA.Web/GRA.Web.csproj | 4 +- src/GRA/GRA.csproj | 2 +- test/GRA.Test/GRA.Test.csproj | 2 +- 24 files changed, 81 insertions(+), 57 deletions(-) create mode 100644 re/4.3/Release Notes 4.3.17.md diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 4b77796aa..bf946ff73 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -8,7 +8,7 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Run build.bash env: @@ -21,7 +21,7 @@ jobs: GHCR_USER: ${{secrets.GHCR_USER}} run: ./build.bash -p - - uses: actions/upload-artifact@v2 + - uses: actions/upload-artifact@v3 with: name: Great Reading Adventure path: package/GreatReadingAdventure-*.zip diff --git a/CHANGELOG.md b/CHANGELOG.md index 2efe6fb4d..2ae2c24d6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,31 +4,7 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/). -## Unreleased - -### Added - -- Ability to mark vendor items as not damaged and not missing in case of accidental box checking -- Ability to disable the in-software mail capability -- Report to see a count of pending vendor code items per branch -- Program-wide alert to dashboard page - -### Changed - -- Moved TempData storage to session from separate cookie -- Updated Remaining Vendor Prize Pick-Up to separate out first/last names and username -- Import of avatar file will overwrite any files in teh avatar directories - -### Fixed - -- Expiration of social card cache -- Site setting categories in Mission Control are now in alphabetical order - -### Updated - -### Removed - -## 4.2.2 +## [4.3.17] 2022-11-17 ### Added @@ -44,6 +20,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/). - Ability to configure minimum worker threads and completion port threads - Featured challenge group scheduling and display carousel - Show reasons on MC participant history page as to why items cannot be deleted +- Ability to mark vendor items as not damaged and not missing in case of accidental box checking +- Ability to disable the in-software mail capability +- Report to see a count of pending vendor code items per branch +- Program-wide alert to dashboard page ### Changed @@ -53,6 +33,9 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/). - Vendor item status display on participants profile - Show wrench menu to all who have Mission Control access - Upgrade from ASP.NET v5.0 to v6.0 +- Moved TempData storage to session from separate cookie +- Updated Remaining Vendor Prize Pick-Up to separate out first/last names and username +- Import of avatar file will overwrite any files in teh avatar directories ### Fixed @@ -76,6 +59,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/). - Check for null viewmodel on some posts - Bug with empty username in UsernameInUseAsync - Allow deletion of events even if participants have favorited them +- Expiration of social card cache +- Site setting categories in Mission Control are now in alphabetical order ### Updated @@ -389,6 +374,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/). - Everything! First release of 4.0. +[4.3.17]: https://github.com/mcld/greatreadingadventure/tree/v4.3.17 [4.2.1]: https://github.com/mcld/greatreadingadventure/tree/v4.2.1 [4.2.0]: https://github.com/mcld/greatreadingadventure/tree/v4.2.0 [4.1.1]: https://github.com/mcld/greatreadingadventure/tree/v4.1.1 diff --git a/appveyor.yml b/appveyor.yml index f2b10a651..d106938bb 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -1,4 +1,4 @@ -version: 4.2.1-build{build} +version: 4.3.17-build{build} image: Visual Studio 2022 clone_depth: 1 before_build: diff --git a/dev/README.md b/dev/README.md index 7038f9f97..7c0872e1d 100644 --- a/dev/README.md +++ b/dev/README.md @@ -6,7 +6,7 @@ GRA code should successfully compile using either the free [Visual Studio Code]( Framework history: -- Current work (version 4.3.0 and on) use [.NET 6.0](https://docs.microsoft.com/en-us/dotnet/core/whats-new/dotnet-6) +- Current work (versions 4.3.x) use [.NET 6.0](https://docs.microsoft.com/en-us/dotnet/core/whats-new/dotnet-6) - Versions 4.2 and 4.2.1 use [.NET 5.0](https://docs.microsoft.com/en-us/dotnet/core/whats-new/dotnet-5) - Version 4.1.1 used ASP.NET Core v2.2 - Version 4.1.0 used ASP.NET Core v2.1 diff --git a/dev/initial-developer-setup.md b/dev/initial-developer-setup.md index c6ed1ea0b..8aa10d513 100644 --- a/dev/initial-developer-setup.md +++ b/dev/initial-developer-setup.md @@ -2,7 +2,7 @@ ## Development environment -- Windows, macOS: [Visual Studio 2019](https://www.visualstudio.com/vs/) +- Windows, macOS: [Visual Studio 2022](https://www.visualstudio.com/vs/) - Linux, macOS, Windows: [Visual Studio Code](https://code.visualstudio.com/) - Ensure you [install the C# extension](https://code.visualstudio.com/docs/runtimes/dotnet) diff --git a/manual/conf.py b/manual/conf.py index df2247cb0..f83ce3f3b 100644 --- a/manual/conf.py +++ b/manual/conf.py @@ -66,9 +66,9 @@ # built documents. # # The short X.Y version. -version = '4.1' +version = '4.3' # The full version, including alpha/beta/rc tags. -release = '4.1' +release = '4.3' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/manual/installation/configuration.md b/manual/installation/configuration.md index d35a6fab1..00e546ddc 100644 --- a/manual/installation/configuration.md +++ b/manual/installation/configuration.md @@ -12,7 +12,7 @@ The critical settings to provide are the "SqlServer" setting under "ConnectionSt ```json "ConnectionStrings": { - "SqlServer": "Server=;Database=;user id=;password=;MultipleActiveResultSets=true" + "SqlServer": "Server=;Database=;user id=;password=;MultipleActiveResultSets=true;Encrypt=false" }, ``` @@ -42,7 +42,7 @@ Here's what your `appsettings.json` file in your `shared` directory might look l ```json { "ConnectionStrings": { - "SqlServer": "Server=;Database=;user id=;password=;MultipleActiveResultSets=true" + "SqlServer": "Server=;Database=;user id=;password=;MultipleActiveResultSets=true;Encrypt=false" }, "GraInitialAuthCode": "" } diff --git a/manual/installation/install-the-software.md b/manual/installation/install-the-software.md index 83f8abda3..145c47cd3 100644 --- a/manual/installation/install-the-software.md +++ b/manual/installation/install-the-software.md @@ -28,7 +28,7 @@ Note: if you see this message in the logs: "A connection was successfully establ ## Install and run the GRA on a Windows Server The GRA is an ASP.NET Core application so review the [Host ASP.NET Core on Windows with IIS -](https://docs.microsoft.com/en-us/aspnet/core/host-and-deploy/iis/?view=aspnetcore-5.0) instructions from Microsoft and ensure that IIS is installed with the Web Sockets feature enabled and the appropriate ASP.NET Core hosting bundle is installed. +](https://docs.microsoft.com/en-us/aspnet/core/host-and-deploy/iis/?view=aspnetcore-6.0) instructions from Microsoft and ensure that IIS is installed with the Web Sockets feature enabled and the appropriate ASP.NET Core hosting bundle is installed. ### Set up the GRA as the only site on the server @@ -87,4 +87,4 @@ Your system administrator can help you select the correct approach. 4. Are you sure the `shared` directory has write permissions for the process running IIS? Once the application starts, it will create a "logs" directory there so you will know if the Web server can write to this directory once you see the "logs" directory present. Check that "logs" directory to see if there are any errors written out to the log file. 5. Do you see something in the logs about "A connection was successfully established with the server, but then an error occurred during the pre-login handshake"? Try adding `Encrypt=false;` to the end of your SQL Server connection string. 6. If the Web process can write to the `shared` directory, you can edit the `Web.config` file `aspNetCore` tag to set `stdoutLogEnabled="true"` and `stdoutLogFile=".\shared\stdout"`. When you restart IIS it should write a log file starting with "stdout" that you can examine to see if any errors are being written to it. -7. Microsoft's [Troubleshoot ASP.NET Core on IIS](https://docs.microsoft.com/en-us/aspnet/core/test/troubleshoot-azure-iis?view=aspnetcore-5.0) page will walk you through some typical troubleshooting steps. +7. Microsoft's [Troubleshoot ASP.NET Core on IIS](https://docs.microsoft.com/en-us/aspnet/core/test/troubleshoot-azure-iis?view=aspnetcore-6.0) page will walk you through some typical troubleshooting steps. diff --git a/manual/installation/system-requirements.md b/manual/installation/system-requirements.md index 59bc81e43..d0fcdb428 100644 --- a/manual/installation/system-requirements.md +++ b/manual/installation/system-requirements.md @@ -6,18 +6,17 @@ The GRA requires the following services to run. These services may all be hosted ### Web server requirements -Version 4 of the GRA runs in the [Microsoft .NET 5.0](https://dotnet.microsoft.com/download) runtime environment. Downloads of the runtime environment are available from Microsoft for the following operating systems: +Version 4 of the GRA runs in the [Microsoft .NET 6.0](https://dotnet.microsoft.com/download) runtime environment. Downloads of the runtime environment are available from Microsoft for the following operating systems: - macOS - Linux - Windows -To host in a Windows environment you'll need the [ASP.NET Core Hosting Bundle](https://docs.microsoft.com/en-us/aspnet/core/host-and-deploy/iis/?view=aspnetcore-5.0), for other environments you will need to install the appropriate runtime. +To host in a Windows environment you'll need the [ASP.NET Core Hosting Bundle](https://docs.microsoft.com/en-us/aspnet/core/host-and-deploy/iis/?view=aspnetcore-6.0), for other environments you will need to install the appropriate runtime. -ASP.NET Core applications can be run behind a reverse proxy or directly connected to the Internet using the built-in ASP.NET Core [Kestrel Web server](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/servers/kestrel?view=aspnetcore-5.0). +ASP.NET Core applications can be run behind a reverse proxy or directly connected to the Internet using the built-in ASP.NET Core [Kestrel Web server](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/servers/kestrel?view=aspnetcore-6.0). -- To host with IIS, [Windows Server 2012 R2 or later is supported](https://docs.microsoft.com/en-us/aspnet/core/host-and-deploy/iis/?view=aspnetcore-5.0). Note that currently GRA reporting utilizes Web Sockets and in a Windows environment that requires IIS 8 and Windows Server 2012. -- To host with [Apache](https://docs.microsoft.com/en-us/aspnet/core/host-and-deploy/linux-apache?view=aspnetcore-5.0) or [Nginx](https://docs.microsoft.com/en-us/aspnet/core/host-and-deploy/linux-nginx?view=aspnetcore-5.0), a version of Linux which supports .NET 5.0 should be selected. +- To host with IIS, [Windows Server 2012 R2 or later is supported](https://docs.microsoft.com/en-us/aspnet/core/host-and-deploy/iis/?view=aspnetcore-6.0). Note that currently GRA reporting utilizes Web Sockets and in a Windows environment that requires IIS 8 and Windows Server 2012. To host with [Apache](https://docs.microsoft.com/en-us/aspnet/core/host-and-deploy/linux-apache?view=aspnetcore-6.0) or [Nginx](https://docs.microsoft.com/en-us/aspnet/core/host-and-deploy/linux-nginx?view=aspnetcore-6.0), a version of Linux which supports .NET 6.0 should be selected. ### Docker server requirements diff --git a/manual/installation/upgrading.md b/manual/installation/upgrading.md index 70a9c889b..94138d803 100644 --- a/manual/installation/upgrading.md +++ b/manual/installation/upgrading.md @@ -1,6 +1,6 @@ # Upgrading -**There is no upgrade path from versions 2 or 3 to this release** due to significant architectural changes. Follow these instructions to upgrade from a previous release of version 4. When upgrading from version to 4.2 note that you'll need to ensure you have the appropriate version of the [ASP.NET Core Hosting Bundle](https://docs.microsoft.com/en-us/aspnet/core/host-and-deploy/iis/?view=aspnetcore-5.0) on the server. +**There is no upgrade path from versions 2 or 3 to this release** due to significant architectural changes. Follow these instructions to upgrade from a previous release of version 4. When upgrading from version to 4.3 note that you'll need to ensure you have the appropriate version of the [ASP.NET Core Hosting Bundle](https://docs.microsoft.com/en-us/aspnet/core/host-and-deploy/iis/?view=aspnetcore-6.0) on the server. Note that during the upgrade there will be an interruption in service so it may be ideal to schedule this upgrade in off hours. diff --git a/manual/technical/appsettings.md b/manual/technical/appsettings.md index dfb39bbc5..b01be68fb 100644 --- a/manual/technical/appsettings.md +++ b/manual/technical/appsettings.md @@ -10,7 +10,7 @@ Environment settings can be passed in via Docker using the `-e` commandline opti ``` TZ=US/Arizona -ConnectionStrings:SqlServer=Server=dbserver;Database=catalog;user id=user;password=password;MultipleActiveResultSets=true +ConnectionStrings:SqlServer=Server=dbserver;Database=catalog;user id=user;password=password;MultipleActiveResultSets=true;Encrypt=false GraInitialAuthCode=secretAdminCode GraDefaultSiteName=Awesome Reading Program GraDefaultPageTitle=Awesome Reading Program - Our Library diff --git a/re/4.3/Release Notes 4.3.17.md b/re/4.3/Release Notes 4.3.17.md new file mode 100644 index 000000000..15399895a --- /dev/null +++ b/re/4.3/Release Notes 4.3.17.md @@ -0,0 +1,39 @@ +## Release Notes: 4.3.17 + +### Introduction + +The Great Reading Adventure is a robust, open source software designed to manage library reading programs. The GRA is free to use, modify, and share. Check out [www.greatreadingadventure.com](http://www.greatreadingadventure.com/) for an overview of its functionality and capabilities. + +### Release + +These release notes accompany **[:books: The Great Reading Adventure version 4.3.17](https://github.com/MCLD/greatreadingadventure/releases/download/v4.3.17/GreatReadingAdventure-4.3.17.zip)** which can be downloaded from GitHub or run in Docker from the [Docker Hub](https://hub.docker.com/r/mcld/gra) or the [GitHub Packages](https://github.com/MCLD/greatreadingadventure/pkgs/container/gra). + +### Upgrading + +If you wish to upgrade from a previous release of version 4 see the [upgrading section](http://manual.greatreadingadventure.com/en/v4.3/installation/upgrading/) of the manual. There is no upgrade path from versions 2 or 3 to this release due to significant architectural changes. + +### Documentation + +For information on what is required to run the Great Reading Adventure, please refer to the [online manual](http://manual.greatreadingadventure.com/en/v4.3/). The software requires a [hosting environment including Microsoft .NET 6.0 and Microsoft SQL Server](http://manual.greatreadingadventure.com/en/v4.3/installation/system-requirements/). If you don’t have such an environment, there are plenty of Web hosting services you can use. + +### Changes in this release + +Here are some notable changes: + +- Update framework to ASP.NET 6.0 +- Fully-integrate email templating and sending +- Add challenge sorting options (most recent, most popular) and category colors +- Add challenge groups +- Show reasons in Mission Control why user history items cannot be deleted +- Add ability to set a program-wide alert on the dashboard page +- Site setting to show secret code on streaming event pages +- Allow administrative toggle of avatar sharing, mail +- Additional vendor code reports and packing slip functionality +- Fix social card cache expirations +- Improve front-end packaging for stylesheets and scripts + +For more detailed information about changes in this release please review the [change log](https://github.com/MCLD/greatreadingadventure/blob/v4.3.17/CHANGELOG.md). + +### Known issues + +For up-to-date information about known issues please refer to [the discussions](https://github.com/MCLD/greatreadingadventure/discussions) and the GitHub [issue list](https://github.com/MCLD/greatreadingadventure/issues). diff --git a/src/GRA.Controllers/GRA.Controllers.csproj b/src/GRA.Controllers/GRA.Controllers.csproj index 11d3bdcc6..bcf2c3b60 100644 --- a/src/GRA.Controllers/GRA.Controllers.csproj +++ b/src/GRA.Controllers/GRA.Controllers.csproj @@ -17,7 +17,7 @@ Git https://github.com/mcld/greatreadingadventure/ net6.0 - 4.3.0 + 4.3.17 diff --git a/src/GRA.Data.SQLite/GRA.Data.SQLite.csproj b/src/GRA.Data.SQLite/GRA.Data.SQLite.csproj index 78caa51d0..ea1d5b99d 100644 --- a/src/GRA.Data.SQLite/GRA.Data.SQLite.csproj +++ b/src/GRA.Data.SQLite/GRA.Data.SQLite.csproj @@ -16,7 +16,7 @@ Git https://github.com/mcld/greatreadingadventure/ net6.0 - 4.3.0 + 4.3.17 diff --git a/src/GRA.Data.SqlServer/GRA.Data.SqlServer.csproj b/src/GRA.Data.SqlServer/GRA.Data.SqlServer.csproj index 7743a3bba..aa2cfcb97 100644 --- a/src/GRA.Data.SqlServer/GRA.Data.SqlServer.csproj +++ b/src/GRA.Data.SqlServer/GRA.Data.SqlServer.csproj @@ -16,7 +16,7 @@ Git https://github.com/mcld/greatreadingadventure/ net6.0 - 4.3.0 + 4.3.17 diff --git a/src/GRA.Data/GRA.Data.csproj b/src/GRA.Data/GRA.Data.csproj index ea43e262d..e21cc864b 100644 --- a/src/GRA.Data/GRA.Data.csproj +++ b/src/GRA.Data/GRA.Data.csproj @@ -17,7 +17,7 @@ Git https://github.com/mcld/greatreadingadventure/ net6.0 - 4.3.0 + 4.3.17 diff --git a/src/GRA.Domain.Model/GRA.Domain.Model.csproj b/src/GRA.Domain.Model/GRA.Domain.Model.csproj index 5cd54f354..f997560f0 100644 --- a/src/GRA.Domain.Model/GRA.Domain.Model.csproj +++ b/src/GRA.Domain.Model/GRA.Domain.Model.csproj @@ -16,7 +16,7 @@ Git https://github.com/mcld/greatreadingadventure/ netstandard2.1 - 4.3.0 + 4.3.17 diff --git a/src/GRA.Domain.Report/GRA.Domain.Report.csproj b/src/GRA.Domain.Report/GRA.Domain.Report.csproj index d4daa1034..6e6df1f4e 100644 --- a/src/GRA.Domain.Report/GRA.Domain.Report.csproj +++ b/src/GRA.Domain.Report/GRA.Domain.Report.csproj @@ -15,7 +15,7 @@ https://github.com/mcld/greatreadingadventure/ net6.0 Library - 4.3.0 + 4.3.17 diff --git a/src/GRA.Domain.Repository/GRA.Domain.Repository.csproj b/src/GRA.Domain.Repository/GRA.Domain.Repository.csproj index ad7ab1f43..3a565a5b7 100644 --- a/src/GRA.Domain.Repository/GRA.Domain.Repository.csproj +++ b/src/GRA.Domain.Repository/GRA.Domain.Repository.csproj @@ -17,7 +17,7 @@ Git https://github.com/mcld/greatreadingadventure/ netstandard2.1 - 4.3.0 + 4.3.17 diff --git a/src/GRA.Domain.Service/GRA.Domain.Service.csproj b/src/GRA.Domain.Service/GRA.Domain.Service.csproj index d9c00752d..095a67cff 100644 --- a/src/GRA.Domain.Service/GRA.Domain.Service.csproj +++ b/src/GRA.Domain.Service/GRA.Domain.Service.csproj @@ -17,7 +17,7 @@ Git https://github.com/mcld/greatreadingadventure/ net6.0 - 4.3.0 + 4.3.17 Library @@ -38,7 +38,7 @@ - + diff --git a/src/GRA.Security/GRA.Security.csproj b/src/GRA.Security/GRA.Security.csproj index 78cb2cc17..98656acf6 100644 --- a/src/GRA.Security/GRA.Security.csproj +++ b/src/GRA.Security/GRA.Security.csproj @@ -16,7 +16,7 @@ Git https://github.com/mcld/greatreadingadventure/ netstandard2.1 - 4.3.0 + 4.3.17 diff --git a/src/GRA.Web/GRA.Web.csproj b/src/GRA.Web/GRA.Web.csproj index 686e79ca8..a407dbbd8 100644 --- a/src/GRA.Web/GRA.Web.csproj +++ b/src/GRA.Web/GRA.Web.csproj @@ -24,7 +24,7 @@ true Latest gra-e773e45a-3078-4b1b-842d-c7a8f7d310a6 - 4.3.0 + 4.3.17 @@ -79,7 +79,7 @@ - + true diff --git a/src/GRA/GRA.csproj b/src/GRA/GRA.csproj index 17b1ff785..76be42190 100644 --- a/src/GRA/GRA.csproj +++ b/src/GRA/GRA.csproj @@ -16,7 +16,7 @@ Git https://github.com/mcld/greatreadingadventure/ netstandard2.1 - 4.3.0 + 4.3.17 diff --git a/test/GRA.Test/GRA.Test.csproj b/test/GRA.Test/GRA.Test.csproj index 64919b32d..8bd2e9087 100644 --- a/test/GRA.Test/GRA.Test.csproj +++ b/test/GRA.Test/GRA.Test.csproj @@ -3,7 +3,7 @@ net6.0 false - 4.3.0 + 4.3.17