Merge pull request #399 from leekelleher/dev/v5.x

Preparing v5.0.0 release

.github/CONTRIBUTING.md

@@ -4,10 +4,10 @@ This project is governed by a [Code of Conduct](CODE_OF_CONDUCT.md).
 
 Before writing any code, [please open an issue](https://github.com/leekelleher/umbraco-contentment/issues), or [let's have a discussion](https://github.com/leekelleher/umbraco-contentment/discussions) about any features or ideas that you may have.
 
-> **No-nos!** Saying this upfront, please do not upgrade any NuGet dependencies and please do not modify any licensing information, e.g. do not update the copyright year.
+> **No-nos!** Saying this upfront, please do not upgrade any NuGet dependencies and please do not modify any licensing information and please do not update the copyright year.
 > I have strong opinions on how I like these to be managed.
 
-Okay, once you have the feature or idea is fleshed out, it's hacking time!
+Okay, once you have discussed an idea or feature... it's hacking time!
 
 1. Fork it
 2. Branch it
@@ -18,7 +18,7 @@ Okay, once you have the feature or idea is fleshed out, it's hacking time!
 7. Pull-request it
 
 > The above is respectively taken from the [Clearwater framework repository](https://github.com/clearwater-rb/clearwater/blob/master/README.md#contributing).<br>
-> Kudos to [Jamie Gaskins](https://github.com/jgaskins) for framing the guidelines so succinctly.
+> Kudos to [Jamie Gaskins](https://github.com/jgaskins) for succinctly framing the process.
 
 
 ### Branching information
@@ -29,14 +29,7 @@ Given there are now multiple versions of Contentment that support multiple versi
 - The [`dev/v1.x`](https://github.com/leekelleher/umbraco-contentment/tree/dev/v1.x) branch is for Contentment **v1.4.x** patch releases, this targets Umbraco **v8.6.1**.
 - The [`dev/v2.x`](https://github.com/leekelleher/umbraco-contentment/tree/dev/v2.x) branch is for Contentment **v2.2.x** patch releases, this targets Umbraco **v8.14.0**.
 - The [`dev/v3.x`](https://github.com/leekelleher/umbraco-contentment/tree/dev/v3.x) branch is for Contentment **v3.4.x** patch releases, this targets both Umbraco **v8.17.0** and **v9.0.0**.
-- The [`dev/v4.x`](https://github.com/leekelleher/umbraco-contentment/tree/dev/v4.x) branch is for Contentment **v4.6.x** (current) releases, this targets Umbraco **v8.17.0**, **v9.5.0**, **v10.0.0**, **v11.0.0**, **v12.0.0** and **v13.0.0**.
-- The [`dev/v5.x`](https://github.com/leekelleher/umbraco-contentment/tree/dev/v5.x) branch is for Contentment **v5.x** (next) releases, this will target Umbraco **v10.3.0**, **v12.0.0** and **v13.0.0**.
-- The `dev/v6.x` branch will be for Contentment **v6.x** (future) releases, this might target Umbraco **v10.3.0**, **v12.0.0**, **v13.0.0** and **v15.0.0**.
-- The `dev/v7.x` branch will be for Contentment **v7.x** (far future) releases, this might target Umbraco **v15.0.0**, **v16.0.0** and **v17.0.0**.
-
-
-### Further reading
-
-I've been thinking a lot about Jeff Geerling's post ["Why I close PRs (OSS project maintainer notes)"](https://www.jeffgeerling.com/blog/2016/why-i-close-prs-oss-project-maintainer-notes) lately.
-If you do submit a PR and feel that I'm closing down the conversation, this is most likely the rationale behind it.
-
+- The [`dev/v4.x`](https://github.com/leekelleher/umbraco-contentment/tree/dev/v4.x) branch is for Contentment **v4.6.x** releases, this targets Umbraco **v8.17.0**, **v9.5.0**, **v10.0.0**, **v11.0.0**, **v12.0.0** and **v13.0.0**.
+- The [`dev/v5.x`](https://github.com/leekelleher/umbraco-contentment/tree/dev/v5.x) branch is for Contentment **v5.x** (current) releases, this will target Umbraco **v13.2.0** only.
+- The `dev/v6.x` branch will be for Contentment **v6.x** (next) releases, this will target Umbraco **v14.0.0**.
+- The `dev/v7.x` branch will be for Contentment **v7.x** (future) releases, this may target Umbraco **v14.0.0**, **v15.0.0**, **v16.0.0** and **v17.0.0**.

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,5 +1,5 @@
 name: "Bug report"
-description: "File a bug report to help us improve."
+description: "File a bug report to help us improve Contentment."
 labels: ["bug-report"]
 assignees:
   - leekelleher
@@ -12,13 +12,13 @@ body:
   id: "contentmentVersion"
   attributes:
     label: "Which Contentment version are you using?"
-    description: "If you are unsure, we'll assume it's the latest version."
+    description: "If you are unsure, let's' assume it's the latest version."
   validations:
     required: true
 - type: input
   id: "umbracoVersion"
   attributes:
-    label: "Which Umbraco version are you using? For example: 10.3.2 - don't just write v10"
+    label: "Which Umbraco version are you using? For example: 13.2.1 - don't just write v13"
     description: "Use the help icon in the Umbraco backoffice to find the version you're using."
   validations:
     required: true
@@ -67,7 +67,7 @@ body:
     label: What browsers are you seeing the problem on?
     multiple: true
     options:
-      - Firefox
       - Chrome
+      - Edge
+      - Firefox
       - Safari
-      - Microsoft Edge

.github/README.md

@@ -18,6 +18,7 @@ Some components may be innovative, others may be a reimagining of existing compo
 I'm sharing my code with the world. It is your choice (and responsibility) whether you would like to use it.
 No pressure or marketing spin from me.
 
+**Please do keep in mind that the Contentment for Umbraco package is not a business, it's a hobby project.**
 
 #### What's on offer?
 
@@ -53,12 +54,13 @@ Downloads are available on the [releases page](../releases).
 
 _**Please note...**_
 
-- v4.x supports **Umbraco v8.17.0** (on .NET 4.7.2), **Umbraco v10** (on .NET 6.0),  **Umbraco v11/v12** (on .NET 7.0) and  **Umbraco v13** (on .NET 8.0).
+- v5.x supports **Umbraco v13.2.0  ** (on .NET 8.0), it will work on the latest Umbraco v13.x releases.
+- v4.x supports **Umbraco v8.17.0** (.NET 4.7.2), **Umbraco v10** (.NET 6.0),  **Umbraco v12** (.NET 7.0) and **Umbraco v13** (.NET 8.0), _it mostly likely works on v9 and v11 too._
 - v3.x supports **Umbraco v8.17.0** and **Umbraco v9.0.0**, it will work on latest Umbraco v8.x and v9.x releases.
 - v2.x supports **Umbraco v8.14.0**, it will still work on latest Umbraco v8.x releases.
 - v1.x supports **Umbraco v8.6.1**, it will still work on latest Umbraco v8.x releases.
 
-With Contentment v3+ on Umbraco v9+ (.NET 5+), you can only install a package from the [NuGet package repository](https://www.nuget.org/packages/Our.Umbraco.Community.Contentment). For Umbraco v8.x, the package can still be installed from either [Our Umbraco](https://our.umbraco.com/packages/backoffice-extensions/contentment/) or NuGet package repositories.
+With Contentment v5, if you require support for Umbraco v8/v9/v10/v11/v12, please use Contentment v4.
 
 To understand more about which Umbraco CMS versions are actively supported by Umbraco HQ, please see [Umbraco's Long-term Support (LTS) and End-of-Life (EOL) policy](https://umbraco.com/products/knowledge-center/long-term-support-and-end-of-life/).
 
@@ -68,18 +70,7 @@ To [install from NuGet](https://www.nuget.org/packages/Umbraco.Community.Content
 
     dotnet add package Umbraco.Community.Contentment
 
-> Please note, that the [`Umbraco.Community.Contentment`](https://www.nuget.org/packages/Umbraco.Community.Contentment) NuGet package is a placeholder package for future releases, it contains a dependency on two other packages, [`Our.Umbraco.Community.Contentment`](https://www.nuget.org/packages/Our.Umbraco.Community.Contentment) _(containing the web assets)_, and [`Our.Umbraco.Community.Contentment.Core`](https://www.nuget.org/packages/Our.Umbraco.Community.Contentment.Core/) _(containing the assembly code libraries)_.
-
-##### Our Umbraco package repository
-
-If you are using Umbraco v8.x, and prefer to install Contentment from the backoffice, the package can be downloaded from the Our Umbraco package repository:
-
-> <https://our.umbraco.com/packages/backoffice-extensions/contentment/>
-
-
-#### Demo website
-
-[A demo website is available for testing purposes.](../src/Umbraco.Cms.10.x/README.md) _(Please note, you will need to clone the repository and run locally.)_
+> Please note, that the [`Umbraco.Community.Contentment`](https://www.nuget.org/packages/Umbraco.Community.Contentment) NuGet package is the main package for ongoing releases. If you are referencing one of the older NuGet packages, e.g. [`Our.Umbraco.Community.Contentment`](https://www.nuget.org/packages/Our.Umbraco.Community.Contentment) or [`Our.Umbraco.Community.Contentment.Core`](https://www.nuget.org/packages/Our.Umbraco.Community.Contentment.Core/), then please update your package references to use [`Umbraco.Community.Contentment`](https://www.nuget.org/packages/Umbraco.Community.Contentment).
 
 
 ### [Documentation](../docs/)
@@ -95,9 +86,7 @@ _Let's call those "life's little surprises"._
 - **Data List**
   - When using the **Umbraco Content** data source with an XPath query, inside a Nested Content or Block List editors, it will not be able to identify the contextual containing node ID. e.g. your XPath query will not work. [See #30 for details.](https://github.com/leekelleher/umbraco-contentment/issues/30)
   - When using the **Umbraco Content** data source with an XPath query that contains a `$` prefix parameter, the preview will not display the items. [See #120 for details.](https://github.com/leekelleher/umbraco-contentment/issues/120)
-  - With Umbraco v10 (Contentment v4), **SQL** data source does not support querying SQLite, _(yet!)_ [See #258 for details.](https://github.com/leekelleher/umbraco-contentment/issues/258)
-- **.NET Publish with .NET 6 (or newer)**
-  - When using .NET Publish with .NET 6 (or newer versions of .NET). [See #361 for details](https://github.com/leekelleher/umbraco-contentment/issues/361).
+
 
 ### [Roadmap](ROADMAP.md)
 
@@ -106,7 +95,7 @@ If you would like to know what is coming up in future releases, then take a look
 
 ### Support
 
-I've been doing open source for a long time. I have suffered my fair share of burnout and empathy fatigue.
+I'll try to help the best I can, but I've been doing open source for a long time, and I have suffered my fair share of burnout and empathy fatigue.
 
 I reserve the right to address bug reports or feature requests **in my own time**, or ignore them completely.
 
@@ -118,7 +107,7 @@ Ask for help on the [Our Umbraco support forum](https://our.umbraco.com/), or th
 
 ### Contributions, collaborations, rules of engagement
 
-If you would like to contribute to this project, please [start a discussion](https://github.com/leekelleher/umbraco-contentment/discussions/new/choose) before spending time and energy on a pull request. Your time is precious too.
+If you would like to contribute to this project, please [start a discussion](https://github.com/leekelleher/umbraco-contentment/discussions/new/choose) before spending time and energy on a pull request. Your time is precious.
 
 Please make sure that you read the [CONTRIBUTING](CONTRIBUTING.md) guidelines.
 
@@ -140,7 +129,7 @@ All source code is licensed under the [Mozilla Public License](../LICENSE).
 <summary><strong>A note about licensing</strong></summary>
 
 Historically, I used the [MIT license](https://opensource.org/licenses/MIT) for my open-source projects, regretfully I no longer feel MIT reflects my spirit of encouraging open source collaboration.
-The main difference with the [Mozilla Public License](https://opensource.org/licenses/MPL-2.0) is that if you make any modifications to the source code, then you **must** make those changes publicly available.
+The main difference with the [Mozilla Public License](https://opensource.org/licenses/MPL-2.0) is that if you make any modifications to the source code **and** distribute those modifications, then you **must** make those changes publicly available.
 
 _More give, less take._
 
@@ -154,12 +143,12 @@ For more information about the **Mozilla Public License**, please visit: <https:
 
 #### Developers
 
-- [Lee Kelleher](https://leekelleher.com) - ([GitHub](https://github.com/leekelleher), [Mastodon](https://mastodon.social/@leekelleher), [Twitter](https://twitter.com/leekelleher))
+- [Lee Kelleher](https://leekelleher.com) - ([GitHub](https://github.com/leekelleher), [Mastodon](https://umbracocommunity.social/@lee))
 
 <details>
-<summary>Current development effort: <b>~1,802+ hours</b> (between 2019-03-13 to 2023-12-03)</summary>
+<summary>Current development effort: <b>~1,840+ hours</b> (between 2019-03-13 to 2024-04-19)</summary>
 
-_To give you an idea of how much human developer time/effort has been put into making this package._
+_To give you an idea of how much human developer time/effort has been put into making and maintaining this package._
 
 </details>
 

.github/ROADMAP.md

@@ -130,15 +130,18 @@ Property Editors are:
 
 ## v5
 
-- Removes support for Umbraco 8 (.NET Framework 4.7.2), Umbraco 9 (.NET 5) and Umbraco 11 (.NET 7).
+### [v5.0](https://github.com/leekelleher/umbraco-contentment/releases/tag/5.0.0)
+
+- Removes support for previous Umbraco versions: Umbraco 8 (.NET Framework 4.7.2), Umbraco 9 (.NET 5), Umbraco 10 (.NET 6) and Umbraco 11 and 12 (.NET 7).
+- Supports Umbraco 13 (.NET 8) only.
 - Converts package to be a Razor Class Library, _(e.g. web assets are served from NuGet package)._
 
 
 ## v6
 
-- [Support for the new Umbraco backoffice, aka Bellissima](https://github.com/leekelleher/umbraco-contentment/issues/316).
-- _Adds support for Umbraco 15 (.NET 9)._
-- _I'm still deciding whether to remove support for Umbraco 10 (.NET 6), Umbraco 12 (.NET 7) and Umbraco 13 (.NET 8)._ :thinking:
+- [Support for the new Umbraco backoffice, aka Bellissima](https://github.com/leekelleher/umbraco-contentment/discussions/357).
+- Adds support for Umbraco 14 (.NET 8) _aka Bellissima_.
+- Removes support for Umbraco 13 (.NET 8).
 
 
 ## v7
@@ -150,4 +153,4 @@ Property Editors are:
 
 _Who knows?!_ `¯\_(ツ)_/¯`
 
-**I have [a bunch of ideas](IDEAS.md)**, or [suggest your own idea?](https://github.com/leekelleher/umbraco-contentment/discussions/new?category=ideas)
+...or [suggest your own idea?](https://github.com/leekelleher/umbraco-contentment/discussions/new?category=ideas)

.gitignore

@@ -9,6 +9,7 @@ _ReSharper.*
 Thumbs.db
 .DS_Store
 *.log
+.idea
 .vs
 node_modules/
 
@@ -20,5 +21,6 @@ build/build-push-umb.ps1
 src/packages/*/**
 src/Umbraco.Cms.*.x/*
 src/Umbraco.Community.Contentment/wwwroot/App_Plugins/Contentment/*
-src/Umbraco.Community.Contentment.StaticAssets/*
+src/Umbraco.Community.Contentment.StaticAssets/wwwroot/App_Plugins/Contentment/*
+src/*/node_modules/*
 tools/*.exe

VERSION

@@ -1 +1 @@
-4.7.0
+5.0.0