Update DEVELOPMENT, CHANGELOG, fix github ci script & remove unne…

…cessary export (#242)

* Update `DEVELOPMENT`, `CHANGELOG` & remove unnecessary export

* Revert changes in package.json

* Update package.json for release & add changes from primary package.json file

* Extend changelog (add strict mode note)

* Fix gitlab workflows (ci wasn't running on release branch)

* Add glint section to readme

* Improve releasing steps

* Remove duplicate changelog / development files

* Update gitignore

.github/workflows/ci.yml

@@ -3,8 +3,7 @@ name: CI
 on:
   push:
     branches:
-      - main
-      - master
+      - 3.x
   pull_request: {}
 
 concurrency:

.github/workflows/push-dist.yml

@@ -8,8 +8,7 @@ name: Push dist
 on:
   push:
     branches:
-      - main
-      - master
+      - 3.x
 
 jobs:
   push-dist:
@@ -29,6 +28,6 @@ jobs:
         run: pnpm install --frozen-lockfile
       - uses: kategengler/put-built-npm-package-contents-on-branch@v2.0.0
         with:
-          branch: dist
+          branch: dist-3.x
           token: ${{ secrets.GITHUB_TOKEN }}
           working-directory: 'ember-fontawesome'

CHANGELOG.md

@@ -5,18 +5,28 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ---
+
 ## [3.0.0](https://github.com/FortAwesome/ember-fontawesome/releases/tag/3.0.0) - 2025-02-03
 
 ### Changed
-* Completely re-worked using Ember Addon blueprint
-* Move FaIcon component to addon folder and old test-filed into test-app (we don't need anymore the rest)
-* Convert addon to TypeScript & glint
-* Change icon import logic like it is in angular or vue package of FA
-* Install fastboot package in test-app, so that we are save that it works also inside fastboot apps (this was never tested since now)
+* Convert addon to an ember v2 addon
+* Convert addon to TypeScript & add glint support
+* Switch component into strict mode
+* Move `@fortawesome/fontawesome-svg-core` to peerDependencies
+* Install fastboot package in test-app, so that we are save that it works also inside fastboot apps
+
+### Removed
+* Drop support for `enableExperimentalBuildTimeTransform` (it was never documented)
+* Option `warnIfNoIconsIncluded` as it was used only in build time code (index.js) which doesn't exists in v2 addons
+* Remove ´config/icons.js` (you need to setup in app.js/ts, see migration process)
 
 ### Fixed
 * Re-add support for ember v3.28
 
 ---
 
+For migration see https://github.com/FortAwesome/ember-fontawesome/pull/239
+
+---
+
 Previous 2.x CHANGELOG available https://github.com/FortAwesome/ember-fontawesome/blob/2.x/CHANGELOG.md

README.md

@@ -186,6 +186,24 @@ library.add(
 );
 ```
 
+### Glint
+
+Update your template registry to extend this addon. Check the [Glint documentation](https://typed-ember.gitbook.io/glint/environments/ember/using-addons#using-glint-enabled-addons) for more information.
+
+```ts
+/* types/global.d.ts */
+
+import '@glint/environment-ember-loose';
+
+import type EmberFontAwesomeRegistry from '@fortawesome/ember-fontawesome/template-registry';
+
+declare module '@glint/environment-ember-loose/registry' {
+  export default interface Registry extends EmberFontAwesomeRegistry, /* other addon registries */ {
+    // local entries
+  }
+}
+```
+
 ### Using within an addon
 
 If you want to use icons in your addon there are a few steps to take.

ember-fontawesome/.gitignore

@@ -3,6 +3,8 @@
 # will also appear in published NPM packages.
 /README.md
 /LICENSE.md
+/CHANGELOG.md
+/DEVELOPMENT.md
 
 # compiled output
 dist/

ember-fontawesome/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@fortawesome/ember-fontawesome",
-  "version": "2.0.0",
-  "description": "Official Ember component for Font Awesome 5 and 6",
+  "version": "3.0.0",
+  "description": "Official Ember component for Font Awesome",
   "keywords": [
     "ember-addon",
     "fontawesome"
@@ -26,7 +26,7 @@
     "Robert Clancy <github.com/robclancy>",
     "Robert Clancy <github.com/maxwondercorn>",
     "Robert Clancy <github.com/dnstld>",
-    "mkszepp <github.com/mkszepp>",
+    "Markus Sanin <github.com/mkszepp>",
     "Davide Ferrero <github.com/davideferre>",
     "Steve <github.com/st-h>",
     "Stefan Topfstedt <github.com/stopfstedt>",
@@ -35,10 +35,6 @@
   ],
   "homepage": "https://github.com/FortAwesome/ember-fontawesome",
   "exports": {
-    ".": {
-      "types": "./declarations/index.d.ts",
-      "default": "./dist/index.js"
-    },
     "./*": {
       "types": "./declarations/*.d.ts",
       "default": "./dist/*.js"

package.json

@@ -1,8 +1,11 @@
 {
-  "private": false,
-  "name": "@fortawesome/ember-fontawesome",
-  "description": "Official Ember component for Font Awesome",
-  "version": "3.0.0",
+  "private": true,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/FortAwesome/ember-fontawesome.git"
+  },
+  "license": "MIT",
+  "author": "",
   "scripts": {
     "build": "pnpm --filter ember-fontawesome build",
     "lint": "pnpm --filter '*' lint",
@@ -13,43 +16,11 @@
     "test": "pnpm --filter '*' test",
     "test:ember": "pnpm --filter '*' test:ember"
   },
-  "keywords": [
-    "ember-addon",
-    "fontawesome"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/FortAwesome/ember-fontawesome.git"
-  },
-  "license": "MIT",
-  "author": "",
-  "contributors": [
-    "Mike Wilkerson <mwilkerson@gmail.com>",
-    "Ilya Radchenko <knownasilya@gmail.com>",
-    "Jonathan Johnson <jon.johnson@ucsf.edu>",
-    "Rob Madole <robmadole@gmail.com>",
-    "Tom Carter <tomc@spiceworks.com>",
-    "Julien Guimont <julien.guimont@gmail.com>",
-    "Xaser Acheron <github.com/XaserAcheron>",
-    "samcic <github.com/samcic>",
-    "Josemar Luedke <github.com/josemarluedke>",
-    "Dan Freeman <github.com/dfreeman>",
-    "Bas Kamer <github.com/basz>",
-    "Robert Clancy <github.com/robclancy>",
-    "Robert Clancy <github.com/maxwondercorn>",
-    "Robert Clancy <github.com/dnstld>",
-    "mkszepp <github.com/mkszepp>",
-    "Davide Ferrero <github.com/davideferre>",
-    "Steve <github.com/st-h>",
-    "Stefan Topfstedt <github.com/stopfstedt>",
-    "François de Metz <github.com/francois2metz>",
-    "NullVoxPopuli <github.com/NullVoxPopuli>"
-  ],
   "packageManager": "pnpm@9.15.4",
   "devDependencies": {
     "@glint/core": "^1.5.2",
     "concurrently": "^9.1.2",
     "prettier": "^3.4.2",
     "prettier-plugin-ember-template-tag": "^2.0.4"
   }
-}
+}