Skip to content

Commit dd08233

Browse files
MihalyToth20MihalyToth20
authored
Release Version (#77)
2 parents ae001a5 + 3803332 commit dd08233

23 files changed

+162
-107
lines changed

‎.changeset/warm-dodos-decide.md‎

Lines changed: 0 additions & 10 deletions
This file was deleted.

‎.github/workflows/add-docs-to-release.yml‎

Lines changed: 49 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -2,42 +2,54 @@
22
name: Generate Docs
33

44
on:
5-
pull_request:
6-
types: [opened, synchronize]
7-
branches:
8-
- main
5+
pull_request:
6+
types: [opened, synchronize]
7+
branches:
8+
- main
99

1010
jobs:
11-
generate-docs:
12-
if: github.repository == 'calycode/xano-tools' && github.repository_owner == 'calycode' && startsWith(github.head_ref, 'changeset-release')
13-
runs-on: ubuntu-latest
14-
steps:
15-
- uses: actions/checkout@v4
16-
with:
17-
token: ${{ secrets.CHANGESETS_GH_TOKEN }}
18-
19-
- uses: pnpm/action-setup@v4
20-
with:
21-
version: 10
22-
run_install: true
23-
24-
- uses: actions/setup-node@v4
25-
with:
26-
node-version: 20.x
27-
28-
- name: Install packages
29-
run: pnpm install
30-
31-
- name: Build packages
32-
run: pnpm build:packages
33-
34-
- name: Build Docs
35-
run: pnpm build:docs
36-
37-
- name: Commit and push docs
38-
run: |
39-
git config user.name "github-actions[bot]"
40-
git config user.email "github-actions[bot]@users.noreply.github.com"
41-
git add docs
42-
git commit -m "chore: update docs [skip ci]" || echo "No changes to commit"
43-
git push origin HEAD:main --force-with-lease
11+
generate-docs:
12+
if: github.repository == 'calycode/xano-tools' && github.repository_owner == 'calycode' && startsWith(github.head_ref, 'changeset-release')
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v4
16+
with:
17+
token: ${{ secrets.CHANGESETS_GH_TOKEN }}
18+
19+
- uses: pnpm/action-setup@v4
20+
with:
21+
version: 10
22+
run_install: true
23+
24+
- uses: actions/setup-node@v4
25+
with:
26+
node-version: 20.x
27+
28+
- name: Install packages
29+
run: pnpm install
30+
31+
- name: Build packages
32+
run: pnpm build:packages
33+
34+
- name: Build Docs
35+
run: pnpm build:docs
36+
37+
- name: Commit docs
38+
id: commit_docs
39+
run: |
40+
git add docs
41+
if git diff --cached --quiet; then
42+
echo "No changes to commit."
43+
echo "commit=false" >> $GITHUB_OUTPUT
44+
else
45+
git commit -m "chore: update docs [skip ci]"
46+
echo "commit=true" >> $GITHUB_OUTPUT
47+
fi
48+
49+
- name: Push docs (only if commit was made)
50+
if: steps.commit_docs.outputs.commit == 'true'
51+
run: |
52+
git config user.name "github-actions[bot]"
53+
git config user.email "github-actions[bot]@users.noreply.github.com"
54+
git push origin HEAD:${GITHUB_HEAD_REF} --force-with-lease
55+

‎docs/README.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,7 @@ I have been astonished by the shadcn/ui CLI and the core principles of code dist
141141
- [x] **Scaffolding a registry** of reusable Xano components
142142
- [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)_.
143143
- [x] Adding components to Xano from a registry (only functions, tables, queries for now)
144-
- [ ] Automated test runner with assertion configuration
145-
- [ ] Linting with custom rulesets
144+
- [x] Automated test runner with assertion configuration
146145

147146
---
148147

‎docs/commands/export-backup.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,10 @@ Backup Xano Workspace via Metadata API
2323

2424
Options:
2525
--instance <instance> The instance name. This is used to fetch the instance
26-
configuration. The value provided at the setup command.
27-
--workspace <workspace> The workspace name. This is used to fetch the workspace
28-
configuration. Same as on Xano interface.
26+
configuration. The value provided at the setup
27+
command.
28+
--workspace <workspace> The workspace name. This is used to fetch the
29+
workspace configuration. Same as on Xano interface.
2930
--branch <branch> The branch name. This is used to select the branch
3031
configuration. Same as on Xano Interface.
3132
--print-output-dir Expose usable output path for further reuse.

‎docs/commands/generate-code.md‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,25 +29,27 @@ xano generate-code [options]
2929
```sh
3030
Usage: xano generate-code [options]
3131

32-
Create a library based on the OpenAPI specification. If the openapi specification has not
33-
yet been generated, this will generate that as well as the first step.
32+
Create a library based on the OpenAPI specification. If the openapi
33+
specification has not yet been generated, this will generate that as well as the
34+
first step.
3435

3536
Options:
3637
--instance <instance> The instance name. This is used to fetch the instance
37-
configuration. The value provided at the setup command.
38-
--workspace <workspace> The workspace name. This is used to fetch the workspace
39-
configuration. Same as on Xano interface.
38+
configuration. The value provided at the setup
39+
command.
40+
--workspace <workspace> The workspace name. This is used to fetch the
41+
workspace configuration. Same as on Xano interface.
4042
--branch <branch> The branch name. This is used to select the branch
4143
configuration. Same as on Xano Interface.
4244
--group <name> API group name. Same as on Xano Interface.
43-
--all Regenerate for all API groups in the workspace / branch of the
44-
current context.
45+
--all Regenerate for all API groups in the workspace /
46+
branch of the current context.
4547
--print-output-dir Expose usable output path for further reuse.
4648
--generator <generator> Generator to use, see all options at:
4749
https://openapi-generator.tech/docs/generators
4850
--args <args> Additional arguments to pass to the generator. See
4951
https://openapi-generator.tech/docs/usage#generate
50-
--debug Specify this flag in order to allow logging. Logs will appear in
51-
output/_logs. Default: false
52+
--debug Specify this flag in order to allow logging. Logs
53+
will appear in output/_logs. Default: false
5254
-h, --help display help for command
5355
```

‎docs/commands/generate-oas.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,15 @@ Update and generate OpenAPI spec(s) for the current context.
2727

2828
Options:
2929
--instance <instance> The instance name. This is used to fetch the instance
30-
configuration. The value provided at the setup command.
31-
--workspace <workspace> The workspace name. This is used to fetch the workspace
32-
configuration. Same as on Xano interface.
30+
configuration. The value provided at the setup
31+
command.
32+
--workspace <workspace> The workspace name. This is used to fetch the
33+
workspace configuration. Same as on Xano interface.
3334
--branch <branch> The branch name. This is used to select the branch
3435
configuration. Same as on Xano Interface.
3536
--group <name> API group name. Same as on Xano Interface.
36-
--all Regenerate for all API groups in the workspace / branch of the
37-
current context.
37+
--all Regenerate for all API groups in the workspace /
38+
branch of the current context.
3839
--print-output-dir Expose usable output path for further reuse.
3940
-h, --help display help for command
4041
```

‎docs/commands/generate-repo.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,14 @@ Options:
3131
--input <file> workspace yaml file
3232
--output <dir> output directory (overrides config)
3333
--instance <instance> The instance name. This is used to fetch the instance
34-
configuration. The value provided at the setup command.
35-
--workspace <workspace> The workspace name. This is used to fetch the workspace
36-
configuration. Same as on Xano interface.
34+
configuration. The value provided at the setup
35+
command.
36+
--workspace <workspace> The workspace name. This is used to fetch the
37+
workspace configuration. Same as on Xano interface.
3738
--branch <branch> The branch name. This is used to select the branch
3839
configuration. Same as on Xano Interface.
3940
--print-output-dir Expose usable output path for further reuse.
40-
--fetch Specify this if you want to fetch the workspace schema from Xano
41+
--fetch Specify this if you want to fetch the workspace
42+
schema from Xano
4143
-h, --help display help for command
4244
```

‎docs/commands/generate-xs-repo.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,10 @@ Process Xano workspace into repo structure
2323

2424
Options:
2525
--instance <instance> The instance name. This is used to fetch the instance
26-
configuration. The value provided at the setup command.
27-
--workspace <workspace> The workspace name. This is used to fetch the workspace
28-
configuration. Same as on Xano interface.
26+
configuration. The value provided at the setup
27+
command.
28+
--workspace <workspace> The workspace name. This is used to fetch the
29+
workspace configuration. Same as on Xano interface.
2930
--branch <branch> The branch name. This is used to select the branch
3031
configuration. Same as on Xano Interface.
3132
--print-output-dir Expose usable output path for further reuse.

‎docs/commands/registry-add.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,10 @@ Add a prebuilt component to the current Xano context.
2525

2626
Options:
2727
--instance <instance> The instance name. This is used to fetch the instance
28-
configuration. The value provided at the setup command.
29-
--workspace <workspace> The workspace name. This is used to fetch the workspace
30-
configuration. Same as on Xano interface.
28+
configuration. The value provided at the setup
29+
command.
30+
--workspace <workspace> The workspace name. This is used to fetch the
31+
workspace configuration. Same as on Xano interface.
3132
--branch <branch> The branch name. This is used to select the branch
3233
configuration. Same as on Xano Interface.
3334
--components Comma-separated list of components to add

‎docs/commands/registry-scaffold.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,11 @@ xano registry-scaffold [options]
1515
```sh
1616
Usage: xano registry-scaffold [options]
1717

18-
Scaffold a Xano registry folder with a sample component. Xano registry can be used to share
19-
and reuse prebuilt components. In the registry you have to follow the
20-
[registry](https://nextcurve.hu/schemas/registry/registry.json) and [registry
21-
item](https://nextcurve.hu/schemas/registry/registry-item.json) schemas.
18+
Scaffold a Xano registry folder with a sample component. Xano registry can be
19+
used to share and reuse prebuilt components. In the registry you have to follow
20+
the [registry](https://nextcurve.hu/schemas/registry/registry.json) and
21+
[registry item](https://nextcurve.hu/schemas/registry/registry-item.json)
22+
schemas.
2223

2324
Options:
2425
--output <path> Output path for the registry

0 commit comments

Comments
 (0)