Skip to content

feat(scripts): push to docs-new #4850

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 13, 2025
Merged

feat(scripts): push to docs-new #4850

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions scripts/ci/codegen/pushToRepository.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ import { commitStartRelease } from './text.ts';
async function handleSpecFiles(spec: SpecsToPush, tempGitDir: string): Promise<void> {
const output = toAbsolutePath(`${tempGitDir}/${spec.output}`);

if (!(await exists(output))) {
await fsp.mkdir(output, { recursive: true });
}

if (spec.includeSnippets) {
await run(`cp ${toAbsolutePath('docs/bundled/*-snippets.json')} ${output}`);
}
Expand Down
29 changes: 28 additions & 1 deletion scripts/ci/codegen/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,9 @@ export type RepositoryConfiguration = {
tasks: Array<RepositoryTask>;
};

export const pushToRepositoryConfiguration: { [k in 'AlgoliaWeb' | 'doc' | 'mcp-node']: RepositoryConfiguration } = {
export const pushToRepositoryConfiguration: {
[k in 'AlgoliaWeb' | 'doc' | 'mcp-node' | 'docs-new']: RepositoryConfiguration;
} = {
AlgoliaWeb: {
baseBranch: 'develop',
tasks: [
Expand Down Expand Up @@ -103,6 +105,31 @@ export const pushToRepositoryConfiguration: { [k in 'AlgoliaWeb' | 'doc' | 'mcp-
},
],
},
'docs-new': {
baseBranch: 'main',
tasks: [
{
prBranch: 'feat/automated-update-for-specs',
commitMessage: 'feat: update specs and supported versions',
files: {
type: 'specs',
ext: 'yml',
output: 'specs',
includeSnippets: true,
includeSLA: true,
placeholderVariables: { 'openapi: 3.0.2': 'openapi: 3.1.0' },
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mintlify needs openapi 3.1.0 but we can't support it for now

},
},
{
prBranch: 'feat/automated-update-for-guides',
commitMessage: 'feat: update generated guides',
files: {
type: 'guides',
output: 'specs/guides.json',
},
},
],
},
'mcp-node': {
baseBranch: 'main',
tasks: [
Expand Down