adapt-authoring-docs 0.0.1 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/new.yml +7 -11
- package/bin/docgen.js +4 -2
- package/package.json +2 -2
- package/.github/workflows/labelled_prs.yml +0 -16
|
@@ -1,19 +1,15 @@
|
|
|
1
|
-
|
|
1
|
+
# Calls the org-level reusable workflow to add PRs to the TODO Board
|
|
2
|
+
|
|
3
|
+
name: Add PR to Project
|
|
2
4
|
|
|
3
5
|
on:
|
|
4
|
-
issues:
|
|
5
|
-
types:
|
|
6
|
-
- opened
|
|
7
6
|
pull_request:
|
|
8
7
|
types:
|
|
9
8
|
- opened
|
|
9
|
+
- reopened
|
|
10
10
|
|
|
11
11
|
jobs:
|
|
12
12
|
add-to-project:
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
- uses: actions/add-to-project@v0.1.0
|
|
17
|
-
with:
|
|
18
|
-
project-url: https://github.com/orgs/adapt-security/projects/5
|
|
19
|
-
github-token: ${{ secrets.PROJECTS_SECRET }}
|
|
13
|
+
uses: adapt-security/.github/.github/workflows/new.yml@main
|
|
14
|
+
secrets:
|
|
15
|
+
PROJECTS_SECRET: ${{ secrets.PROJECTS_SECRET }}
|
package/bin/docgen.js
CHANGED
|
@@ -9,8 +9,10 @@ import jsdoc3 from '../jsdoc3/jsdoc3.js'
|
|
|
9
9
|
import path from 'path'
|
|
10
10
|
import swagger from '../swagger/swagger.js'
|
|
11
11
|
|
|
12
|
+
const DEBUG = process.argv.includes('--verbose')
|
|
13
|
+
|
|
12
14
|
process.env.NODE_ENV ??= 'production'
|
|
13
|
-
process.env.ADAPT_AUTHORING_LOGGER__mute =
|
|
15
|
+
process.env.ADAPT_AUTHORING_LOGGER__mute = !DEBUG
|
|
14
16
|
|
|
15
17
|
const app = App.instance
|
|
16
18
|
let outputdir
|
|
@@ -68,7 +70,7 @@ async function copyRootFiles () {
|
|
|
68
70
|
}
|
|
69
71
|
|
|
70
72
|
async function docs () {
|
|
71
|
-
console.log(`Generating documentation for ${app.pkg.name}@${app.pkg.version}`)
|
|
73
|
+
console.log(`Generating documentation for ${app.pkg.name}@${app.pkg.version} ${DEBUG ? ' :: DEBUG' : ''}`)
|
|
72
74
|
|
|
73
75
|
try {
|
|
74
76
|
await app.onReady()
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "adapt-authoring-docs",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "1.1.0",
|
|
4
4
|
"description": "Tools for auto-generating documentation for the Adapt authoring tool",
|
|
5
5
|
"homepage": "https://github.com/adapt-security/adapt-authoring-docs",
|
|
6
6
|
"license": "GPL-3.0",
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
"docdash": "^2.0.2",
|
|
16
16
|
"docsify-cli": "^4.4.4",
|
|
17
17
|
"fs-extra": "^11.2.0",
|
|
18
|
-
"glob": "^
|
|
18
|
+
"glob": "^13.0.0",
|
|
19
19
|
"http-server": "^14.1.1",
|
|
20
20
|
"jsdoc": "^4.0.3",
|
|
21
21
|
"swagger-ui": "^5.17.14"
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
name: Add labelled PRs to project
|
|
2
|
-
|
|
3
|
-
on:
|
|
4
|
-
pull_request:
|
|
5
|
-
types: [ labeled ]
|
|
6
|
-
|
|
7
|
-
jobs:
|
|
8
|
-
add-to-project:
|
|
9
|
-
if: ${{ github.event.label.name == 'dependencies' }}
|
|
10
|
-
name: Add to main project
|
|
11
|
-
runs-on: ubuntu-latest
|
|
12
|
-
steps:
|
|
13
|
-
- uses: actions/add-to-project@v0.1.0
|
|
14
|
-
with:
|
|
15
|
-
project-url: https://github.com/orgs/adapt-security/projects/5
|
|
16
|
-
github-token: ${{ secrets.PROJECTS_SECRET }}
|