From 117c25a7a88ff1d88b8bc0c3be4d7af47040f593 Mon Sep 17 00:00:00 2001 From: Alisue Date: Sun, 4 Feb 2024 16:41:25 +0900 Subject: [PATCH] :coffee: Refine GitHub Actions --- .github/workflows/mdbook.yml | 4 ++-- .github/workflows/reviewdog.yml | 18 ----------------- .github/workflows/test.yml | 34 ++++++++++++++++----------------- README.md | 3 ++- 4 files changed, 20 insertions(+), 39 deletions(-) delete mode 100644 .github/workflows/reviewdog.yml diff --git a/.github/workflows/mdbook.yml b/.github/workflows/mdbook.yml index ef8def8..b7953ff 100644 --- a/.github/workflows/mdbook.yml +++ b/.github/workflows/mdbook.yml @@ -2,7 +2,7 @@ # # To get started with mdBook see: https://rust-lang.github.io/mdBook/index.html # -name: Deploy mdBook site to Pages +name: Deploy on: # Runs on pushes targeting the default branch @@ -37,7 +37,7 @@ jobs: curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh rustup update cargo install --version ${MDBOOK_VERSION} mdbook - cargo install mdbook-plantuml + cargo install mdbook-alerts - name: Setup Pages id: pages uses: actions/configure-pages@v4 diff --git a/.github/workflows/reviewdog.yml b/.github/workflows/reviewdog.yml deleted file mode 100644 index b28394e..0000000 --- a/.github/workflows/reviewdog.yml +++ /dev/null @@ -1,18 +0,0 @@ -name: reviewdog - -on: - push: - branches: - - main - pull_request: - -jobs: - misspell: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v1 - - name: misspell - uses: reviewdog/action-misspell@v1 - with: - github_token: ${{ secrets.github_token }} - locale: "US" diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index ec33f1b..e9c1f91 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -2,21 +2,18 @@ name: Test env: DENO_VERSION: 1.x + MDBOOK_VERSION: 0.4.36 on: push: - branches: - - main pull_request: - branches: - - main jobs: test: - runs-on: ubuntu-20.04 + runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 - - uses: actions/cache@v2 + - uses: actions/checkout@v4 + - uses: actions/cache@v4 with: path: | ~/.cargo/bin/ @@ -26,17 +23,18 @@ jobs: target/ .tools/ key: ${{ runner.os }}-cargo - - uses: denoland/setup-deno@main + - uses: denoland/setup-deno@v1.1.4 with: deno-version: ${{ env.DENO_VERSION }} - - uses: actions-rs/toolchain@v1 - with: - toolchain: stable - - name: Format - run: make fmt-check - - name: Install tools - run: make tools - - name: Generate + - name: Install mdBook run: | - make gen - git diff --check + curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh + rustup update + cargo install --version ${MDBOOK_VERSION} mdbook + cargo install mdbook-alerts + - name: Build with mdBook + run: mdbook build + - name: Format + run: deno fmt --check + - name: Misspell + uses: reviewdog/action-misspell@v1.15.0 diff --git a/README.md b/README.md index cacda38..8a638ad 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ -# Denops Documentation +# denops-documentation [![Test](https://github.com/vim-denops/denops-documentation/actions/workflows/test.yml/badge.svg)](https://github.com/vim-denops/denops-documentation/actions/workflows/test.yml) +[![Deploy](https://github.com/vim-denops/denops-documentation/actions/workflows/mdbook.yml/badge.svg)](https://github.com/vim-denops/denops-documentation/actions/workflows/mdbook.yml) [![Documentation](https://img.shields.io/badge/denops-Documentation-yellow.svg)](https://vim-denops.github.io/denops-documentation/) This is an official documentation of [denops.vim], an ecosystem of Vim/Neovim