Skip to content

Commit

Permalink
Merge pull request #438 from jontze/release/v3.0.0
Browse files Browse the repository at this point in the history
Release v3.0.0
  • Loading branch information
jontze authored Nov 2, 2023
2 parents f3cad5c + 88a1d60 commit da53c89
Show file tree
Hide file tree
Showing 8 changed files with 1,764 additions and 1,511 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ jobs:
strategy:
matrix:
os: [ubuntu-20.04, ubuntu-22.04]
version: [14, 16, 18]
version: [18, 20]
runs-on: ${{ matrix.os }}
name: Test action with Node v${{ matrix.version }} and ${{ matrix.os }}
steps:
Expand Down
14 changes: 7 additions & 7 deletions .github/workflows/scheduled.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
fail-fast: false
matrix:
os: [ubuntu-20.04, ubuntu-22.04]
version: [14, 16, 18]
version: [18, 20]
runs-on: ${{ matrix.os }}
name: MdBook (Node ${{ matrix.version }} - ${{ matrix.os }})
steps:
Expand All @@ -33,7 +33,7 @@ jobs:
fail-fast: false
matrix:
os: [ubuntu-20.04, ubuntu-22.04]
version: [14, 16, 18]
version: [18, 20]
runs-on: ${{ matrix.os }}
name: Mdbook Linkcheck (Node ${{ matrix.version }} - ${{ matrix.os }})
steps:
Expand All @@ -56,7 +56,7 @@ jobs:
fail-fast: false
matrix:
os: [ubuntu-20.04, ubuntu-22.04]
version: [14, 16, 18]
version: [18, 20]
runs-on: ${{ matrix.os }}
name: Mdbook Mermaid (Node ${{ matrix.version }} - ${{ matrix.os }})
steps:
Expand All @@ -79,7 +79,7 @@ jobs:
fail-fast: false
matrix:
os: [ubuntu-20.04, ubuntu-22.04]
version: [14, 16, 18]
version: [18, 20]
runs-on: ${{ matrix.os }}
name: Mdbook ToC (Node ${{ matrix.version }} - ${{ matrix.os }})
steps:
Expand All @@ -102,7 +102,7 @@ jobs:
fail-fast: false
matrix:
os: [ubuntu-20.04, ubuntu-22.04]
version: [14, 16, 18]
version: [18, 20]
runs-on: ${{ matrix.os }}
name: Mdbook OpenOnGh (Node ${{ matrix.version }} - ${{ matrix.os }})
steps:
Expand All @@ -125,7 +125,7 @@ jobs:
fail-fast: false
matrix:
os: [ubuntu-20.04, ubuntu-22.04]
version: [14, 16, 18]
version: [18, 20]
runs-on: ${{ matrix.os }}
name: Mdbook Admonish (Node ${{ matrix.version }} - ${{ matrix.os }})
steps:
Expand All @@ -148,7 +148,7 @@ jobs:
fail-fast: false
matrix:
os: [ubuntu-20.04, ubuntu-22.04]
version: [14, 16, 18]
version: [18, 20]
runs-on: ${{ matrix.os }}
name: Mdbook Katex (Node ${{ matrix.version }} - ${{ matrix.os }})
steps:
Expand Down
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v16
v20
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@

## Introduction

This is an github action to set up the [rust-lang/mdBook](https://github.com/rust-lang/mdBook) with some [supported plugins](#supported-plugins).
This is an GitHub Action to set up the [rust-lang/mdBook](https://github.com/rust-lang/mdBook) with some [supported plugins](#supported-plugins).

This action runs only on linux and is well tested on github **latest ubuntu** runner and **compatible with Node v14, v16 and v18**. Windows and MacOS are currently not supported.
This action runs only on linux and is well tested on GitHubs **latest ubuntu** runner and **compatible with Node v18 and v20**. Windows and MacOS are not supported.

## Supported Plugins

Expand All @@ -32,8 +32,8 @@ jobs:
run:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: jontze/action-mdbook@v2
- uses: actions/checkout@v4
- uses: jontze/action-mdbook@v3
with:
token: ${{secrets.GITHUB_TOKEN}}
# Optional Plugins have to be enabled
Expand Down Expand Up @@ -71,8 +71,8 @@ jobs:
run:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: jontze/action-mdbook@v2
- uses: actions/checkout@v4
- uses: jontze/action-mdbook@v3
with:
token: ${{secrets.GITHUB_TOKEN}}
# Optional Plugins have to be enabled with a version
Expand Down
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ inputs:
required: false
default: "latest"
runs:
using: "node16"
using: "node20"
main: "./dist/index.js"
branding:
icon: "book"
Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "action-mdbook",
"version": "2.2.1",
"version": "3.0.0",
"description": "Github action to setup mdbook and optional some popular plugins",
"main": "dist/index.js",
"scripts": {
Expand All @@ -19,7 +19,7 @@
"dependencies": {
"@actions/core": "^1.10.1",
"@actions/exec": "^1.1.1",
"@actions/github": "^5.1.1",
"@actions/github": "^6.0.0",
"@actions/tool-cache": "^2.0.1",
"semver": "^7.5.4"
},
Expand All @@ -32,9 +32,9 @@
"@types/semver": "^7.5.4",
"@vercel/ncc": "^0.38.1",
"jest": "^27.5.1",
"mock-fs": "^5.2.0",
"mock-fs": "jontze/mock-fs#fixSyncTasks",
"prettier": "^3.0.3",
"semantic-release": "^19.0.5",
"semantic-release": "^21.1.2",
"ts-jest": "^27.1.4",
"ts-node": "^10.9.1",
"typescript": "^4.9.5"
Expand Down
8 changes: 2 additions & 6 deletions src/utils/Repo.ts
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
import { getOctokit } from "@actions/github";
import { getInput } from "@actions/core";
import { Octokit } from "@octokit/core";
import { PaginateInterface } from "@octokit/plugin-paginate-rest";
import { Api } from "@octokit/plugin-rest-endpoint-methods/dist-types/types";

type GhOctoKit = Octokit & Api & { paginate: PaginateInterface };
import { GitHub } from "@actions/github/lib/utils";

export class Repo {
private readonly token?: string;
private readonly octokit: GhOctoKit;
private readonly octokit: InstanceType<typeof GitHub>;
readonly owner: string;
readonly project: string;

Expand Down
Loading

0 comments on commit da53c89

Please sign in to comment.