From 8c0da98eb73137c5d2e6cb3db1b94d11d6e82e5c Mon Sep 17 00:00:00 2001
From: Simon Vieille <simon.vieille@trinaps.com>
Date: Thu, 6 Apr 2023 20:24:51 +0200
Subject: [PATCH] add changelog

---
 bin/changelog-generator    | 102 +++++++++++
 docs/changelog/core.md     | 337 +++++++++++++++++++++++++++++++++++++
 docs/changelog/skeleton.md | 303 +++++++++++++++++++++++++++++++++
 mkdocs.yml                 |  12 ++
 4 files changed, 754 insertions(+)
 create mode 100755 bin/changelog-generator
 create mode 100644 docs/changelog/core.md
 create mode 100644 docs/changelog/skeleton.md

diff --git a/bin/changelog-generator b/bin/changelog-generator
new file mode 100755
index 0000000..c3b1db0
--- /dev/null
+++ b/bin/changelog-generator
@@ -0,0 +1,102 @@
+#!/bin/sh
+
+usage() {
+	printf "Usage: %s [-h] -f /path/to/CHANGELOG.md\n" "$0"
+}
+
+help() {
+    cat << EOH
+ SYNOPSIS
+    $0 [-h] -f /path/to/CHANGELOG.md
+
+ DESCRIPTION
+
+    $0 generates a markdown content of a changelog file.
+
+ OPTIONS
+
+    -h    Show this help
+
+    -f FILE
+	      Path to changelog
+EOH
+}
+
+on_interrupt() {
+	print "Process aborted!\n"
+
+	exit 130
+}
+
+main() {
+	while getopts "hf:" option; do
+		case "${option}" in
+			h) help; exit 0;;
+			f) CHANGELOG_FILE="$OPTARG";;
+			*) usage; exit 1;;
+		esac
+	done
+
+	if [ -z "$CHANGELOG_FILE" ]; then
+		printf "The file of the changelog is required.\n"
+		exit 1
+	fi
+
+	if [ ! -f "$CHANGELOG_FILE" ]; then
+		printf "No such file: %s\n" "$CHANGELOG_FILE"
+		exit 1
+	fi
+
+	temp_directory="$(mktemp -d)"
+	version=
+	is_first=1
+
+	cat << EOF
+---
+hide:
+  - toc
+---
+
+# Changelog
+
+EOF
+
+
+	while read -r line; do
+		if printf "%s" "$line" | grep -q -E '^## '; then
+			version="$(printf "%s" "$line" | sed 's/^## //')"
+
+			if [ "$version" = "[Unreleased]" ]; then
+				version=""
+			fi
+		elif [ -n "$version" ]; then
+			printf "%s\n" "$line" >> "$temp_directory/$version"
+		fi
+	done < "$CHANGELOG_FILE"
+
+	while read -r line; do
+		if printf "%s" "$line" | grep -q -E '^## '; then
+			version="$(printf "%s" "$line" | sed 's/^## //')"
+
+			if [ "$version" != "[Unreleased]" ]; then
+				if [ $is_first -eq 1 ]; then
+					printf "???+ success \"%s\"\n" "$version"
+					is_first=0
+				else
+					printf "??? abstract \"%s\"\n" "$version"
+				fi
+
+				sed \
+					-e 's/### \(.*\)/\n    **\1**\n/g' \
+					-e 's/^/    /g' \
+					"$temp_directory/$version"
+			fi
+		fi
+	done < "$CHANGELOG_FILE"
+
+	exit 0
+}
+
+trap on_interrupt INT
+
+main "$@"
diff --git a/docs/changelog/core.md b/docs/changelog/core.md
new file mode 100644
index 0000000..8a67788
--- /dev/null
+++ b/docs/changelog/core.md
@@ -0,0 +1,337 @@
+---
+hide:
+  - toc
+---
+
+# Changelog
+
+???+ success "[1.18.0] - 2023-01-13"
+    
+    **Added**
+
+    * feat(dep): add symfony/runtime
+    * feat(dep): add symfony/flex
+    
+    **Fixed**
+
+    * fix(crud): allow POST in delete actions
+    * fix(crud): remove default page value in abstract crud controller
+    * fix(admin): test site_logo before using it
+    * fix(ui): update z-index of choices__list--dropdown
+    
+??? abstract "[1.17.1] - 2022-12-03"
+    
+    **Fixed**
+
+    * add mising attribute on timestampable (doctrine)
+    
+??? abstract "[1.17.0] - 2022-11-19"
+    
+    **Fixed**
+
+    * fix tinymce modal z-index in tox
+    
+    **Changed**
+
+    * replace annotation with attributes
+    
+??? abstract "[1.16.0] - 2022-09-06"
+    
+    **Added**
+
+    * add A/B testing feature
+    * add cleanup of html string extracted from grapesjs content
+    
+    **Fixed**
+
+    * fix file block type
+    
+    **Changed**
+
+    * remove dashboard action from the core
+    
+??? abstract "[1.15.0] - 2022-05-09"
+    
+    **Added**
+
+    * CrudConfiguration::setAction can receive a callable instead of a boolean in 'enabled' param
+    * add grapesjs-component-code-editor and grapesjs-parser-postcss
+    * hide the backoffice site name when small resolution
+    * add entity_to_array twig function
+    * add default field to show in crud configuration
+    
+    **Fixed**
+
+    * fix the mail notifier
+    * fix sitemap: navigation with several domains
+    * fix regression with editorjs: content not loaded
+    
+    **Changed**
+
+    * change default template to show an entity using `entity_to_array`
+    
+??? abstract "[1.14.1] - 2022-04-30"
+    
+    **Added**
+
+    * add allowed chars in RouteParameterSlugify and CodeSlugify
+    * improve sidebar in mobile view
+    
+    **Fixed**
+
+    * fix creation of new element when a menu is edited
+    * fix editorjs error when the textarea is empty
+    
+??? abstract "[1.14.0] - 2022-04-20"
+    
+    **Added**
+
+    * add grapesjs modes
+    * add tinymce block type
+    * add editor types in page maker
+    * add the page template when the page is generated with the maker
+    
+    **Changed**
+
+    * replace flag-icon-css with flag-icons
+    
+??? abstract "[1.13.0] - 2022-04-17"
+    
+    **Added**
+
+    * add editorjs hyperlink block
+    * add button to show and hide metas (admin)
+    * add grapesjs editor
+    * add editorjs type
+    
+    **Fixed**
+
+    * fix editorjs inline tools (bold and italic)
+    
+    **Changed**
+
+    * update editorjs quote block template
+    
+??? abstract "[1.12.0] - 2022-03-26"
+    
+    **Added**
+
+    * add page maker command (`make:page`)
+    * add CrudConfiguration::getViewData in complement of CrudConfiguration::getViewDatas
+    * add editorjs link block endpoint
+    
+    **Fixed**
+
+    * fix issue with empty user-agent in AnalyticListener
+    
+    **Changed**
+
+    * update editorjs image block view
+    
+??? abstract "[1.11.0] - 2022-03-22"
+    
+    **Added**
+
+    * add data-modal-create attribute to force modal to be open in a new container
+    * add blur when several modals are opened
+    * add specific form types for Tinymce and EditorJS
+    
+    **Changed**
+
+    * update file-manager with data-modal-create attribute
+    
+??? abstract "[1.10.0] - 2022-03-17"
+    
+    **Added**
+
+    * add url and path generators using code (twig)
+    
+    **Changed**
+
+    * update node entity constraints
+    
+??? abstract "[1.9.2] - 2022-03-14"
+    
+    **Fixed**
+
+    * fix issue with murph version constant and autoloader
+    
+??? abstract "[1.9.1] - 2022-03-14"
+    
+    **Added**
+
+    * add murph version in autoload file
+    
+    **Changed**
+
+    * remove AdminController constructor
+    
+??? abstract "[1.9.0] - 2022-03-13"
+    
+    **Added**
+
+    * add murph version in admin ui
+    
+    **Changed**
+
+    * the core is now installed with composer
+    
+??? abstract "[1.8.0] - 2022-03-10"
+    
+    **Added**
+
+    * add security roles in app configuration
+    * add option to restrict node access to specific roles
+    
+    **Changed**
+
+    * rename `core/EventSuscriber` with `core/EventSubscriber`
+    
+??? abstract "[1.7.3] - 2022-03-06"
+    
+    **Added**
+
+    * add ability to rename file in the file manager
+    
+    **Fixed**
+
+    * fix user factory
+    * fix user creation from ui
+    
+??? abstract "[1.7.2] - 2022-03-03"
+    
+    **Added**
+
+    * add templates to render sections and items in the admin menu
+    
+    **Fixed**
+
+    * fix the analytic table when a path is a long
+    
+??? abstract "[1.7.1] - 2022-03-01"
+    
+    **Added**
+
+    * add translations
+    
+    **Fixed**
+
+    * fix missing directories
+    
+??? abstract "[1.7.0] - 2022-03-01"
+    
+    **Fixed**
+
+    * fix the analytic referers table when a referer has a long domain
+    
+    **Changed**
+
+    * upgrade dependencies
+    * move assets to the core directory
+    
+??? abstract "[1.6.0] - 2022-02-28"
+    
+    **Added**
+
+    * add block in field templates to allow override
+    * merge route params in crud admin redirects
+    * improve murph:user:create command
+    
+    
+    **Fixed**
+
+    * fix form namespace prefix in the crud controller maker
+    * fix date field when the value is empty
+    * fix crud batch column width
+    * fix sidebar icon width
+    * fix cache clear task
+    
+    
+    **Changed**
+
+    * remove password generation from the user factory
+    
+??? abstract "[1.5.0] - 2022-02-25"
+    
+    **Added**
+
+    * add desktop views and mobile views
+    
+    
+    **Changed**
+
+    * upgrade dependencies
+    * replace jaybizzle/crawler-detect with matomo/device-detector
+    
+??? abstract "[1.4.1] - 2022-02-23"
+    
+    **Added**
+
+    * handle app urls in twig routing filters
+    
+    
+    **Fixed**
+
+    * fix views in analytics modal
+    * replace empty path with "/" in analytics
+    
+    **Changed**
+
+    * update default templates
+    
+??? abstract "[1.4.0] - 2022-02-21"
+    
+    **Added**
+
+    * add basic analytics
+    
+??? abstract "[1.3.0] - 2022-02-19"
+    
+    **Added**
+
+    * add support of regexp with substitution in redirect
+    * url tags can be used as redirect location
+    * add builders to replace file information tags and url tags
+    
+    
+    **Fixed**
+
+    * fix filemanager sorting
+    * fix batch action setter
+    
+??? abstract "[1.2.0] - 2022-02-14"
+    
+    **Added**
+
+    * add sort in file manager
+    * add redirect manager
+    
+    
+    **Changed**
+
+    * replace node-sass with sass
+    
+??? abstract "[1.1.0] - 2022-02-29"
+    
+    **Added**
+
+    * add directory upload in file manager
+    
+    
+    **Fixed**
+
+    * fix admin node routing
+    
+    
+    **Changed**
+
+    * symfony/swiftmailer-bundle is replaced by symfony/mailer
+    
+??? abstract "[1.0.1] - 2022-02-25"
+    
+    **Fixed**
+
+    * fix Makefile environment vars (renaming)
+    * fix composer minimum stability
+    
+??? abstract "[1.0.0] - 2022-01-23"
diff --git a/docs/changelog/skeleton.md b/docs/changelog/skeleton.md
new file mode 100644
index 0000000..c58c6c9
--- /dev/null
+++ b/docs/changelog/skeleton.md
@@ -0,0 +1,303 @@
+---
+hide:
+  - toc
+---
+
+# Changelog
+
+???+ success "[1.18.0] 2023-01-13"
+    
+    **Added**
+
+    * feat(dep): update dependencies
+    * feat(update): apply new recipe for phpunit
+    * feat(update): apply recipes:update doctrine/doctrine-bundle
+    * feat(update): apply recipes:update doctrine/doctrine-migrations-bundle
+    * feat(update): apply recipes:update liip/imagine-bundle
+    * feat(update): apply recipes:update stof/doctrine-extensions-bundle
+    * feat(update): apply recipes:update symfony/apache-pack
+    * feat(update): apply recipes:update symfony/console
+    * feat(update): apply recipes:update symfony/debug-bundle
+    * feat(update): apply recipes:update symfony/flex
+    * feat(update): apply recipes:update symfony/mailer
+    * feat(update): apply recipes:update symfony/framework-bundle
+    * feat(update): apply recipes:update symfony/monolog-bundle
+    * feat(update): apply recipes:update symfony/routing
+    * feat(update): apply recipes:update symfony/security-bundle
+    * feat(update): apply recipes:update symfony/translation
+    * feat(update): apply recipes:update symfony/twig-bundle
+    * feat(update): apply recipes:update symfony/validator
+    * feat(update): apply recipes:update symfony/web-profiler-bundle
+    * feat(update): apply recipes:update symfony/webpack-encore-bundle
+    * feat(update): apply recipes:update scheb/2fa-bundle
+    
+    **Fixed**
+
+    * fix(config): fix typo in 2fa conf
+    * fix(config): fix firewall config
+    
+    
+??? abstract "[1.17.0] 2022-11-19"
+    
+    **Changed**
+
+    * upgrade murph/murph-core
+    * replace annotation with attributes
+    * use encore from node_modules in npm scripts
+    
+??? abstract "[1.16.0]"
+    
+    **Added**
+
+    * add a admin dashboard controller
+    * add meta description in base.html.twig
+    
+    **Fixed**
+
+    
+    **Changed**
+
+    * upgrade murph/murph-core
+    
+??? abstract "[1.15.0]"
+    
+    **Changed**
+
+    * upgrade murph/murph-core
+    
+??? abstract "[1.14.3]"
+    
+    **Added**
+
+    * add blocks in default template
+    
+    **Changed**
+
+    * upgrade murph/murph-core
+    
+??? abstract "[1.14.2]"
+    
+??? abstract "[1.14.1]"
+    
+    **Fixed**
+
+    * fix missing envvar in makefile (npm)
+    
+??? abstract "[1.14.0]"
+    
+    **Changed**
+
+    * upgrade murph/murph-core
+    
+??? abstract "[1.13.0]"
+    
+    **Changed**
+
+    * upgrade murph/murph-core
+    
+??? abstract "[1.12.0]"
+    
+    **Changed**
+
+    * upgrade murph/murph-core
+    
+??? abstract "[1.11.0]"
+    
+    **Changed**
+
+    * upgrade murph/murph-core
+    * use murph-npm to install npm requirements
+    
+??? abstract "[1.10.0]"
+    
+    **Added**
+
+    * add translated title in dashboard template
+    
+    **Fixed**
+
+    * remove useless env var from makefile
+    
+    **Changed**
+
+    * upgrade murph/murph-core
+    
+??? abstract "[1.9.1] - 2022-03-14"
+    
+    **Added**
+
+    * add murph version in autoload file
+    
+    **Changed**
+
+    * remove AdminController constructor
+    
+??? abstract "[1.9.0] - 2022-03-13"
+    
+    **Added**
+
+    * add murph version in admin ui
+    
+    **Changed**
+
+    * the core is now installed with composer
+    
+??? abstract "[1.8.0] - 2022-03-10"
+    
+    **Added**
+
+    * add security roles in app configuration
+    * add option to restrict node access to specific roles
+    
+    **Changed**
+
+    * rename `core/EventSuscriber` with `core/EventSubscriber`
+    
+??? abstract "[1.7.3] - 2022-03-06"
+    
+    **Added**
+
+    * add ability to rename file in the file manager
+    
+    **Fixed**
+
+    * fix user factory
+    * fix user creation from ui
+    
+??? abstract "[1.7.2] - 2022-03-03"
+    
+    **Added**
+
+    * add templates to render sections and items in the admin menu
+    
+    **Fixed**
+
+    * fix the analytic table when a path is a long
+    
+??? abstract "[1.7.1] - 2022-03-01"
+    
+    **Added**
+
+    * add translations
+    
+    **Fixed**
+
+    * fix missing directories
+    
+??? abstract "[1.7.0] - 2022-03-01"
+    
+    **Fixed**
+
+    * fix the analytic referers table when a referer has a long domain
+    
+    **Changed**
+
+    * upgrade dependencies
+    * move assets to the core directory
+    
+??? abstract "[1.6.0] - 2022-02-28"
+    
+    **Added**
+
+    * add block in field templates to allow override
+    * merge route params in crud admin redirects
+    * improve murph:user:create command
+    
+    
+    **Fixed**
+
+    * fix form namespace prefix in the crud controller maker
+    * fix date field when the value is empty
+    * fix crud batch column width
+    * fix sidebar icon width
+    * fix cache clear task
+    
+    
+    **Changed**
+
+    * remove password generation from the user factory
+    
+??? abstract "[1.5.0] - 2022-02-25"
+    
+    **Added**
+
+    * add desktop views and mobile views
+    
+    
+    **Changed**
+
+    * upgrade dependencies
+    * replace jaybizzle/crawler-detect with matomo/device-detector
+    
+??? abstract "[1.4.1] - 2022-02-23"
+    
+    **Added**
+
+    * handle app urls in twig routing filters
+    
+    
+    **Fixed**
+
+    * fix views in analytics modal
+    * replace empty path with "/" in analytics
+    
+    **Changed**
+
+    * update default templates
+    
+??? abstract "[1.4.0] - 2022-02-21"
+    
+    **Added**
+
+    * add basic analytics
+    
+??? abstract "[1.3.0] - 2022-02-19"
+    
+    **Added**
+
+    * add support of regexp with substitution in redirect
+    * url tags can be used as redirect location
+    * add builders to replace file information tags and url tags
+    
+    
+    **Fixed**
+
+    * fix filemanager sorting
+    * fix batch action setter
+    
+??? abstract "[1.2.0] - 2022-02-14"
+    
+    **Added**
+
+    * add sort in file manager
+    * add redirect manager
+    
+    
+    **Changed**
+
+    * replace node-sass with sass
+    
+??? abstract "[1.1.0] - 2022-02-29"
+    
+    **Added**
+
+    * add directory upload in file manager
+    
+    
+    **Fixed**
+
+    * fix admin node routing
+    
+    
+    **Changed**
+
+    * symfony/swiftmailer-bundle is replaced by symfony/mailer
+    
+??? abstract "[1.0.1] - 2022-02-25"
+    
+    **Fixed**
+
+    * fix Makefile environment vars (renaming)
+    * fix composer minimum stability
+    
+??? abstract "[1.0.0] - 2022-01-23"
diff --git a/mkdocs.yml b/mkdocs.yml
index ec83f15..b295365 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -34,6 +34,8 @@ theme:
         name: Passer en mode clair
 
 markdown_extensions:
+  - extra
+  - admonition
   - pymdownx.highlight:
       anchor_linenums: true
       extend_pygments_lang:
@@ -43,10 +45,17 @@ markdown_extensions:
             startinline: true
   - pymdownx.tabbed:
       alternate_style: true
+  - pymdownx.magiclink
   - pymdownx.snippets
   - pymdownx.superfences
   - pymdownx.highlight
   - pymdownx.inlinehilite
+  - pymdownx.details
+  - attr_list
+  - md_in_html
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
 
 nav:
   - Overview:
@@ -89,3 +98,6 @@ nav:
     - "A/B Testing": abtesting.md
     - Users: users.md
     - Tasks: tasks.md
+  - Changelog:
+    - "murph/murph-core": changelog/core.md
+    - "murph/murph-skeleton": changelog/skeleton.md