Fix Module API api docs not regenerating on build (#34429)

* Always overwrite module API files

* Report if the module API changes unexpected in CI

* Update docs

* Add command to the matrix

* actually filter by project
This commit is contained in:
Will Hunt
2026-07-28 15:48:24 +00:00
committed by GitHub
parent 35a6aaab71
commit 9dd8e82604
3 changed files with 21 additions and 6 deletions
+14
View File
@@ -43,6 +43,11 @@ jobs:
- name: Rethemendex Check
command: "rethemendex"
assert-diff: true
- name: Module API Docs Check
command: "build"
install: normal
project: "@element-hq/element-web-module-api"
assert-diff: true
- name: Docs
install: layered
command: "docs:build"
@@ -74,6 +79,15 @@ jobs:
run: pnpm nx run-many -t "$CMD" -p
env:
CMD: ${{ matrix.command }}
if: matrix.project == ''
- name: Run ${{ matrix.command }} on ${{ matrix.project }}
run: pnpm nx run -t "$CMD" -p "$PROJECT"
env:
CMD: ${{ matrix.command }}
PROJECT: ${{ matrix.project }}
if: matrix.project
- name: Assert no changes
run: git diff --exit-code
@@ -180,8 +180,8 @@ export type CustomLoginComponentProps = {
serverConfig: CustomLoginComponentPropsServerConfig;
fragmentAfterLogin?: string;
children?: ReactNode;
onLoggedIn(data: AccountAuthInfo): void;
onServerConfigChange(config: CustomLoginComponentPropsServerConfig): void;
onLoggedIn(this: void, data: AccountAuthInfo): void;
onServerConfigChange(this: void, config: CustomLoginComponentPropsServerConfig): void;
};
// @alpha
@@ -231,7 +231,7 @@ export type DialogHandle<M> = {
ok: boolean;
model: M | null;
}>;
close(): void;
close(this: void): void;
};
// @public
@@ -241,8 +241,8 @@ export interface DialogOptions {
// @public
export type DialogProps<M> = {
onSubmit(model: M): void;
onCancel(): void;
onSubmit(this: void, model: M): void;
onCancel(this: void): void;
};
// @alpha @deprecated (undocumented)
+2 -1
View File
@@ -31,7 +31,8 @@ export default defineConfig({
bundleTypes: {
configPath: "./api-extractor.json",
invokeOptions: {
localBuild: !!process.env.CI,
// Always overwrite element-web-module-api.api.md
localBuild: true,
typescriptCompilerFolder: resolve(require.resolve("@typescript/old"), "../.."),
},
},