Merge branch 'main' into yaml-defaults

Author: anisite

.circleci/config.yml

@@ -1,53 +1,55 @@
-name: Semantic Release
-on:
-  push:
-    branches:
-      - 'main'
+name: Build
+on: [push]
+
+env:
+  CI_BUILD_NUM: ${{ github.run_id }}
+  CI_BRANCH: ${{ github.ref_name }}
+  CIRCLE_REPOSITORY_URL: dummy-url
 
 jobs:
   build:
+    name: Test
     runs-on: ubuntu-latest
-    if: "!contains(github.event.head_commit.message, '[skip ci]')"
     steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js 14.x
-        uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - name: Use Node.js 20.x
+        uses: actions/setup-node@v4
         with:
-          node-version: '14.x'
+          node-version: '20.x'
       - run: npm install
       - run: git config --global user.email "test@project-helix.io" && git config --global user.name "Test Build"
       - run: npm test
-        env:
-          CIRCLE_REPOSITORY_URL: dummy-url
+      - uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
 
   build_win:
+    name: Test (Windows)
     runs-on: windows-latest
-    if: "!contains(github.event.head_commit.message, '[skip ci]')"
     steps:
       - run: git config --global core.autocrlf false
-      - uses: actions/checkout@v3
-      - name: Use Node.js 14.x
-        uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - name: Use Node.js 20.x
+        uses: actions/setup-node@v4
         with:
-          node-version: '14.x'
+          node-version: '20.x'
       - run: npm install
       - run: git config --global user.email "test@project-helix.io" && git config --global user.name "Test Build"
       - run: npm test
-        env:
-          CIRCLE_REPOSITORY_URL: dummy-url
 
   release:
+    name: Release
     runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/main'
     needs: [build, build_win]
-    if: "!contains(github.event.head_commit.message, '[skip ci]')"
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           persist-credentials: false
-      - name: Use Node.js 14.x
-        uses: actions/setup-node@v3
+      - name: Use Node.js 20.x
+        uses: actions/setup-node@v4
         with:
-          node-version: '14.x'
+          node-version: '20.x'
       - run: npm install
       - run: npm run semantic-release
         env:

.github/workflows/semantic-release.yaml .github/workflows/main.yaml.github/workflows/semantic-release.yaml renamed to .github/workflows/main.yaml

@@ -10,7 +10,7 @@ jobs:
     steps:
       - name: Comment
         id: comment
-        uses: adobe-rnd/github-semantic-release-comment-action@master
+        uses: adobe-rnd/github-semantic-release-comment-action@main
         with:
-          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 

.github/workflows/semver-check.yaml

@@ -1,3 +1,39 @@
+## [8.0.2](https://github.com/adobe/jsonschema2md/compare/v8.0.1...v8.0.2) (2024-04-09)
+
+
+### Bug Fixes
+
+* remove helix-log dependency ([#579](https://github.com/adobe/jsonschema2md/issues/579)) ([9fbfdf9](https://github.com/adobe/jsonschema2md/commit/9fbfdf9726c512c4338c47bafef02347f1761372))
+
+## [8.0.1](https://github.com/adobe/jsonschema2md/compare/v8.0.0...v8.0.1) (2024-03-25)
+
+
+### Bug Fixes
+
+* **deps:** update external dependencies ([51be972](https://github.com/adobe/jsonschema2md/commit/51be972b9be85852e9a1ee2f9b7e5b7a86351375))
+
+# [8.0.0](https://github.com/adobe/jsonschema2md/compare/v7.1.6...v8.0.0) (2024-03-25)
+
+
+### Build System
+
+* require node 18  ([3b74f4f](https://github.com/adobe/jsonschema2md/commit/3b74f4f31fc16d28c9a4a8f317cdd1beb2242d7e))
+
+
+### BREAKING CHANGES
+
+* requires node 18
+
+## [7.1.6](https://github.com/adobe/jsonschema2md/compare/v7.1.5...v7.1.6) (2024-03-25)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @adobe/helix-log to v6.0.1 ([b54415a](https://github.com/adobe/jsonschema2md/commit/b54415a0ae4a66a8ec5da9d433403cf46b0cf351))
+* **deps:** update external fixes ([f515169](https://github.com/adobe/jsonschema2md/commit/f5151691a394c139f07ecaf8ec465e71dba49631))
+* **deps:** update external fixes ([e23d8f0](https://github.com/adobe/jsonschema2md/commit/e23d8f01666fedc12442fa2f9bab660c5aa58d8a))
+* **deps:** update external major ([#516](https://github.com/adobe/jsonschema2md/issues/516)) ([d7d72e6](https://github.com/adobe/jsonschema2md/commit/d7d72e61e2b65f0a790b8945d756082bf2fd3bcf))
+
 ## [7.1.5](https://github.com/adobe/jsonschema2md/compare/v7.1.4...v7.1.5) (2022-12-12)
 
 

CHANGELOG.md

@@ -1,6 +1,6 @@
 # JSON Schema Markdown Tools
 
-[![CircleCI](https://circleci.com/gh/adobe/jsonschema2md.svg?style=svg)](https://circleci.com/gh/adobe/jsonschema2md)
+[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/adobe/jsonschema2md/main.yaml)](https://github.com/adobe/jsonschema2md/actions/workflows/main.yaml)
 
 Documenting and validating complex JSON Schemas can be hard. This tool makes it easier by providing a number of scripts that can turn JSON Schema files into readable Markdown documentation that is ready for consumption on GitHub or processed using Jekyll or other static site generators.
 
@@ -13,7 +13,7 @@ These tools have been introduced by Adobe to document Adobe's Experience Data Mo
 ## Requirements
 
 - `npm` version 3.10.8 or up
-- `node` v14 or up
+- `node` v18 or v20 or up
 
 ## Example Output
 
@@ -45,10 +45,11 @@ Supported languages are:
 If you want to provide a translation of your own, [please use GitLocalize](https://gitlocalize.com/repo/3622)
 
 ## Display custom attributes in the property description
-`jsonschema2md` displays only the attributes of an property which are defined by the JSON Schema standard. If you want to display additional attributes in the property description you could provide a comma separated list with your custom attributes.
+`jsonschema2md` displays only the attributes of an property which are defined by the JSON Schema standard. If you want to display additional attributes in the property description you could provide these with the `--properties` (or `-p`) parameter.
 
 ```bash
-$ jsonschema2md -d examples/schemas -o examples/docs -p version,test
+# include both the `version` and the `test` attribute
+$ jsonschema2md -d examples/schemas -o examples/docs -p version -p test
 ```
 
 ## Disable header template
@@ -109,8 +110,8 @@ This will run our Jasmine test suite as well as lint the JavaScript according to
 
 ### CI
 
-Continuous integration runs on [CircleCI](https://circleci.com/gh/adobe/jsonschema2md). 
-All pull requests automatically trigger a job that runs the [tests](#tests) by executing the [`config.yml`](.circleci/config.yml). 
+Continuous integration runs on Github Actions.
+All pull requests automatically trigger a job that runs the [tests](#tests) by executing the [`main.yml`](.github/workflows/main.yaml). 
 
 ### Code Coverage
 

README.md

@@ -13,7 +13,6 @@
 import yargs from 'yargs';
 import fs from 'fs-extra';
 import readdirp from 'readdirp';
-import { createDefaultLogger, SimpleInterface } from '@adobe/helix-log';
 import {
   iter, pipe, filter, map, obj,
 } from 'ferrum';
@@ -30,12 +29,7 @@ import writeSchema from './writeSchema.js';
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = nodepath.dirname(__filename);
 
-const logger = new SimpleInterface({
-  logger: createDefaultLogger(),
-});
-const debug = logger.debug.bind(logger);
-const info = logger.info.bind(logger);
-const error = logger.error.bind(logger);
+const { debug, info, error } = console;
 
 /**
  * @typedef {import("../types/api").JsonSchema} JsonSchema