diff --git a/.github/workflows/CompatHelper.yml b/.github/workflows/CompatHelper.yml new file mode 100644 index 0000000..e063f8f --- /dev/null +++ b/.github/workflows/CompatHelper.yml @@ -0,0 +1,50 @@ +name: CompatHelper +on: + schedule: + - cron: 0 0 * * * + workflow_dispatch: +permissions: + contents: write + pull-requests: write +jobs: + CompatHelper: + runs-on: ubuntu-latest + steps: + - name: Check if Julia is already available in the PATH + id: julia_in_path + run: which julia + continue-on-error: true + - name: Install Julia, but only if it is not already available in the PATH + uses: julia-actions/setup-julia@v1 + with: + version: '1' + arch: ${{ runner.arch }} + if: steps.julia_in_path.outcome != 'success' + - name: "Add the General registry via Git" + run: | + import Pkg + ENV["JULIA_PKG_SERVER"] = "" + Pkg.Registry.add("General") + shell: julia --color=yes {0} + - name: "Install CompatHelper" + run: | + import Pkg + name = "CompatHelper" + uuid = "aa819f21-2bde-4658-8897-bab36330d9b7" + version = "3" + Pkg.add(; name, uuid, version) + shell: julia --color=yes {0} + - name: "Run CompatHelper" + run: | + import CompatHelper + CompatHelper.main(; + subdirs=[ + "", + "docs", + ], + ) + shell: julia --color=yes {0} + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }} + # COMPATHELPER_PRIV: ${{ secrets.COMPATHELPER_PRIV }} diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 0000000..44adc82 --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,27 @@ +name: Documentation + +on: + push: + branches: + - master # update to match your development branch (master, main, dev, trunk, ...) + tags: '*' + pull_request: + +jobs: + build: + permissions: + contents: write + statuses: write + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: julia-actions/setup-julia@v1 + with: + version: '1' + - name: Install dependencies + run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()' + - name: Build and deploy + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token + DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key + run: julia --project=docs/ docs/make.jl \ No newline at end of file diff --git a/README.md b/README.md index 9387988..60714b9 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliaio.github.io/CodecLz4.jl/stable) [![Latest](https://img.shields.io/badge/docs-latest-blue.svg)](https://juliaio.github.io/CodecLz4.jl/latest) +[![Build Status](https://github.com/JuliaIO/CodecLz4.jl/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/JuliaIO/CodecLz4.jl/actions/workflows/CI.yml) [![CodeCov](https://codecov.io/gh/JuliaIO/CodecLz4.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaIO/CodecLz4.jl) Provides transcoding codecs for compression and decompression with LZ4. Source: [LZ4](https://github.com/lz4/lz4) diff --git a/docs/Project.toml b/docs/Project.toml index 51f82df..43f5cc9 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -3,4 +3,4 @@ CodecLz4 = "5ba52731-8f18-5e0d-9241-30f10d1ec561" Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" [compat] -Documenter = "~0.22.4" +Documenter = "1" diff --git a/docs/make.jl b/docs/make.jl index a58e907..e72f162 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -2,18 +2,13 @@ using Documenter, CodecLz4 makedocs(; modules=[CodecLz4], - format=Documenter.HTML(), pages=[ "Home" => "index.md", ], - repo="https://github.com/JuliaIO/CodecLz4.jl/blob/{commit}{path}#L{line}", sitename="CodecLz4.jl", authors="Invenia Technical Computing Corporation", ) deploydocs(; repo="github.com/JuliaIO/CodecLz4.jl", - target="build", - deps=nothing, - make=nothing, ) diff --git a/docs/src/index.md b/docs/src/index.md index 3e5b998..f421921 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -2,7 +2,7 @@ [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliaio.github.io/CodecLz4.jl/stable) [![Latest](https://img.shields.io/badge/docs-latest-blue.svg)](https://juliaio.github.io/CodecLz4.jl/latest) -[![Build Status](https://travis-ci.com/JuliaIO/CodecLz4.jl.svg?branch=master)](https://travis-ci.com/JuliaIO/CodecLz4.jl) +[![Build Status](https://github.com/JuliaIO/CodecLz4.jl/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/JuliaIO/CodecLz4.jl/actions/workflows/CI.yml) [![CodeCov](https://codecov.io/gh/JuliaIO/CodecLz4.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaIO/CodecLz4.jl) ```@autodocs