Skip to content

Latest commit

 

History

History
168 lines (135 loc) · 8.1 KB

CHANGELOG.md

File metadata and controls

168 lines (135 loc) · 8.1 KB
Raw

Miranj Craft Boilerplate Changelog

Release notes for Miranj's Craft Boilerplate starter project.

Unreleased

Craft

  • Added project config for a blank Craft install.
  • Added Blog, Blog Index, Home Page, Pages, and 404 Page Not Found sections.
  • Added Sharing & SEO, Footer, Newsletter, and Google Analytics global sets.
  • Added Page, Blog Post, and Index Page entry types.
  • Added Body field with nested Image, Gallery blocks.
  • Added text fields for common use cases: Label, Plain Text, Simple Text, Rich Text, Summary, and Code.
  • Added asset fields for common use cases: Image, Images.
  • Added lightswitch fields for common use cases: Toggle (Default: off), and Toggle (Default: on).
  • Added links fields for common use cases: Call to Action, Hyperlink, and Legacy URL.
  • Added SEO fields for: title, description, image, and default image.
  • Added filesystems for common use cases: Uploads, Static Assets, Transforms, and Private Uploads.
  • Added asset volumes for common use cases: Images, Documents, Form Submissions, User Photos, and Static Assets.
  • Added custom entry sources for Home Page and Index Pages.
  • Added dynamic entry sources: Updated Recently, Published Recently, Created Recently.
  • Added user permissions groups for Editors, Site Configuration, System Administration, and User Managers.
  • Added a primary site.
  • Added SMTP email config.
  • Updated Craft to 5.5.

System

  • Added the Composer lock file.

3.2.0 - 2024-12-17

Front-end

  • Added generated front-end CSS and JS assets inside the ./web/build folder.
  • Safelisted CSS selectors for common HTML tags in richtext content, as well as typographic frills added by the |typogrify filter.
  • CSS purge task will now ignore dev preview templates when scanning for selectors.

Craft

  • Added custom 404 and 403 error page templates. The 403 page is automatically shown when accessing an entry that is not yet published.
  • Added getPDFCover() macro to _helpers/pdf.
  • Improved handling of SEO page title for a homepage single.
  • Fixed a bug where certain Craft preview pages were getting cached by Nginx FastCGI.
  • Fixed a bug where normaliseRichtext() would process input as Markdown by default.
  • Removed all uses of the deprecated |spaceless filter.
  • Updated Craft to 5.3.

System

  • Prefer importing database dumps via Craft’s db/restore for better robustness.
  • Updated PurgeCSS to 7.0.0, switched to PostCSS plugin based usage.

3.1.0 - 2024-08-28

Front-end

  • Added a barebones site-level header and footer to the base template.
  • Added a barebones placeholder homepage.
  • Added a base layout grid with utility classes for grid areas.
  • Added a base fluid type scale (via Utopia).
  • Added a base fluid spacing scale (via Utopia).
  • Added em based relative units to the spacing scale corresponding to the existing rem scale.
  • Added support for Dark Mode (via the prefers-color-scheme media query).
  • Added hover feedback effect for zoomable images.
  • Added a page at /_views to visualise non-fullpage views such as Teasers, Snippets.
  • Added Alpine.js, alongwith the Collapse plugin.
  • Added icons for some common podcast hosts.
  • Fixed a bug where arbitrary value Tailwind classes with a , would always be purged.
  • Updated Tailwind to 3.4.4.
  • Removed JS based webfont loading workflow (deprecated in favour of font-display).
  • Removed Pjax based navigation (deprecated in favour of Instant.page and upcoming native page transitions).
  • Removed Font Face Observer.
  • Removed Pjax.
  • Removed Topbar.

Craft

  • View routers now also look for section-independent entry type overrides (eg: _page, _article, etc.) in their cascade before falling back to the _default view.
  • Teasers now refer to the primary object variable as element instead of entry.
  • Added heroicon() Twig function to render the SVG version of any Heroicons.
  • Added image and imageNested fields to the Field Library.
  • Added sample Imager X named transforms based preset to the _image component.
  • Added an @icons alias for the public SVG icons folder.
  • The _image component's preset parameter can now directly refer to Imager X named transforms.
  • Added --dark-mode media query to the _image component.
  • Refactored embed component to render an oEmbed plugin field.
  • Logged in users with editing permissions will see a floating “Edit” button when viewing an entry on the front-end.
  • SEOMate meta can now render custom <link> tags via the links key.
  • Added sample code for GA4 data model integration.
  • Enabled the Last Edited By column for Entry sources.
  • Enabled the New Child, and Slug columns for Category sources.
  • Added ProfilePage JSON-LD Schema definition.
  • Improved existing JSON-LD Schema definitions, default templates.
  • Fixed a bug where normaliseRichtext() would process input as Markdown by default.
  • Fixed a bug where Live Previews would not work if the URL included a custom port.
  • Fixed a bug where pagination would not work on any detail view pages.
  • Fixed a bug where images with missing dimensions were causing a page loading failure.
  • Removed New Child, and URI columns for Entry sources, and Date Created for Category sources.
  • Removed Redactor configs.

DevOps

  • Configured CSP headers for CDN content (such as PDFs) to be embeddedable on the primary domain.
  • Added DDEV support for dev environments.
  • Added Ngrok support (via DDEV).

System

  • Switched to new Changelog format showing the unreleased version number, and grouping changes under semantic, audience-based sub-heads.
  • Fixed a bug where Prettier would throw an error when committing the manifest symlink files.

3.0.0 - 2024-07-01

Craft

  • Added Craft 5 compatibility.
  • Added a default HTML Purifier config.
  • Prevent user enumeration on production via the Forgot Password flow.
  • Simplified Redis and App Cache config.
  • Updated Craft to 5.2.
  • Updated Child Me! to 2.2.2.
  • Updated CKEditor to 4.1.0.
  • Updated CP Field Inspect to 2.0.1.
  • Updated Element Index Defaults to 4.0.0.
  • Updated Environment Label to 5.0.0.
  • Updated Field Manager to 4.0.1.
  • Updated Image Resizer to 4.0.0.
  • Updated Imager X to 5.0.1.
  • Updated Minify to 5.0.0.
  • Updated No-Cache to 3.0.2.
  • Updated Obfuscator to 1.2.0.
  • Updated Retcon to 3.1.1.
  • Updated SEOMate to 3.0.0-beta.6.
  • Updated Twig Perversion to 5.0.0.
  • Updated Typogrify to 5.0.1.
  • Removed Inventory.

DevOps

  • Simplified .env config by assigning common default values.
  • Simplified Apache config for dev environments.
  • Refactored custom .env url and path variables to drop the CRAFT_ prefix.
  • Apache dev config is automatically enabled via htaccess in the post-install sequence.

System

  • Added a Changelog to track updates to the boilerplate.
  • Added package-lock.json lockfile to keep track of exact Node packages.
  • Added PHPStan for PHP code quality audits.
  • Updated Gulp to 5.0.0. (#96 via @dependabot)
  • Updated Node version to 20 LTS “Iron”.
  • Updated PostCSS to 8.4.31. (#94 via @dependabot)
  • Updated Prettier to 3.3.2.
  • Updated Prettier PHP plugin to 0.22.2.
  • Updated PHP to 8.2.
  • The Field Library folder will now be purged in the post-install sequence.
  • Removed ./craft setup from the project post-install sequence.
  • Removed legacy and redundant .gitignore rules.

2.0.0

  • Craft 4 starter project.

1.0.0

  • Craft 3 starter project.