Skip to content

Commit 3be050f

Browse files
authored
ci: add link and typo check (#323)
Signed-off-by: Keming <[email protected]>
1 parent 018bd39 commit 3be050f

File tree

10 files changed

+51
-22
lines changed

10 files changed

+51
-22
lines changed

.github/workflows/autocorrect.yml

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

.github/workflows/check.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: lint and check
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- main
7+
8+
jobs:
9+
auto-correct:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Check source code
13+
uses: actions/checkout@v5
14+
15+
- name: AutoCorrect
16+
uses: huacnlee/autocorrect-action@main
17+
18+
- name: Spell Check Repo
19+
uses: crate-ci/typos@v1
20+
21+
- name: Link Checker
22+
id: lychee
23+
uses: lycheeverse/lychee-action@v2
24+
with:
25+
fail: false

docs-zh/community/community.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
我们期待着你的加入!
66

77

8-
- <a href="https://discord.gg/KqswhpVgdU"><img alt="discord invitation link" src="https://dcbadge.vercel.app/api/server/KqswhpVgdU?style=flat"></a> 加入我们的 Discord 服务器!我们的社区充满了友好的成员,他们随时准备帮助回答你的任何问题。
8+
- <a href="https://discord.gg/KqswhpVgdU"><img alt="discord invitation link" src="https://img.shields.io/discord/974584200327991326?style=flat&logo=discord&cacheSeconds=60"></a> 加入我们的 Discord 服务器!我们的社区充满了友好的成员,他们随时准备帮助回答你的任何问题。
99
- <a href="https://twitter.com/TensorChord"><img src="https://img.shields.io/twitter/follow/tensorchord?style=social" alt="trackgit-views" /></a> 关注 twitter [@TensorChord](https://twitter.com/TensorChord) 并保持与最新更新的联系。
1010
- <a href="https://www.youtube.com/channel/UCCA7u-PLO1fP8j1X7Pgut1Q"><img src="https://img.shields.io/youtube/channel/subscribers/UCCA7u-PLO1fP8j1X7Pgut1Q?style=social"></a> 考虑在 YouTube 上订阅 [@TensorChord](https://www.youtube.com/channel/UCCA7u-PLO1fP8j1X7Pgut1Q),以确保你不会错过我们的任何新视频。
1111

docs-zh/developers/development.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525
- [📁 builder/](https://github.com/tensorchord/envd/tree/main/pkg/builder) 包含 buildkit 的建造器,它是项目中非常重要的一个部分。建造器会将 starlark 编译成 [buildkit LLB](https://github.com/moby/buildkit#exploring-llb),然后再构造镜像。
2626
- [📁 buildkitd/](https://github.com/tensorchord/envd/tree/main/pkg/buildkitd) 包含连接 buildkitd 容器的客户端代码。
2727
- [📁 config/](https://github.com/tensorchord/envd/tree/main/pkg/config) 包含 `envd` 的配置文件。
28-
- [📁 docker/](https://github.com/tensorchord/envd/tree/main/pkg/docker) 包含使用 docker 进程的客户端代码。
2928
- [📁 editor/](https://github.com/tensorchord/envd/tree/main/pkg/editor) 包含 vscode 和 jupyter 相关的代码实现。
3029
- [📁 envd/](https://github.com/tensorchord/envd/tree/main/pkg/envd) 包含 `envd` 引擎代码,它是一个用来管理 `envd` 环境的抽象层。
3130
- [📁 flag/](https://github.com/tensorchord/envd/tree/main/pkg/flag) 包含[viper](https://github.com/spf13/viper)`flags` 信息。

docs-zh/guide/concepts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## 核心设计
88

9-
`envd` 的核心抽象是 **环境****镜像**。镜像由 `build.envd` 构建,并且遵循 [docker 镜像规范 v1.2](https://github.com/moby/moby/blob/master/image/spec/v1.2.md)。因此,您可以将 `envd` 构建的镜像使用 Docker 来运行。
9+
`envd` 的核心抽象是 **环境****镜像**。镜像由 `build.envd` 构建,并且遵循 [docker 镜像规范](https://github.com/moby/docker-image-spec/blob/main/spec.md)。因此,您可以将 `envd` 构建的镜像使用 Docker 来运行。
1010

1111
环境是由 docker、Kubernetes 或其他一些与 OCI([Open Container Initiative](https://github.com/opencontainers/runtime-spec)) 规范兼容的运行时(如 runc、crun、containerd)运行的容器。
1212

docs/community/community.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ envd is an open-source project that strives for continual improvement and would
44

55
We look forward to having you on board!
66

7-
- <a href="https://discord.gg/KqswhpVgdU"><img alt="discord invitation link" src="https://dcbadge.vercel.app/api/server/KqswhpVgdU?style=flat"></a> Join our discord server! Our community is full of friendly members who are ready to help answer any questions you may have.
7+
- <a href="https://discord.gg/KqswhpVgdU"><img alt="discord invitation link" src="https://img.shields.io/discord/974584200327991326?style=flat&logo=discord&cacheSeconds=60"></a> Join our discord server! Our community is full of friendly members who are ready to help answer any questions you may have.
88
- <a href="https://twitter.com/TensorChord"><img src="https://img.shields.io/twitter/follow/tensorchord?style=social" alt="trackgit-views" /></a> Follow the twitter [@TensorChord](https://twitter.com/TensorChord) and stay connected with the latest updates.
99
- <a href="https://www.youtube.com/channel/UCCA7u-PLO1fP8j1X7Pgut1Q"><img src="https://img.shields.io/youtube/channel/subscribers/UCCA7u-PLO1fP8j1X7Pgut1Q?style=social"></a> Consider subscribing to [@TensorChord](https://www.youtube.com/channel/UCCA7u-PLO1fP8j1X7Pgut1Q) on YouTube to ensure you don't miss any of our new videos.
1010

docs/developers/development.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ There are a lot of files here! Here's a brief overview. It can be confusing, but
2828
- [📁 builder/](https://github.com/tensorchord/envd/tree/main/pkg/builder) contains the buildkit builder, which is one of the most important parts. The builder compiles starlark to [buildkit LLB](https://github.com/moby/buildkit#exploring-llb), then builds the image.
2929
- [📁 buildkitd/](https://github.com/tensorchord/envd/tree/main/pkg/buildkitd) contains the client code to connect to the buildkitd container.
3030
- [📁 config/](https://github.com/tensorchord/envd/tree/main/pkg/config) contains the `envd` configuration.
31-
- [📁 docker/](https://github.com/tensorchord/envd/tree/main/pkg/docker) contains the client code to docker daemon.
3231
- [📁 editor/](https://github.com/tensorchord/envd/tree/main/pkg/editor) contains vscode or jupyter related implementation.
3332
- [📁 envd/](https://github.com/tensorchord/envd/tree/main/pkg/envd) contains the `envd` engine, which is the abstraction to manage `envd` environments.
3433
- [📁 flag/](https://github.com/tensorchord/envd/tree/main/pkg/flag) contains the information of [viper](https://github.com/spf13/viper) flags.

docs/guide/concepts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This doc describes concepts in the `envd`. The name `envd` is inspired by system
66

77
## Concepts
88

9-
The core abstractions in `envd` are **environments** and **images**. Images are built from the given `build.envd`s and follow [docker image spec v1.2](https://github.com/moby/moby/blob/master/image/spec/v1.2.md). Thus you can use the images built by `envd` with Docker directly.
9+
The core abstractions in `envd` are **environments** and **images**. Images are built from the given `build.envd`s and follow [docker image spec](https://github.com/moby/docker-image-spec/blob/main/spec.md). Thus you can use the images built by `envd` with Docker directly.
1010

1111
Environments are containers run by docker, Kubernetes, or some other OCI runtime spec-compatible runtimes (e.g. runc, crun, containerd).
1212

lychee.toml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
scheme = ["https", "http"]
2+
fallback_extensions = ["md"]
3+
accept = [
4+
"200..=204",
5+
"403", # HuggingFace
6+
"500..=599"
7+
]
8+
exclude = [
9+
"^https://docker.mirrors.sjtug.sjtu.edu.cn",
10+
"^https://hub-mirror.c.163.com",
11+
"^https://segment.com",
12+
"^https://github.com/aseaday$", # 404
13+
"^https://www.github.com/aseaday.png$", # 404
14+
"^https://tensorchord.feishu.cn/docx/", # too many redirects
15+
]

typos.toml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
[files]
2+
extend-exclude = ["*.svg"]
3+
4+
[default.extend-words]
5+
loca = "loca"
6+
Jod = "Jod"
7+
Iif = "Iif"

0 commit comments

Comments
 (0)