adapt-authoring-docs 1.4.3 → 1.4.5

package/.github/workflows/releases.yml

@@ -1,32 +1,16 @@
 name: Release
+
 on:
   push:
     branches:
       - master
 
+permissions:
+  contents: write
+  issues: write
+  pull-requests: write
+  id-token: write
+
 jobs:
   release:
-    name: Release
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write # to be able to publish a GitHub release
-      issues: write # to be able to comment on released issues
-      pull-requests: write # to be able to comment on released pull requests
-      id-token: write # to enable use of OIDC for trusted publishing and npm provenance
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: 'lts/*'
-      - name: Update npm
-        run: npm install -g npm@latest
-      - name: Install dependencies
-        run: npm install
-      - name: Release
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: npx semantic-release
+    uses: adaptlearning/semantic-release-config/.github/workflows/release.yml@master

package/docsify/docsify.js

@@ -98,7 +98,10 @@ export default async function docsify (appData, configs, outputdir, defaultPages
     homepage: defaultPages.manualIndex ? path.basename(defaultPages.manualIndex) : false
   })))
 
-  await Promise.allSettled(Object.entries(titleMap).map(([filename, v]) => fs.copy(v.path, `${dir}/${filename}`)))
+  await Promise.allSettled([
+    ...Object.entries(titleMap).map(([filename, v]) => fs.copy(v.path, `${dir}/${filename}`)),
+    ...Object.values(defaultPages).filter(Boolean).map(f => fs.copy(f, `${dir}/${path.basename(f)}`))
+  ])
   /**
    * Generate custom sidebar
    */

package/lib/docsData.js

@@ -147,15 +147,15 @@ export async function buildRouterTree (dependencies) {
 
   if (apiDep) {
     try {
-      apiDefaultRoutes = await readJson(path.join(apiDep.rootDir, 'lib', 'default-routes.json'))
+      apiDefaultRoutes = await readJson(path.join(apiDep.rootDir, 'default-routes.json'))
     } catch { /* no defaults */ }
   }
   if (authDep) {
     try {
-      authDefaultRoutes = await readJson(path.join(authDep.rootDir, 'lib', 'default-routes.json'))
+      authDefaultRoutes = await readJson(path.join(authDep.rootDir, 'default-routes.json'))
     } catch { /* no defaults */ }
     try {
-      const coreAuthConfig = await readJson(path.join(authDep.rootDir, 'lib', 'routes.json'))
+      const coreAuthConfig = await readJson(path.join(authDep.rootDir, 'routes.json'))
       authRouter = {
         path: '/api/auth',
         routes: (coreAuthConfig.routes || []).map(r => staticRouteEntry(r)),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adapt-authoring-docs",
-  "version": "1.4.3",
+  "version": "1.4.5",
   "description": "Tools for auto-generating documentation for the Adapt authoring tool",
   "homepage": "https://github.com/adapt-security/adapt-authoring-docs",
   "license": "GPL-3.0",
@@ -26,36 +26,10 @@
     "swagger-ui": "^5.17.14"
   },
   "devDependencies": {
-    "@semantic-release/git": "^10.0.1",
-    "conventional-changelog-eslint": "^6.0.0",
-    "semantic-release": "^25.0.2",
+    "@adaptlearning/semantic-release-config": "^1.0.0",
     "standard": "^17.1.0"
   },
   "release": {
-    "plugins": [
-      [
-        "@semantic-release/commit-analyzer",
-        {
-          "preset": "eslint"
-        }
-      ],
-      [
-        "@semantic-release/release-notes-generator",
-        {
-          "preset": "eslint"
-        }
-      ],
-      "@semantic-release/npm",
-      "@semantic-release/github",
-      [
-        "@semantic-release/git",
-        {
-          "assets": [
-            "package.json"
-          ],
-          "message": "Chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
-        }
-      ]
-    ]
+    "extends": "@adaptlearning/semantic-release-config"
   }
 }

package/tests/docsData.spec.js

@@ -25,7 +25,7 @@ async function createFixture () {
 
   // --- fake api module (library, not a loaded module) ---
   const apiDir = path.join(root, 'node_modules', 'adapt-authoring-api')
-  await fs.mkdir(path.join(apiDir, 'lib'), { recursive: true })
+  await fs.mkdir(apiDir, { recursive: true })
   await fs.writeFile(path.join(apiDir, 'package.json'), JSON.stringify({
     name: 'adapt-authoring-api',
     version: '1.0.0'
@@ -34,7 +34,7 @@ async function createFixture () {
     module: false,
     documentation: { enable: true }
   }))
-  await fs.writeFile(path.join(apiDir, 'lib', 'default-routes.json'), JSON.stringify({
+  await fs.writeFile(path.join(apiDir, 'default-routes.json'), JSON.stringify({
     routes: [
       {
         route: '/',
@@ -51,7 +51,7 @@ async function createFixture () {
 
   // --- fake auth module ---
   const authDir = path.join(root, 'node_modules', 'adapt-authoring-auth')
-  await fs.mkdir(path.join(authDir, 'lib'), { recursive: true })
+  await fs.mkdir(authDir, { recursive: true })
   await fs.writeFile(path.join(authDir, 'package.json'), JSON.stringify({
     name: 'adapt-authoring-auth',
     version: '1.0.0'
@@ -59,7 +59,7 @@ async function createFixture () {
   await fs.writeFile(path.join(authDir, 'adapt-authoring.json'), JSON.stringify({
     documentation: { enable: true }
   }))
-  await fs.writeFile(path.join(authDir, 'lib', 'routes.json'), JSON.stringify({
+  await fs.writeFile(path.join(authDir, 'routes.json'), JSON.stringify({
     routes: [
       {
         route: '/check',
@@ -68,7 +68,7 @@ async function createFixture () {
       }
     ]
   }))
-  await fs.writeFile(path.join(authDir, 'lib', 'default-routes.json'), JSON.stringify({
+  await fs.writeFile(path.join(authDir, 'default-routes.json'), JSON.stringify({
     routes: [
       {
         route: '/',