This is an automated email from the ASF dual-hosted git repository.
xuanwo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-opendal.git
The following commit(s) were added to refs/heads/main by this push:
new 9ac2a39f6 docs: Add docs on website for GHAC service (#3296)
9ac2a39f6 is described below
commit 9ac2a39f693c2fbf0aa7daa6f869f7707bd887ad
Author: Nadeshiko Manju <[email protected]>
AuthorDate: Mon Oct 16 15:34:56 2023 +0800
docs: Add docs on website for GHAC service (#3296)
Signed-off-by: Manjusaka <[email protected]>
---
core/src/services/ghac/backend.rs | 86 +--------------------------------------
core/src/services/ghac/docs.md | 85 ++++++++++++++++++++++++++++++++++++++
website/docs/services/ghac.mdx | 60 +++++++++++++++++++++++++++
3 files changed, 146 insertions(+), 85 deletions(-)
diff --git a/core/src/services/ghac/backend.rs
b/core/src/services/ghac/backend.rs
index c463fd2a7..83c6a46d6 100644
--- a/core/src/services/ghac/backend.rs
+++ b/core/src/services/ghac/backend.rs
@@ -81,91 +81,7 @@ fn value_or_env(
}
/// GitHub Action Cache Services support.
-///
-/// # Capabilities
-///
-/// This service can be used to:
-///
-/// - [x] stat
-/// - [x] read
-/// - [x] write
-/// - [x] create_dir
-/// - [x] delete
-/// - [x] copy
-/// - [ ] rename
-/// - [ ] list
-/// - [ ] scan
-/// - [ ] presign
-/// - [ ] blocking
-/// # Notes
-///
-/// This service is mainly provided by github actions.
-///
-/// Refer to [Caching dependencies to speed up
workflows](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows)
for more information.
-///
-/// To make this service work as expected, please make sure to either call
`endpoint` and `token` to
-/// configure the URL and credentials, or that the following environment has
been setup correctly:
-///
-/// - `ACTIONS_CACHE_URL`
-/// - `ACTIONS_RUNTIME_TOKEN`
-///
-/// They can be exposed by following action:
-///
-/// ```yaml
-/// - name: Configure Cache Env
-/// uses: actions/github-script@v6
-/// with:
-/// script: |
-/// core.exportVariable('ACTIONS_CACHE_URL',
process.env.ACTIONS_CACHE_URL || '');
-/// core.exportVariable('ACTIONS_RUNTIME_TOKEN',
process.env.ACTIONS_RUNTIME_TOKEN || '');
-/// ```
-///
-/// To make `delete` work as expected, `GITHUB_TOKEN` should also be set via:
-///
-/// ```yaml
-/// env:
-/// GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-/// ```
-///
-/// # Limitations
-///
-/// Unlike other services, ghac doesn't support create empty files.
-/// We provide a `enable_create_simulation()` to support this operation but
may result unexpected side effects.
-///
-/// Also, `ghac` is a cache service which means the data store inside could
-/// be automatically evicted at any time.
-///
-/// # Configuration
-///
-/// - `root`: Set the work dir for backend.
-///
-/// Refer to [`GhacBuilder`]'s public API docs for more information.
-///
-/// # Example
-///
-/// ## Via Builder
-///
-/// ```no_run
-/// use std::sync::Arc;
-///
-/// use anyhow::Result;
-/// use opendal::services::Ghac;
-/// use opendal::Operator;
-///
-/// #[tokio::main]
-/// async fn main() -> Result<()> {
-/// // Create ghac backend builder.
-/// let mut builder = Ghac::default();
-/// // Set the root for ghac, all operations will happen under this root.
-/// //
-/// // NOTE: the root must be absolute path.
-/// builder.root("/path/to/dir");
-///
-/// let op: Operator = Operator::new(builder)?.finish();
-///
-/// Ok(())
-/// }
-/// ```
+#[doc = include_str!("docs.md")]
#[derive(Debug, Default)]
pub struct GhacBuilder {
root: Option<String>,
diff --git a/core/src/services/ghac/docs.md b/core/src/services/ghac/docs.md
new file mode 100644
index 000000000..c58687d24
--- /dev/null
+++ b/core/src/services/ghac/docs.md
@@ -0,0 +1,85 @@
+## Capabilities
+
+This service can be used to:
+
+- [x] stat
+- [x] read
+- [x] write
+- [x] create_dir
+- [x] delete
+- [x] copy
+- [ ] rename
+- [ ] list
+- [ ] scan
+- [ ] presign
+- [ ] blocking
+
+## Notes
+
+This service is mainly provided by github actions.
+
+Refer to [Caching dependencies to speed up
workflows](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows)
for more information.
+
+To make this service work as expected, please make sure to either call
`endpoint` and `token` to
+configure the URL and credentials, or that the following environment has been
setup correctly:
+
+- `ACTIONS_CACHE_URL`
+- `ACTIONS_RUNTIME_TOKEN`
+
+They can be exposed by following action:
+
+```yaml
+- name: Configure Cache Env
+ uses: actions/github-script@v6
+ with:
+ script: |
+ core.exportVariable('ACTIONS_CACHE_URL', process.env.ACTIONS_CACHE_URL
|| '');
+ core.exportVariable('ACTIONS_RUNTIME_TOKEN',
process.env.ACTIONS_RUNTIME_TOKEN || '');
+```
+
+To make `delete` work as expected, `GITHUB_TOKEN` should also be set via:
+
+```yaml
+env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+## Limitations
+
+Unlike other services, ghac doesn't support create empty files.
+We provide a `enable_create_simulation()` to support this operation but may
result unexpected side effects.
+
+Also, `ghac` is a cache service which means the data store inside could
+be automatically evicted at any time.
+
+## Configuration
+
+- `root`: Set the work dir for backend.
+
+Refer to [`GhacBuilder`]'s public API docs for more information.
+
+## Example
+
+### Via Builder
+
+```no_run
+use std::sync::Arc;
+
+use anyhow::Result;
+use opendal::services::Ghac;
+use opendal::Operator;
+
+#[tokio::main]
+async fn main() -> Result<()> {
+ // Create ghac backend builder.
+ let mut builder = Ghac::default();
+ // Set the root for ghac, all operations will happen under this root.
+ //
+ // NOTE: the root must be absolute path.
+ builder.root("/path/to/dir");
+
+ let op: Operator = Operator::new(builder)?.finish();
+
+ Ok(())
+}
+```
diff --git a/website/docs/services/ghac.mdx b/website/docs/services/ghac.mdx
new file mode 100644
index 000000000..f71dfb1db
--- /dev/null
+++ b/website/docs/services/ghac.mdx
@@ -0,0 +1,60 @@
+---
+title: GHAC
+---
+
+[GitHub Action
Cache](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows)
service support
+
+import Docs from '../../../core/src/services/ghac/docs.md'
+
+<Docs components={props.components} />
+
+### Via Config
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<Tabs>
+ <TabItem value="rust" label="Rust" default>
+
+```rust
+use anyhow::Result;
+use opendal::services::Ghac;
+use opendal::Operator;
+
+#[tokio::main]
+async fn main() -> Result<()> {
+
+ let mut map = HashMap::new();
+ map.insert("root".to_string(), "/path/to/dir".to_string());
+
+ let op: Operator = Operator::via_map(Scheme::Ghac, map)?;
+ Ok(())
+}
+```
+
+ </TabItem>
+ <TabItem value="node.js" label="Node.js">
+
+```javascript
+import { Operator } from require('opendal');
+
+async function main() {
+ const op = new Operator("ghac", {
+ root: '/path/to/dir'
+ });
+}
+```
+
+ </TabItem>
+ <TabItem value="python" label="Python">
+
+```python
+import opendal
+
+op = opendal.Operator("ghac", {
+ "root": "/path/to/dir"
+})
+```
+
+ </TabItem>
+</Tabs>
