Skip to content

Commit

Permalink
Merge pull request #942 from k7hpn/release/4.3.17
Browse files Browse the repository at this point in the history
Release v4.3.17
  • Loading branch information
k7hpn authored Nov 17, 2022
2 parents 89d0e76 + a035a1b commit 052c2d7
Show file tree
Hide file tree
Showing 24 changed files with 81 additions and 57 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3

- name: Run build.bash
env:
Expand All @@ -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
Expand Down
36 changes: 11 additions & 25 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion appveyor.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 1 addition & 1 deletion dev/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion dev/initial-developer-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
4 changes: 2 additions & 2 deletions manual/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions manual/installation/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The critical settings to provide are the "SqlServer" setting under "ConnectionSt

```json
"ConnectionStrings": {
"SqlServer": "Server=<servername>;Database=<databasename>;user id=<username>;password=<password>;MultipleActiveResultSets=true"
"SqlServer": "Server=<servername>;Database=<databasename>;user id=<username>;password=<password>;MultipleActiveResultSets=true;Encrypt=false"
},
```

Expand Down Expand Up @@ -42,7 +42,7 @@ Here's what your `appsettings.json` file in your `shared` directory might look l
```json
{
"ConnectionStrings": {
"SqlServer": "Server=<servername>;Database=<databasename>;user id=<username>;password=<password>;MultipleActiveResultSets=true"
"SqlServer": "Server=<servername>;Database=<databasename>;user id=<username>;password=<password>;MultipleActiveResultSets=true;Encrypt=false"
},
"GraInitialAuthCode": "<authorizationcode>"
}
Expand Down
4 changes: 2 additions & 2 deletions manual/installation/install-the-software.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.
9 changes: 4 additions & 5 deletions manual/installation/system-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion manual/installation/upgrading.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion manual/technical/appsettings.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
39 changes: 39 additions & 0 deletions re/4.3/Release Notes 4.3.17.md
Original file line number Diff line number Diff line change
@@ -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&rsquo;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).
2 changes: 1 addition & 1 deletion src/GRA.Controllers/GRA.Controllers.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<RepositoryType>Git</RepositoryType>
<RepositoryUrl>https://github.com/mcld/greatreadingadventure/</RepositoryUrl>
<TargetFramework>net6.0</TargetFramework>
<Version>4.3.0</Version>
<Version>4.3.17</Version>
</PropertyGroup>

<ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion src/GRA.Data.SQLite/GRA.Data.SQLite.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<RepositoryType>Git</RepositoryType>
<RepositoryUrl>https://github.com/mcld/greatreadingadventure/</RepositoryUrl>
<TargetFramework>net6.0</TargetFramework>
<Version>4.3.0</Version>
<Version>4.3.17</Version>
</PropertyGroup>

<ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion src/GRA.Data.SqlServer/GRA.Data.SqlServer.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<RepositoryType>Git</RepositoryType>
<RepositoryUrl>https://github.com/mcld/greatreadingadventure/</RepositoryUrl>
<TargetFramework>net6.0</TargetFramework>
<Version>4.3.0</Version>
<Version>4.3.17</Version>
</PropertyGroup>

<ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion src/GRA.Data/GRA.Data.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<RepositoryType>Git</RepositoryType>
<RepositoryUrl>https://github.com/mcld/greatreadingadventure/</RepositoryUrl>
<TargetFramework>net6.0</TargetFramework>
<Version>4.3.0</Version>
<Version>4.3.17</Version>
</PropertyGroup>

<ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion src/GRA.Domain.Model/GRA.Domain.Model.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<RepositoryType>Git</RepositoryType>
<RepositoryUrl>https://github.com/mcld/greatreadingadventure/</RepositoryUrl>
<TargetFramework>netstandard2.1</TargetFramework>
<Version>4.3.0</Version>
<Version>4.3.17</Version>
</PropertyGroup>

<ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion src/GRA.Domain.Report/GRA.Domain.Report.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<RepositoryUrl>https://github.com/mcld/greatreadingadventure/</RepositoryUrl>
<TargetFramework>net6.0</TargetFramework>
<OutputType>Library</OutputType>
<Version>4.3.0</Version>
<Version>4.3.17</Version>
</PropertyGroup>

<ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion src/GRA.Domain.Repository/GRA.Domain.Repository.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<RepositoryType>Git</RepositoryType>
<RepositoryUrl>https://github.com/mcld/greatreadingadventure/</RepositoryUrl>
<TargetFramework>netstandard2.1</TargetFramework>
<Version>4.3.0</Version>
<Version>4.3.17</Version>
</PropertyGroup>

<ItemGroup>
Expand Down
4 changes: 2 additions & 2 deletions src/GRA.Domain.Service/GRA.Domain.Service.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<RepositoryType>Git</RepositoryType>
<RepositoryUrl>https://github.com/mcld/greatreadingadventure/</RepositoryUrl>
<TargetFramework>net6.0</TargetFramework>
<Version>4.3.0</Version>
<Version>4.3.17</Version>
<OutputType>Library</OutputType>
</PropertyGroup>
<ItemGroup>
Expand All @@ -38,7 +38,7 @@

<ItemGroup>
<PackageReference Include="CommonMark.NET" Version="0.15.1" />
<PackageReference Include="CsvHelper" Version="30.0.0" />
<PackageReference Include="CsvHelper" Version="30.0.1" />
<PackageReference Include="ExcelDataReader" Version="3.6.0" />
<PackageReference Include="MailKit" Version="3.4.2" />
<PackageReference Include="MimeKit" Version="3.4.2" />
Expand Down
2 changes: 1 addition & 1 deletion src/GRA.Security/GRA.Security.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<RepositoryType>Git</RepositoryType>
<RepositoryUrl>https://github.com/mcld/greatreadingadventure/</RepositoryUrl>
<TargetFramework>netstandard2.1</TargetFramework>
<Version>4.3.0</Version>
<Version>4.3.17</Version>
</PropertyGroup>

<ItemGroup>
Expand Down
4 changes: 2 additions & 2 deletions src/GRA.Web/GRA.Web.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<TypeScriptCompileBlocked>true</TypeScriptCompileBlocked>
<TypeScriptToolsVersion>Latest</TypeScriptToolsVersion>
<UserSecretsId>gra-e773e45a-3078-4b1b-842d-c7a8f7d310a6</UserSecretsId>
<Version>4.3.0</Version>
<Version>4.3.17</Version>
</PropertyGroup>

<ItemGroup>
Expand Down Expand Up @@ -79,7 +79,7 @@
<PackageReference Include="Serilog.Filters.Expressions" Version="2.1.0" />
<PackageReference Include="Serilog.Sinks.MSSqlServer" Version="6.0.0" />
<PackageReference Include="Serilog.Sinks.RollingFile" Version="3.3.0" />
<PackageReference Include="Serilog.Sinks.Seq" Version="5.2.1" />
<PackageReference Include="Serilog.Sinks.Seq" Version="5.2.2" />
<PackageReference Include="Serilog.Sinks.Slack.Core" Version="0.1.5-beta" />
<PackageReference Include="System.Text.Encodings.Web" Version="6.0.0">
<TreatAsUsed>true</TreatAsUsed>
Expand Down
2 changes: 1 addition & 1 deletion src/GRA/GRA.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<RepositoryType>Git</RepositoryType>
<RepositoryUrl>https://github.com/mcld/greatreadingadventure/</RepositoryUrl>
<TargetFramework>netstandard2.1</TargetFramework>
<Version>4.3.0</Version>
<Version>4.3.17</Version>
</PropertyGroup>

<ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion test/GRA.Test/GRA.Test.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<PropertyGroup>
<TargetFramework>net6.0</TargetFramework>
<IsPackable>false</IsPackable>
<Version>4.3.0</Version>
<Version>4.3.17</Version>
</PropertyGroup>

<ItemGroup>
Expand Down

0 comments on commit 052c2d7

Please sign in to comment.