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:
@@ -43,6 +43,11 @@ jobs:
|
|||||||
- name: Rethemendex Check
|
- name: Rethemendex Check
|
||||||
command: "rethemendex"
|
command: "rethemendex"
|
||||||
assert-diff: true
|
assert-diff: true
|
||||||
|
- name: Module API Docs Check
|
||||||
|
command: "build"
|
||||||
|
install: normal
|
||||||
|
project: "@element-hq/element-web-module-api"
|
||||||
|
assert-diff: true
|
||||||
- name: Docs
|
- name: Docs
|
||||||
install: layered
|
install: layered
|
||||||
command: "docs:build"
|
command: "docs:build"
|
||||||
@@ -74,6 +79,15 @@ jobs:
|
|||||||
run: pnpm nx run-many -t "$CMD" -p
|
run: pnpm nx run-many -t "$CMD" -p
|
||||||
env:
|
env:
|
||||||
CMD: ${{ matrix.command }}
|
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
|
- name: Assert no changes
|
||||||
run: git diff --exit-code
|
run: git diff --exit-code
|
||||||
|
|||||||
@@ -180,8 +180,8 @@ export type CustomLoginComponentProps = {
|
|||||||
serverConfig: CustomLoginComponentPropsServerConfig;
|
serverConfig: CustomLoginComponentPropsServerConfig;
|
||||||
fragmentAfterLogin?: string;
|
fragmentAfterLogin?: string;
|
||||||
children?: ReactNode;
|
children?: ReactNode;
|
||||||
onLoggedIn(data: AccountAuthInfo): void;
|
onLoggedIn(this: void, data: AccountAuthInfo): void;
|
||||||
onServerConfigChange(config: CustomLoginComponentPropsServerConfig): void;
|
onServerConfigChange(this: void, config: CustomLoginComponentPropsServerConfig): void;
|
||||||
};
|
};
|
||||||
|
|
||||||
// @alpha
|
// @alpha
|
||||||
@@ -231,7 +231,7 @@ export type DialogHandle<M> = {
|
|||||||
ok: boolean;
|
ok: boolean;
|
||||||
model: M | null;
|
model: M | null;
|
||||||
}>;
|
}>;
|
||||||
close(): void;
|
close(this: void): void;
|
||||||
};
|
};
|
||||||
|
|
||||||
// @public
|
// @public
|
||||||
@@ -241,8 +241,8 @@ export interface DialogOptions {
|
|||||||
|
|
||||||
// @public
|
// @public
|
||||||
export type DialogProps<M> = {
|
export type DialogProps<M> = {
|
||||||
onSubmit(model: M): void;
|
onSubmit(this: void, model: M): void;
|
||||||
onCancel(): void;
|
onCancel(this: void): void;
|
||||||
};
|
};
|
||||||
|
|
||||||
// @alpha @deprecated (undocumented)
|
// @alpha @deprecated (undocumented)
|
||||||
|
|||||||
@@ -31,7 +31,8 @@ export default defineConfig({
|
|||||||
bundleTypes: {
|
bundleTypes: {
|
||||||
configPath: "./api-extractor.json",
|
configPath: "./api-extractor.json",
|
||||||
invokeOptions: {
|
invokeOptions: {
|
||||||
localBuild: !!process.env.CI,
|
// Always overwrite element-web-module-api.api.md
|
||||||
|
localBuild: true,
|
||||||
typescriptCompilerFolder: resolve(require.resolve("@typescript/old"), "../.."),
|
typescriptCompilerFolder: resolve(require.resolve("@typescript/old"), "../.."),
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|||||||
Reference in New Issue
Block a user