Skip to content

fix(scripts): add bundled readme to docs #3336

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 3 commits into from
Jul 10, 2024
Merged

fix(scripts): add bundled readme to docs #3336

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1a57d93
fix(scripts): add bundled readme to docs
shortcuts Jul 9, 2024
8e1db4c
Merge branch 'main' into fix/scripts-readme-generation
shortcuts Jul 9, 2024
54c1dcc
Merge branch 'main' into fix/scripts-readme-generation
shortcuts Jul 10, 2024
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
1 change: 1 addition & 0 deletions scripts/ci/codegen/pushToAlgoliaDoc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ async function pushToAlgoliaDoc(): Promise<void> {

const pathToSpecs = toAbsolutePath(`${tempGitDir}/app_data/api/specs`);
await run(`rm -rf ${pathToSpecs}/* || true`);
await run(`cp ${toAbsolutePath('specs/bundled/README.md')} ${pathToSpecs}`);
await run(`cp ${toAbsolutePath('specs/bundled/*.doc.yml')} ${pathToSpecs}`);
await run(`cp ${toAbsolutePath('config/release.config.json')} ${pathToSpecs}`);
await run(`cp ${toAbsolutePath('website/src/generated/*.json')} ${pathToSpecs}`);
Expand Down
12 changes: 2 additions & 10 deletions specs/bundled/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,5 @@
# Bundled specs

**Please do not edit the files in this folder, they are generated and changes will be overwritten on next use**
**Please do not edit the files in this folder, they are generated and changes will be overwritten by our scripts**

Output folder of the specs located in `/specs/<CLIENT_NAME>/spec.yml`.

This folder hosts the bundled specs used to:

- Generate clients.
- Generate documentation.
- Share single readable spec file for a specific client.

[Read more on our documentation](https://api-clients-automation.netlify.app/docs/automation/introduction)
[Read more on our documentation](https://api-clients-automation.netlify.app/docs/contributing/introduction)
Loading