Skip to content

Commit

Permalink
docs 1.0 upgrade (#46)
Browse files Browse the repository at this point in the history
* add CompatHelper

* setup docs
  • Loading branch information
nhz2 authored Feb 2, 2024
1 parent 700ad7c commit ea41fe1
Show file tree
Hide file tree
Showing 6 changed files with 80 additions and 7 deletions.
50 changes: 50 additions & 0 deletions .github/workflows/CompatHelper.yml
Original file line number Diff line number Diff line change
@@ -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 }}
27 changes: 27 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ CodecLz4 = "5ba52731-8f18-5e0d-9241-30f10d1ec561"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

[compat]
Documenter = "~0.22.4"
Documenter = "1"
5 changes: 0 additions & 5 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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,
)
2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

2 comments on commit ea41fe1

@nhz2
Copy link
Member Author

@nhz2 nhz2 commented on ea41fe1 Feb 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register()

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/100083

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.4.2 -m "<description of version>" ea41fe1fa7947c5386fa19d753da57d2c91e634f
git push origin v0.4.2

Please sign in to comment.