You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@opendal.apache.org by "suyanhanx (via GitHub)" <gi...@apache.org> on 2023/03/15 13:33:08 UTC
[GitHub] [incubator-opendal] suyanhanx opened a new pull request, #1625: feat(bindings/nodejs): Auto-generate docs
suyanhanx opened a new pull request, #1625:
URL: https://github.com/apache/incubator-opendal/pull/1625
I hereby agree to the terms of the CLA available at: https://databend.rs/dev/policies/cla/
## Summary
Auto-generate docs of bindings/nodejs
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-opendal] Xuanwo commented on a diff in pull request #1625: feat(bindings/nodejs): Auto-generate docs
Posted by "Xuanwo (via GitHub)" <gi...@apache.org>.
Xuanwo commented on code in PR #1625:
URL: https://github.com/apache/incubator-opendal/pull/1625#discussion_r1138026934
##########
website/docusaurus.config.js:
##########
@@ -95,6 +95,10 @@ const config = {
label: 'Rust',
to: '/docs/rust/opendal/'
},
+ {
+ label: 'Node.js',
+ to: 'https://opendal.databend.rs/docs/nodejs/'
Review Comment:
```suggestion
to: '/docs/nodejs/'
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-opendal] Xuanwo commented on a diff in pull request #1625: feat(bindings/nodejs): Auto-generate docs
Posted by "Xuanwo (via GitHub)" <gi...@apache.org>.
Xuanwo commented on code in PR #1625:
URL: https://github.com/apache/incubator-opendal/pull/1625#discussion_r1137193611
##########
bindings/nodejs/.cargo/config.toml:
##########
@@ -0,0 +1,20 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+[target.aarch64-unknown-linux-musl]
+linker = "aarch64-linux-musl-gcc"
+rustflags = ["-C", "target-feature=-crt-static"]
Review Comment:
Let's remove the whole file directly. We didn't have musl build so far.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-opendal] Xuanwo commented on pull request #1625: feat(bindings/nodejs): Auto-generate docs
Posted by "Xuanwo (via GitHub)" <gi...@apache.org>.
Xuanwo commented on PR #1625:
URL: https://github.com/apache/incubator-opendal/pull/1625#issuecomment-1471205062
Btw, the link here is broken too:
Can you give it fix?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-opendal] Xuanwo commented on pull request #1625: feat(bindings/nodejs): Auto-generate docs
Posted by "Xuanwo (via GitHub)" <gi...@apache.org>.
Xuanwo commented on PR #1625:
URL: https://github.com/apache/incubator-opendal/pull/1625#issuecomment-1471222882
Great!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-opendal] Xuanwo commented on a diff in pull request #1625: feat(bindings/nodejs): Auto-generate docs
Posted by "Xuanwo (via GitHub)" <gi...@apache.org>.
Xuanwo commented on code in PR #1625:
URL: https://github.com/apache/incubator-opendal/pull/1625#discussion_r1138010883
##########
.github/workflows/docs.yml:
##########
@@ -69,6 +69,28 @@ jobs:
path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+ # Build bindings/nodejs docs
+ - name: Corepack
+ working-directory: bindings/nodejs
+ run: corepack enable
+
+ - name: Install dependencies
+ working-directory: bindings/nodejs
+ run: yarn install
+
+ - name: Build
+ working-directory: bindings/nodejs
+ run: yarn build
+
+ - name: Build bindings/nodejs Docs
+ working-directory: bindings/nodejs
+ run: yarn docs
+
+ - name: Copy docs into build
+ run: |
+ cp -r ./bindings/nodejs/docs ./website/static/docs/js
Review Comment:
Is `js` and `nodejs` the same? Maybe we should use `nodejs` here?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-opendal] suyanhanx commented on a diff in pull request #1625: feat(bindings/nodejs): Auto-generate docs
Posted by "suyanhanx (via GitHub)" <gi...@apache.org>.
suyanhanx commented on code in PR #1625:
URL: https://github.com/apache/incubator-opendal/pull/1625#discussion_r1138012569
##########
.github/workflows/docs.yml:
##########
@@ -69,6 +69,28 @@ jobs:
path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+ # Build bindings/nodejs docs
+ - name: Corepack
+ working-directory: bindings/nodejs
+ run: corepack enable
+
+ - name: Install dependencies
+ working-directory: bindings/nodejs
+ run: yarn install
+
+ - name: Build
+ working-directory: bindings/nodejs
+ run: yarn build
+
+ - name: Build bindings/nodejs Docs
+ working-directory: bindings/nodejs
+ run: yarn docs
+
+ - name: Copy docs into build
+ run: |
+ cp -r ./bindings/nodejs/docs ./website/static/docs/js
Review Comment:
Make sense.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-opendal] Xuanwo merged pull request #1625: feat(bindings/nodejs): Auto-generate docs
Posted by "Xuanwo (via GitHub)" <gi...@apache.org>.
Xuanwo merged PR #1625:
URL: https://github.com/apache/incubator-opendal/pull/1625
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-opendal] suyanhanx commented on a diff in pull request #1625: feat(bindings/nodejs): Auto-generate docs
Posted by "suyanhanx (via GitHub)" <gi...@apache.org>.
suyanhanx commented on code in PR #1625:
URL: https://github.com/apache/incubator-opendal/pull/1625#discussion_r1137108103
##########
bindings/nodejs/.cargo/config.toml:
##########
@@ -0,0 +1,20 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+[target.aarch64-unknown-linux-musl]
+linker = "aarch64-linux-musl-gcc"
+rustflags = ["-C", "target-feature=-crt-static"]
Review Comment:
If this part is added to Cargo.toml, it will generate some warnings like `unused manifest key: target.aarch64-unknown-linux-musl.linker` on other platforms.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-opendal] suyanhanx commented on pull request #1625: feat(bindings/nodejs): Auto-generate docs
Posted by "suyanhanx (via GitHub)" <gi...@apache.org>.
suyanhanx commented on PR #1625:
URL: https://github.com/apache/incubator-opendal/pull/1625#issuecomment-1471205620
> Can you give it fix?
No problem.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org