diff --git a/.changeset/warm-dodos-decide.md b/.changeset/warm-dodos-decide.md deleted file mode 100644 index 72b7ce4..0000000 --- a/.changeset/warm-dodos-decide.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -"@calycode/types": patch -"@calycode/utils": patch -"@calycode/core": patch -"@calycode/cli": patch ---- - -refactor: minor cleanup, removal of the linting command.. -fix: make backup to be stream, to allow bigger workspaces -refactor: cleanup of fs / path imports in the cli diff --git a/.github/workflows/add-docs-to-release.yml b/.github/workflows/add-docs-to-release.yml index f7e97db..c8482d4 100644 --- a/.github/workflows/add-docs-to-release.yml +++ b/.github/workflows/add-docs-to-release.yml @@ -2,42 +2,54 @@ name: Generate Docs on: - pull_request: - types: [opened, synchronize] - branches: - - main + pull_request: + types: [opened, synchronize] + branches: + - main jobs: - generate-docs: - if: github.repository == 'calycode/xano-tools' && github.repository_owner == 'calycode' && startsWith(github.head_ref, 'changeset-release') - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - with: - token: ${{ secrets.CHANGESETS_GH_TOKEN }} - - - uses: pnpm/action-setup@v4 - with: - version: 10 - run_install: true - - - uses: actions/setup-node@v4 - with: - node-version: 20.x - - - name: Install packages - run: pnpm install - - - name: Build packages - run: pnpm build:packages - - - name: Build Docs - run: pnpm build:docs - - - name: Commit and push docs - run: | - git config user.name "github-actions[bot]" - git config user.email "github-actions[bot]@users.noreply.github.com" - git add docs - git commit -m "chore: update docs [skip ci]" || echo "No changes to commit" - git push origin HEAD:main --force-with-lease + generate-docs: + if: github.repository == 'calycode/xano-tools' && github.repository_owner == 'calycode' && startsWith(github.head_ref, 'changeset-release') + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + token: ${{ secrets.CHANGESETS_GH_TOKEN }} + + - uses: pnpm/action-setup@v4 + with: + version: 10 + run_install: true + + - uses: actions/setup-node@v4 + with: + node-version: 20.x + + - name: Install packages + run: pnpm install + + - name: Build packages + run: pnpm build:packages + + - name: Build Docs + run: pnpm build:docs + + - name: Commit docs + id: commit_docs + run: | + git add docs + if git diff --cached --quiet; then + echo "No changes to commit." + echo "commit=false" >> $GITHUB_OUTPUT + else + git commit -m "chore: update docs [skip ci]" + echo "commit=true" >> $GITHUB_OUTPUT + fi + + - name: Push docs (only if commit was made) + if: steps.commit_docs.outputs.commit == 'true' + run: | + git config user.name "github-actions[bot]" + git config user.email "github-actions[bot]@users.noreply.github.com" + git push origin HEAD:${GITHUB_HEAD_REF} --force-with-lease + diff --git a/docs/README.md b/docs/README.md index 3d5f077..2b63416 100644 --- a/docs/README.md +++ b/docs/README.md @@ -141,8 +141,7 @@ I have been astonished by the shadcn/ui CLI and the core principles of code dist - [x] **Scaffolding a registry** of reusable Xano components - [x] Exporting all available `xanoscript` from your instance via metadata API _*(important note: not all pieces of logic can be exported via metadata API, this especially is fragile on older and bigger instances)_. - [x] Adding components to Xano from a registry (only functions, tables, queries for now) -- [ ] Automated test runner with assertion configuration -- [ ] Linting with custom rulesets +- [x] Automated test runner with assertion configuration --- diff --git a/docs/commands/export-backup.md b/docs/commands/export-backup.md index bad8b90..6475d70 100644 --- a/docs/commands/export-backup.md +++ b/docs/commands/export-backup.md @@ -23,9 +23,10 @@ Backup Xano Workspace via Metadata API Options: --instance The instance name. This is used to fetch the instance - configuration. The value provided at the setup command. - --workspace The workspace name. This is used to fetch the workspace - configuration. Same as on Xano interface. + configuration. The value provided at the setup + command. + --workspace The workspace name. This is used to fetch the + workspace configuration. Same as on Xano interface. --branch The branch name. This is used to select the branch configuration. Same as on Xano Interface. --print-output-dir Expose usable output path for further reuse. diff --git a/docs/commands/generate-code.md b/docs/commands/generate-code.md index b3c0e71..e99fbb0 100644 --- a/docs/commands/generate-code.md +++ b/docs/commands/generate-code.md @@ -29,25 +29,27 @@ xano generate-code [options] ```sh Usage: xano generate-code [options] -Create a library based on the OpenAPI specification. If the openapi specification has not -yet been generated, this will generate that as well as the first step. +Create a library based on the OpenAPI specification. If the openapi +specification has not yet been generated, this will generate that as well as the +first step. Options: --instance The instance name. This is used to fetch the instance - configuration. The value provided at the setup command. - --workspace The workspace name. This is used to fetch the workspace - configuration. Same as on Xano interface. + configuration. The value provided at the setup + command. + --workspace The workspace name. This is used to fetch the + workspace configuration. Same as on Xano interface. --branch The branch name. This is used to select the branch configuration. Same as on Xano Interface. --group API group name. Same as on Xano Interface. - --all Regenerate for all API groups in the workspace / branch of the - current context. + --all Regenerate for all API groups in the workspace / + branch of the current context. --print-output-dir Expose usable output path for further reuse. --generator Generator to use, see all options at: https://openapi-generator.tech/docs/generators --args Additional arguments to pass to the generator. See https://openapi-generator.tech/docs/usage#generate - --debug Specify this flag in order to allow logging. Logs will appear in - output/_logs. Default: false + --debug Specify this flag in order to allow logging. Logs + will appear in output/_logs. Default: false -h, --help display help for command ``` \ No newline at end of file diff --git a/docs/commands/generate-oas.md b/docs/commands/generate-oas.md index e588b76..5e3ec00 100644 --- a/docs/commands/generate-oas.md +++ b/docs/commands/generate-oas.md @@ -27,14 +27,15 @@ Update and generate OpenAPI spec(s) for the current context. Options: --instance The instance name. This is used to fetch the instance - configuration. The value provided at the setup command. - --workspace The workspace name. This is used to fetch the workspace - configuration. Same as on Xano interface. + configuration. The value provided at the setup + command. + --workspace The workspace name. This is used to fetch the + workspace configuration. Same as on Xano interface. --branch The branch name. This is used to select the branch configuration. Same as on Xano Interface. --group API group name. Same as on Xano Interface. - --all Regenerate for all API groups in the workspace / branch of the - current context. + --all Regenerate for all API groups in the workspace / + branch of the current context. --print-output-dir Expose usable output path for further reuse. -h, --help display help for command ``` \ No newline at end of file diff --git a/docs/commands/generate-repo.md b/docs/commands/generate-repo.md index e26cd73..536fab7 100644 --- a/docs/commands/generate-repo.md +++ b/docs/commands/generate-repo.md @@ -31,12 +31,14 @@ Options: --input workspace yaml file --output output directory (overrides config) --instance The instance name. This is used to fetch the instance - configuration. The value provided at the setup command. - --workspace The workspace name. This is used to fetch the workspace - configuration. Same as on Xano interface. + configuration. The value provided at the setup + command. + --workspace The workspace name. This is used to fetch the + workspace configuration. Same as on Xano interface. --branch The branch name. This is used to select the branch configuration. Same as on Xano Interface. --print-output-dir Expose usable output path for further reuse. - --fetch Specify this if you want to fetch the workspace schema from Xano + --fetch Specify this if you want to fetch the workspace + schema from Xano -h, --help display help for command ``` \ No newline at end of file diff --git a/docs/commands/generate-xs-repo.md b/docs/commands/generate-xs-repo.md index b307a0e..12792df 100644 --- a/docs/commands/generate-xs-repo.md +++ b/docs/commands/generate-xs-repo.md @@ -23,9 +23,10 @@ Process Xano workspace into repo structure Options: --instance The instance name. This is used to fetch the instance - configuration. The value provided at the setup command. - --workspace The workspace name. This is used to fetch the workspace - configuration. Same as on Xano interface. + configuration. The value provided at the setup + command. + --workspace The workspace name. This is used to fetch the + workspace configuration. Same as on Xano interface. --branch The branch name. This is used to select the branch configuration. Same as on Xano Interface. --print-output-dir Expose usable output path for further reuse. diff --git a/docs/commands/registry-add.md b/docs/commands/registry-add.md index 9e70941..7549830 100644 --- a/docs/commands/registry-add.md +++ b/docs/commands/registry-add.md @@ -25,9 +25,10 @@ Add a prebuilt component to the current Xano context. Options: --instance The instance name. This is used to fetch the instance - configuration. The value provided at the setup command. - --workspace The workspace name. This is used to fetch the workspace - configuration. Same as on Xano interface. + configuration. The value provided at the setup + command. + --workspace The workspace name. This is used to fetch the + workspace configuration. Same as on Xano interface. --branch The branch name. This is used to select the branch configuration. Same as on Xano Interface. --components Comma-separated list of components to add diff --git a/docs/commands/registry-scaffold.md b/docs/commands/registry-scaffold.md index 80db900..d74b0ba 100644 --- a/docs/commands/registry-scaffold.md +++ b/docs/commands/registry-scaffold.md @@ -15,10 +15,11 @@ xano registry-scaffold [options] ```sh Usage: xano registry-scaffold [options] -Scaffold a Xano registry folder with a sample component. Xano registry can be used to share -and reuse prebuilt components. In the registry you have to follow the -[registry](https://nextcurve.hu/schemas/registry/registry.json) and [registry -item](https://nextcurve.hu/schemas/registry/registry-item.json) schemas. +Scaffold a Xano registry folder with a sample component. Xano registry can be +used to share and reuse prebuilt components. In the registry you have to follow +the [registry](https://nextcurve.hu/schemas/registry/registry.json) and +[registry item](https://nextcurve.hu/schemas/registry/registry-item.json) +schemas. Options: --output Output path for the registry diff --git a/docs/commands/restore-backup.md b/docs/commands/restore-backup.md index fe810e1..e3530e4 100644 --- a/docs/commands/restore-backup.md +++ b/docs/commands/restore-backup.md @@ -23,9 +23,10 @@ Restore a backup to a Xano Workspace via Metadata API Options: --instance The instance name. This is used to fetch the instance - configuration. The value provided at the setup command. - --workspace The workspace name. This is used to fetch the workspace - configuration. Same as on Xano interface. + configuration. The value provided at the setup + command. + --workspace The workspace name. This is used to fetch the + workspace configuration. Same as on Xano interface. --source-backup Path to the backup file to restore --force Force restoration without confirmation -h, --help display help for command diff --git a/docs/commands/run-test.md b/docs/commands/run-test.md index 038249b..7435ae4 100644 --- a/docs/commands/run-test.md +++ b/docs/commands/run-test.md @@ -28,15 +28,16 @@ Usage: xano run-test [options] Run an API test suite via the OpenAPI spec. WIP... Options: - --instance The instance name. This is used to fetch the instance - configuration. The value provided at the setup command. - --workspace The workspace name. This is used to fetch the workspace - configuration. Same as on Xano interface. + --instance The instance name. This is used to fetch the + instance configuration. The value provided at the + setup command. + --workspace The workspace name. This is used to fetch the + workspace configuration. Same as on Xano interface. --branch The branch name. This is used to select the branch configuration. Same as on Xano Interface. --group API group name. Same as on Xano Interface. - --all Regenerate for all API groups in the workspace / branch of the - current context. + --all Regenerate for all API groups in the workspace / + branch of the current context. --print-output-dir Expose usable output path for further reuse. --test-config-path Path to a test configuration file. -h, --help display help for command diff --git a/docs/commands/serve-oas.md b/docs/commands/serve-oas.md index 88722a8..0837bbc 100644 --- a/docs/commands/serve-oas.md +++ b/docs/commands/serve-oas.md @@ -29,16 +29,17 @@ Serve the Open API specification locally for quick visual check. Options: --instance The instance name. This is used to fetch the instance - configuration. The value provided at the setup command. - --workspace The workspace name. This is used to fetch the workspace - configuration. Same as on Xano interface. + configuration. The value provided at the setup + command. + --workspace The workspace name. This is used to fetch the + workspace configuration. Same as on Xano interface. --branch The branch name. This is used to select the branch configuration. Same as on Xano Interface. --group API group name. Same as on Xano Interface. - --all Regenerate for all API groups in the workspace / branch of the - current context. - --listen The port where you want your registry to be served locally. By - default it is 5000. + --all Regenerate for all API groups in the workspace / + branch of the current context. + --listen The port where you want your registry to be served + locally. By default it is 5000. --cors Do you want to enable CORS? By default false. -h, --help display help for command ``` \ No newline at end of file diff --git a/docs/commands/serve-registry.md b/docs/commands/serve-registry.md index 45ff482..3fed1b0 100644 --- a/docs/commands/serve-registry.md +++ b/docs/commands/serve-registry.md @@ -17,13 +17,13 @@ xano serve-registry [options] ```sh Usage: xano serve-registry [options] -Serve the registry locally. This allows you to actually use your registry without deploying -it. +Serve the registry locally. This allows you to actually use your registry +without deploying it. Options: --root Where did you put your registry? - --listen The port where you want your registry to be served locally. By default - it is 5000. + --listen The port where you want your registry to be served locally. + By default it is 5000. --cors Do you want to enable CORS? By default false. -h, --help display help for command ``` \ No newline at end of file diff --git a/docs/commands/switch-context.md b/docs/commands/switch-context.md index da27513..fb86ad9 100644 --- a/docs/commands/switch-context.md +++ b/docs/commands/switch-context.md @@ -21,9 +21,10 @@ Switch instance/workspace context Options: --instance The instance name. This is used to fetch the instance - configuration. The value provided at the setup command. - --workspace The workspace name. This is used to fetch the workspace - configuration. Same as on Xano interface. + configuration. The value provided at the setup + command. + --workspace The workspace name. This is used to fetch the + workspace configuration. Same as on Xano interface. --branch The branch name. This is used to select the branch configuration. Same as on Xano Interface. -h, --help display help for command diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.md index 49ef3af..08574e9 100644 --- a/packages/cli/CHANGELOG.md +++ b/packages/cli/CHANGELOG.md @@ -1,5 +1,17 @@ # @calycode/xano-cli +## 0.4.4 + +### Patch Changes + +- 1fec1a5: refactor: minor cleanup, removal of the linting command.. + fix: make backup to be stream, to allow bigger workspaces + refactor: cleanup of fs / path imports in the cli +- Updated dependencies [1fec1a5] + - @calycode/types@0.2.3 + - @calycode/utils@0.2.4 + - @calycode/core@0.4.4 + ## 0.4.3 ### Patch Changes diff --git a/packages/cli/package.json b/packages/cli/package.json index a6e7099..e7ad638 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -1,6 +1,6 @@ { "name": "@calycode/cli", - "version": "0.4.3", + "version": "0.4.4", "description": "Command-line interface for Xano providing terminal access to Xano workflows", "publishConfig": { "access": "restricted", diff --git a/packages/core/CHANGELOG.md b/packages/core/CHANGELOG.md index e86f067..0a906c1 100644 --- a/packages/core/CHANGELOG.md +++ b/packages/core/CHANGELOG.md @@ -1,5 +1,16 @@ # @calycode/caly-core +## 0.4.4 + +### Patch Changes + +- 1fec1a5: refactor: minor cleanup, removal of the linting command.. + fix: make backup to be stream, to allow bigger workspaces + refactor: cleanup of fs / path imports in the cli +- Updated dependencies [1fec1a5] + - @calycode/types@0.2.3 + - @calycode/utils@0.2.4 + ## 0.4.3 ### Patch Changes diff --git a/packages/core/package.json b/packages/core/package.json index b63173f..778121d 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -1,6 +1,6 @@ { "name": "@calycode/core", - "version": "0.4.3", + "version": "0.4.4", "description": "Core functionality for the Caly Xano tooling providing programmatic access to Xano workflows", "publishConfig": { "access": "restricted" diff --git a/packages/types/CHANGELOG.md b/packages/types/CHANGELOG.md index 8d70ccd..005d19d 100644 --- a/packages/types/CHANGELOG.md +++ b/packages/types/CHANGELOG.md @@ -1,5 +1,13 @@ # @calycode/types +## 0.2.3 + +### Patch Changes + +- 1fec1a5: refactor: minor cleanup, removal of the linting command.. + fix: make backup to be stream, to allow bigger workspaces + refactor: cleanup of fs / path imports in the cli + ## 0.2.2 ### Patch Changes diff --git a/packages/types/package.json b/packages/types/package.json index 586cef5..bda26f3 100644 --- a/packages/types/package.json +++ b/packages/types/package.json @@ -1,6 +1,6 @@ { "name": "@calycode/types", - "version": "0.2.2", + "version": "0.2.3", "description": "TypeScript type definitions for the Caly Xano tooling ecosystem", "publishConfig": { "access": "restricted" diff --git a/packages/utils/CHANGELOG.md b/packages/utils/CHANGELOG.md index 4b147ed..c7a59b8 100644 --- a/packages/utils/CHANGELOG.md +++ b/packages/utils/CHANGELOG.md @@ -1,5 +1,15 @@ # @calycode/utils +## 0.2.4 + +### Patch Changes + +- 1fec1a5: refactor: minor cleanup, removal of the linting command.. + fix: make backup to be stream, to allow bigger workspaces + refactor: cleanup of fs / path imports in the cli +- Updated dependencies [1fec1a5] + - @calycode/types@0.2.3 + ## 0.2.3 ### Patch Changes diff --git a/packages/utils/package.json b/packages/utils/package.json index 75fb3d5..e496424 100644 --- a/packages/utils/package.json +++ b/packages/utils/package.json @@ -1,6 +1,6 @@ { "name": "@calycode/utils", - "version": "0.2.3", + "version": "0.2.4", "description": "Utility functions and helpers for the Caly Xano tooling ecosystem", "publishConfig": { "access": "restricted"