Skip to content

Commit

Permalink
Merge main
Browse files Browse the repository at this point in the history
  • Loading branch information
Charles-Schleich committed Dec 19, 2024
2 parents 5b43ec2 + 173ab0a commit 6e60166
Show file tree
Hide file tree
Showing 40 changed files with 5,873 additions and 258 deletions.
5 changes: 4 additions & 1 deletion .github/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,7 @@ changelog:
- dependencies
- title: Other changes
labels:
- "*"
- "*"
exclude:
labels:
- internal
11 changes: 10 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,15 @@ jobs:
- name: Transpile Library
run: |
yarn run build
markdown_lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: DavidAnson/markdownlint-cli2-action@v18
with:
config: '.markdownlint.yaml'
globs: '**/README.md'

# NOTE: In GitHub repository settings, the "Require status checks to pass
# before merging" branch protection rule ensures that commits are only merged
Expand All @@ -86,7 +95,7 @@ jobs:
ci:
name: CI status checks
runs-on: ubuntu-latest
needs: [build-rs, build-ts]
needs: [build-rs, build-ts, markdown_lint]
if: always()
steps:
- name: Check whether all jobs pass
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ zenoh-plugin-remote-api/target/**
zenoh-plugin-remote-api/bindings/**
**/target/**
**/node_modules/**
**/dist/**
**/dist/**
6 changes: 6 additions & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"MD013": false, # Line length limitation
"MD033": false, # Enable Inline HTML
"MD041": false, # Allow first line heading
"MD045": false, # Allow Images have no alternate text
}
54 changes: 27 additions & 27 deletions Cargo.lock

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

1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ ts-rs = { version = "9.0", features = [
"uuid-impl",
"serde-json-impl",
"no-serde-warnings",
"import-esm",
] }
tracing = "0.1"
schemars = { version = "0.8.12", features = ["either"] }
Expand Down
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,9 +114,9 @@ The file `EXAMPLE_CONFIG.json5` references the `zenoh-plugin-remote-api\EXAMPLE_

1. Make sure that the following utilities are available on your platform.

- [NPM](https://www.npmjs.com/package/npm)
- [yarn](https://classic.yarnpkg.com/lang/en/docs/install/#debian-stable)
- [Typescript](https://www.typescriptlang.org/download/)
- [NPM](https://www.npmjs.com/package/npm)
- [yarn](https://classic.yarnpkg.com/lang/en/docs/install/#debian-stable)
- [Typescript](https://www.typescriptlang.org/download/)

2. Navigate to the directory `zenoh-ts`

Expand Down Expand Up @@ -166,3 +166,5 @@ The latest version of zenoh-ts library can be installed from npm:
```sh
npm install @eclipse-zenoh/zenoh-ts
```

See also example application in the [zenoh-ts/examples/chat](zenoh-ts/examples/chat/README.md)
5 changes: 5 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"dependencies": {
"copy-webpack-plugin": "^12.0.2"
}
}
Loading

0 comments on commit 6e60166

Please sign in to comment.