Skip to content

Commit

Permalink
Merge pull request #17 from kuzzleio/beta
Browse files Browse the repository at this point in the history
Beta
  • Loading branch information
rolljee authored Oct 23, 2024
2 parents aaa8ef2 + 1af5c33 commit 42470fe
Show file tree
Hide file tree
Showing 9 changed files with 39 additions and 19 deletions.
2 changes: 1 addition & 1 deletion .github/actions/lint/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ runs:
shell: bash
run: |
npm ci
npm run lint
npm run test:lint
2 changes: 1 addition & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnPaste": true,
"[typescript]": {
"editor.defaultFormatter": "vscode.typescript-language-features"
"editor.defaultFormatter": "esbenp.prettier-vscode"
}
}
22 changes: 21 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,35 @@
# [2.6.0](https://github.com/kuzzleio/kuzdoc/compare/v2.5.4...v2.6.0) (2023-08-28)
# [2.7.0-beta.1](https://github.com/kuzzleio/kuzdoc/compare/v2.6.0...v2.7.0-beta.1) (2024-10-23)


### Bug Fixes

* **release:** we failed to merge back ([075f476](https://github.com/kuzzleio/kuzdoc/commit/075f4767d902ae228b7396351cdca6b60855a317))


### Features

* **vuepress:** upgrade to vuepress 2, realease trigger ([9246d00](https://github.com/kuzzleio/kuzdoc/commit/9246d002efe60f27178b97a01e4b62472bfd0fca))

# [2.6.0](https://github.com/kuzzleio/kuzdoc/compare/v2.5.4...v2.6.0) (2023-08-28)

### Bug Fixes

* **actions:** remove old workflow to deploy kuzdoc ([f67d6f2](https://github.com/kuzzleio/kuzdoc/commit/f67d6f2602dff495c32857dd6f384e2755d8bcd3))


### Features


* **semantic-release:** add semantic release, lint the app and fix npm bin not available in npm@9 ([c81cb4a](https://github.com/kuzzleio/kuzdoc/commit/c81cb4ac401243c4cccde537626c7cb98cd9d22e))

# [2.6.0-beta.3](https://github.com/kuzzleio/kuzdoc/compare/v2.6.0-beta.2...v2.6.0-beta.3) (2024-10-23)


### Features

* **vuepress:** upgrade to vuepress 2, realease trigger ([9246d00](https://github.com/kuzzleio/kuzdoc/commit/9246d002efe60f27178b97a01e4b62472bfd0fca))


# [2.6.0-beta.2](https://github.com/kuzzleio/kuzdoc/compare/v2.6.0-beta.1...v2.6.0-beta.2) (2023-08-07)


Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ $ npm install -g kuzdoc
$ kuzdoc COMMAND
running command...
$ kuzdoc (-v|--version|version)
kuzdoc/2.6.0 linux-x64 node-v18.17.1
kuzdoc/2.7.0-beta.1 linux-x64 node-v20.17.0
$ kuzdoc --help [COMMAND]
USAGE
$ kuzdoc COMMAND
Expand Down Expand Up @@ -59,7 +59,7 @@ DESCRIPTION
NOTE: This command must be executed from the root of the framework meta-repo.
```

_See code: [src/commands/add-repo.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.6.0/src/commands/add-repo.ts)_
_See code: [src/commands/add-repo.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.7.0-beta.1/src/commands/add-repo.ts)_

## `kuzdoc add-section`

Expand All @@ -76,7 +76,7 @@ DESCRIPTION
NOTE: This command must be executed from the root of the framework meta-repo.
```

_See code: [src/commands/add-section.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.6.0/src/commands/add-section.ts)_
_See code: [src/commands/add-section.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.7.0-beta.1/src/commands/add-section.ts)_

## `kuzdoc build-and-deploy`

Expand Down Expand Up @@ -119,7 +119,7 @@ DESCRIPTION
be properly set.
```

_See code: [src/commands/build-and-deploy.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.6.0/src/commands/build-and-deploy.ts)_
_See code: [src/commands/build-and-deploy.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.7.0-beta.1/src/commands/build-and-deploy.ts)_

## `kuzdoc dead-links`

Expand Down Expand Up @@ -148,7 +148,7 @@ DESCRIPTION
The repository must be previously installed in the framework via the "install" command.
```

_See code: [src/commands/dead-links.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.6.0/src/commands/dead-links.ts)_
_See code: [src/commands/dead-links.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.7.0-beta.1/src/commands/dead-links.ts)_

## `kuzdoc dev`

Expand All @@ -173,7 +173,7 @@ DESCRIPTION
variable, or via the interactive prompt (only the installed repositories are listed).
```

_See code: [src/commands/dev.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.6.0/src/commands/dev.ts)_
_See code: [src/commands/dev.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.7.0-beta.1/src/commands/dev.ts)_

## `kuzdoc generate:js FILEPATH`

Expand All @@ -191,7 +191,7 @@ OPTIONS
--path=path [default: generated] Directory to write the doc
```

_See code: [src/commands/generate/js.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.6.0/src/commands/generate/js.ts)_
_See code: [src/commands/generate/js.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.7.0-beta.1/src/commands/generate/js.ts)_

## `kuzdoc help [COMMAND]`

Expand Down Expand Up @@ -256,7 +256,7 @@ DESCRIPTION
repository is already present, the selected repository will be skipped and the folder will be left untouched.
```

_See code: [src/commands/install.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.6.0/src/commands/install.ts)_
_See code: [src/commands/install.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.7.0-beta.1/src/commands/install.ts)_

## `kuzdoc local-deploy`

Expand All @@ -277,5 +277,5 @@ DESCRIPTION
All the currently installed repositories will be built and deployed to the destination path.
```

_See code: [src/commands/local-deploy.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.6.0/src/commands/local-deploy.ts)_
_See code: [src/commands/local-deploy.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.7.0-beta.1/src/commands/local-deploy.ts)_
<!-- commandsstop -->
2 changes: 1 addition & 1 deletion doc.sh
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ DOC_PATH=/sdk/js/6
export DOC_DIR=$DOC_VERSION
export SITE_BASE=$DOC_PATH/

# Used to specify --no-cache for example
# Used to specify --clean-cache for example
ARGS=${2:-""}

if [ ! -d "./$DOC_DIR" ]
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "kuzdoc",
"description": "The CLI that helps build the Kuzzle Docs",
"version": "2.6.0",
"version": "2.7.0-beta.1",
"author": "The Kuzzle Team <[email protected]>",
"bin": {
"kuzdoc": "./bin/run"
Expand Down
2 changes: 1 addition & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export {run} from '@oclif/command'
export { run } from '@oclif/command'
4 changes: 2 additions & 2 deletions src/lib/build.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export const buildRepo = (
'npm run vuepress --',
['build', repo.resolveDocPath(
path.join(frameworkPath, reposPath, repo.name)
), '--no-cache'],
), '--clean-cache'],
{
shell: true,
env: {
Expand All @@ -47,7 +47,7 @@ export const devRepo = (
'npm run vuepress --',
['dev', repo.resolveDocPath(
path.join(frameworkPath, reposPath, repo.name)
), '--no-cache'],
), '--clean-cache'],
{
shell: true,
env: {
Expand Down

0 comments on commit 42470fe

Please sign in to comment.