diff --git a/.github/workflows/ci-build.yml b/.github/workflows/ci-build.yml index d24c0cd07..d5b0be811 100644 --- a/.github/workflows/ci-build.yml +++ b/.github/workflows/ci-build.yml @@ -50,6 +50,23 @@ jobs: working-directory: addon run: pnpm tsc --noEmit + docs-gen: + timeout-minutes: 5 + name: Docs Generation + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + - uses: pnpm/action-setup@v4 + - uses: actions/setup-node@v4 + with: + cache: pnpm + - name: Install Dependencies + run: pnpm install + - run: pnpm build:docs + - run: echo "If this fails, docs gen is out of sync. Please run 'pnpm build:docs'" && git diff --exit-code + + floating: name: "Floating Dependencies" runs-on: ubuntu-latest diff --git a/addon/package.json b/addon/package.json index 8e4f0b76c..a58a4a42f 100644 --- a/addon/package.json +++ b/addon/package.json @@ -29,7 +29,7 @@ "prepack": "cp ../README.md ./ && pnpm build", "postpack": "rimraf addon-test-support/**/*.js public-types", "clean": "git clean -x -f", - "docs": "pnpm build && documentation build --document-exported \"addon-test-support/@ember/test-helpers/index.js\" --config documentation.yml --markdown-toc-max-depth 3 -f md -o API.md", + "docs": "pnpm build && documentation build --document-exported \"addon-test-support/@ember/test-helpers/index.js\" --config documentation.yml --markdown-toc-max-depth 3 -f md -o ../API.md", "lint": "concurrently \"npm:lint:*(!fix)\" --names \"lint:\"", "lint:fix": "concurrently 'npm:lint:*:fix' --names 'fix:'", "lint:js": "eslint --cache .", diff --git a/package.json b/package.json index 798ce3424..6a972b67a 100644 --- a/package.json +++ b/package.json @@ -5,6 +5,7 @@ "repository": "https://github.com/emberjs/ember-test-helpers", "license": "(MIT OR Apache-2.0)", "scripts": { + "build:docs": "pnpm --filter '@ember/test-helpers' run docs", "lint": "pnpm --filter '*' lint", "lint:fix": "pnpm --filter '*' lint:fix", "test": "pnpm --filter '*' test"