Merge pull request #64 from Kibibit/release/new-main-release

Release/new main release
Kibibit · Oct 21, 2023 · ba3a992 · ba3a992
2 parents 93cc85c + cb029fc
commit ba3a992
Show file tree

Hide file tree

Showing 15 changed files with 27,319 additions and 15,225 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,45 @@
+name: Release
+on:
+  push:
+    branches:
+      - master
+      - next
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Commit
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.BOT_TOKEN }}
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+      - name: Cache node modules
+        uses: actions/cache@v3
+        env:
+          cache-name: cache-node-modules
+        with:
+          path: "**/node_modules"
+          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: ${{ runner.os }}-modules-${{ hashFiles('**/package-lock.lock') }}
+      - name: Install Dependencies
+        if: steps.cache-node-modules.outputs.cache-hit != 'true'
+        run: npm ci
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.BOT_TOKEN }}
+      - name: Build
+        run: npm run build --if-present
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.BOT_TOKEN }}
+          GIT_AUTHOR_NAME: k1b1b0t
+          GIT_AUTHOR_EMAIL: k1b1b0t@kibibit.io
+          GIT_COMMITTER_NAME: k1b1b0t
+          GIT_COMMITTER_EMAIL: k1b1b0t@kibibit.io
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.BOT_TOKEN }}
+        run: npm run semantic-release
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -5,7 +5,7 @@
   "editor.tabSize": 2,
   "editor.rulers": [80],
   "editor.fontFamily": "Hack, Menlo, Monaco, 'Courier New', monospace",
-  "editor.matchBrackets": true,
+  "editor.matchBrackets": "always",
   // Terminal
   "terminal.integrated.fontFamily": "Hack, Menlo, Monaco, 'Courier New', monospace",
   "terminal.integrated.fontSize": 12,

diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 <p align="center">
-  <a href="https://github.com/Kibibit/kb-hologram" target="blank"><img src="./hologram.svg" width="150" ></a>
+  <a href="https://github.com/Kibibit/kb-hologram" target="blank"><img src="http://kibibit.io/kibibit-assets/kb-hologram/logo.svg" width="150" ></a>
   <h2 align="center">
     @kibibit/kb-hologram
   </h2>
@@ -36,44 +36,46 @@ $ npm install --save @kibibit/kb-hologram
 ### Usage
 
 ```javascript
-import { SvgMaker, SvgMakerResultType } from '@kibibit/kb-hologram';
-
-const svgMaker = new SvgMaker({
-      fontName: '../Comfortaa-Regular.ttf',
-      templateName: 'changelog-template',
-      height: 534 * 2,
-      width: 1069 * 2,
-      data: {
-        columnOne: [
-          'Compact folders in Explorer',
-          'Edit both files in diff view',
-          'Search results update while typing',
-          'Problems panel filtering by type',
-          'Minimap highlights errors, changes',
-          'Terminal minimum contrast ratio'
-        ],
-        columnTwo: [
-          'Mirror cursor in HTML tags',
-          'Optional chaining support in JS\\TS',
-          'Extract to interface TS refactoring',
-          'Sass module support for @use',
-          'Remote - Containers improvements',
-          'Visual Studio Online preview'
-        ],
-        title: 'achievibit',
-        subtitle: 'v2.1.4 - CHANGELOG',
-        logo: {
-          url: 'data:image/png;base64,<icon-data>',
-          alt: 'kibibit'
-        }
-      },
-      type: 'html'
-    });
-
-    const pngBuffer = await svgMaker
-      .render(SvgMakerResultType.PngBuffer);
+import { KbHologram, KbHologramResultType } from "@kibibit/kb-hologram";
+
+const kbHologram = new KbHologram({
+  fontName: "../Comfortaa-Regular.ttf",
+  templateName: "changelog-template",
+  height: 534 * 2,
+  width: 1069 * 2,
+  data: {
+    columnOne: [
+      "Compact folders in Explorer",
+      "Edit both files in diff view",
+      "Search results update while typing",
+      "Problems panel filtering by type",
+      "Minimap highlights errors, changes",
+      "Terminal minimum contrast ratio",
+    ],
+    columnTwo: [
+      "Mirror cursor in HTML tags",
+      "Optional chaining support in JS\\TS",
+      "Extract to interface TS refactoring",
+      "Sass module support for @use",
+      "Remote - Containers improvements",
+      "Visual Studio Online preview",
+    ],
+    title: "achievibit",
+    subtitle: "v2.1.4 - CHANGELOG",
+    logo: {
+      url: "data:image/png;base64,<icon-data>",
+      alt: "kibibit",
+    },
+  },
+  type: "html",
+});
+
+const pngBuffer = await kbHologram.render(KbHologramResultType.PngBuffer);
 ```
 
+Which will return a **png buffer** for the following image:
+![generated changelog](https://raw.githubusercontent.com/Kibibit/kb-hologram/next/src/__image_snapshots__/image-maker-spec-ts-image-maker-should-generate-changelog-from-html-template-1-snap.png)
+
 ### Test
 
 ```bash
@@ -98,6 +100,7 @@ Want to file a bug, contribute some code, or improve documentation? Excellent! R
 You can check out some easy to start with issues in the [Easy Pick](https://github.com/Kibibit/kb-hologram/labels/Easy%20Pick).
 
 ## Contributor Code of Conduct
+
 Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md).
 
 By participating in this project you agree to abide by its terms.

diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -1,14 +1,30 @@
-# [1.1.0](https://github.com/Kibibit/kb-hologram/compare/v1.0.0...v1.1.0) (2019-12-25)
+# [1.0.0-next.5](https://github.com/Kibibit/kb-hologram/compare/v1.0.0-next.4...v1.0.0-next.5) (2023-10-21)
+
+
+### Features
+
+* **app:** rename main class to KbHologram ([8a8f2b3](https://github.com/Kibibit/kb-hologram/commit/8a8f2b345f784af6796c266d02e2dbf3d246faef))
+
+
+### BREAKING CHANGES
+
+* **app:** main class name has been changed
+
+# [1.0.0-next.4](https://github.com/Kibibit/kb-hologram/compare/v1.0.0-next.3...v1.0.0-next.4) (2023-10-20)
 
 
 ### Bug Fixes
 
-* **changelog:** add dependency on @semantic-release/changelog ([060a30d](https://github.com/Kibibit/kb-hologram/commit/060a30dff8f23ad8c58fa23f83e1ec1ea2485d3a))
+* **template-file:** fix passing template file to generate image ([eb917a8](https://github.com/Kibibit/kb-hologram/commit/eb917a8ea938d93267f0781ebe41a96e1245e241))
 
+# [1.0.0-next.3](https://github.com/Kibibit/kb-hologram/compare/v1.0.0-next.2...v1.0.0-next.3) (2023-10-20)
 
-### Features
 
-* **docs:** generate automatic changelog file ([a984c3c](https://github.com/Kibibit/kb-hologram/commit/a984c3c1812407d867992f72f2cc2241e8826d45))
+### Bug Fixes
+
+* **deps:** update module to latest deps ([7b06999](https://github.com/Kibibit/kb-hologram/commit/7b069990000ee6cac51d389ec53e20b94482bb7a))
+* **release:** change main branches ([9c0b778](https://github.com/Kibibit/kb-hologram/commit/9c0b778cd956836eea50a79705f0f75c54bce2c1))
+* **release:** missing details for semantic release ([557d21d](https://github.com/Kibibit/kb-hologram/commit/557d21d8d092123e58b940aa3383478fb8372948))
 
 # [1.0.0-next.2](https://github.com/Kibibit/kb-hologram/compare/v1.0.0-next.1...v1.0.0-next.2) (2019-12-25)