Compare commits

...
Sign in to create a new pull request.

17 commits

Author SHA1 Message Date
4da8cc39c3
ci: Switch ci to single file
All checks were successful
ci/woodpecker/push/woodpecker/1 Pipeline was successful
ci/woodpecker/push/woodpecker/2 Pipeline was successful
ci/woodpecker/push/woodpecker/3 Pipeline was successful
ci/woodpecker/push/woodpecker/4 Pipeline was successful
ci/woodpecker/push/woodpecker/5 Pipeline was successful
2025-01-29 19:57:00 -06:00
d28164f057
ci: Change docs path
All checks were successful
ci/woodpecker/push/ci/1 Pipeline was successful
ci/woodpecker/push/ci/2 Pipeline was successful
ci/woodpecker/push/ci/3 Pipeline was successful
ci/woodpecker/push/ci/4 Pipeline was successful
ci/woodpecker/push/ci/5 Pipeline was successful
ci/woodpecker/push/docs Pipeline was successful
2024-12-17 00:08:16 -06:00
bb25e984e2
ci: Make Woodpecker more modern
All checks were successful
ci/woodpecker/push/ci/1 Pipeline was successful
ci/woodpecker/push/ci/2 Pipeline was successful
ci/woodpecker/push/ci/3 Pipeline was successful
ci/woodpecker/push/ci/4 Pipeline was successful
ci/woodpecker/push/ci/5 Pipeline was successful
ci/woodpecker/push/docs Pipeline was successful
2024-12-16 23:28:10 -06:00
755c1cf25b Update '.woodpecker.yml'
Some checks failed
ci/woodpecker/manual/woodpecker/1 Pipeline failed
ci/woodpecker/manual/woodpecker/2 Pipeline failed
ci/woodpecker/manual/woodpecker/3 Pipeline failed
ci/woodpecker/manual/woodpecker/4 Pipeline failed
2024-01-23 20:22:27 +00:00
ee17c8d2d9 Update '.woodpecker.yml'
All checks were successful
ci/woodpecker/manual/woodpecker/1 Pipeline was successful
ci/woodpecker/manual/woodpecker/2 Pipeline was successful
ci/woodpecker/manual/woodpecker/3 Pipeline was successful
ci/woodpecker/manual/woodpecker/4 Pipeline was successful
2024-01-23 20:10:58 +00:00
9b16e5ed6e Update '.woodpecker.yml'
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
ci/woodpecker/manual/woodpecker/1 Pipeline was successful
ci/woodpecker/manual/woodpecker/2 Pipeline was successful
ci/woodpecker/manual/woodpecker/3 Pipeline was successful
ci/woodpecker/manual/woodpecker/4 Pipeline was successful
2023-02-22 18:07:20 +00:00
727027c43f Update 'docs/make.jl'
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
2023-02-22 18:00:31 +00:00
c319798d25 Update '.woodpecker.yml'
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
2023-02-22 17:52:15 +00:00
f8cf0f9ad2 Delete 'docs/Manifest.toml'
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
2023-02-22 17:41:58 +00:00
2718e85f23 Update '.woodpecker.yml'
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
2023-02-20 15:46:04 +00:00
90af33bec8 Update '.woodpecker.yml'
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
2023-02-20 15:20:30 +00:00
d08610b863 Update '.woodpecker.yml'
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
2023-02-20 15:12:58 +00:00
15748f56cb Update '.woodpecker.yml'
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
2023-02-20 15:07:17 +00:00
be808573cc Update '.woodpecker.yml'
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
2023-02-15 17:05:49 +00:00
b91b374b96 Update '.woodpecker.yml'
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
2023-02-15 17:00:00 +00:00
e74dd4bd9c Update '.woodpecker.yml' 2023-02-15 16:57:11 +00:00
9d1a031cea Update '.woodpecker.yml' 2023-02-15 16:54:32 +00:00
11 changed files with 76 additions and 258 deletions

View file

@ -1,66 +0,0 @@
name: CI
on:
- push
- pull_request
jobs:
test:
name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
version:
- '1.0' # old LTS
- '1.6' # new LTS
- '1' # Latest stable
- 'nightly' # 'nuf said
os:
- ubuntu-latest
arch:
- x64
steps:
- uses: actions/checkout@v2
- uses: julia-actions/setup-julia@v1
with:
version: ${{ matrix.version }}
arch: ${{ matrix.arch }}
- uses: actions/cache@v1
env:
cache-name: cache-artifacts
with:
path: ~/.julia/artifacts
key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
restore-keys: |
${{ runner.os }}-test-${{ env.cache-name }}-
${{ runner.os }}-test-
${{ runner.os }}-
- uses: julia-actions/julia-buildpkg@v1
- uses: julia-actions/julia-runtest@v1
- uses: julia-actions/julia-processcoverage@v1
- uses: codecov/codecov-action@v1
with:
file: lcov.info
docs:
name: Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: julia-actions/setup-julia@v1
with:
version: '1'
- run: |
julia --project=docs -e '
using Pkg
Pkg.develop(PackageSpec(path=pwd()))
Pkg.instantiate()'
- run: |
julia --project=docs -e '
using Documenter: DocMeta, doctest
using Cowsay
DocMeta.setdocmeta!(Cowsay, :DocTestSetup, :(using Cowsay); recursive=true)
doctest(Cowsay)'
- run: julia --project=docs docs/make.jl
env:
JULIA_PKG_SERVER: ""
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

View file

@ -1,16 +0,0 @@
name: CompatHelper
on:
schedule:
- cron: 0 0 * * *
workflow_dispatch:
jobs:
CompatHelper:
runs-on: ubuntu-latest
steps:
- name: Pkg.add("CompatHelper")
run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
- name: CompatHelper.main()
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}
run: julia -e 'using CompatHelper; CompatHelper.main()'

View file

@ -1,15 +0,0 @@
name: TagBot
on:
issue_comment:
types:
- created
workflow_dispatch:
jobs:
TagBot:
if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
runs-on: ubuntu-latest
steps:
- uses: JuliaRegistries/TagBot@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
ssh: ${{ secrets.DOCUMENTER_KEY }}

View file

@ -1,14 +0,0 @@
name: Register Package
on:
workflow_dispatch:
inputs:
version:
description: Version to register or component to bump
required: true
jobs:
register:
runs-on: ubuntu-latest
steps:
- uses: julia-actions/RegisterAction@latest
with:
token: ${{ secrets.GITHUB_TOKEN }}

37
.woodpecker.yaml Normal file
View file

@ -0,0 +1,37 @@
matrix:
JULIA_VERSION:
- "1.0"
- "1.6"
- "1.10"
- "1"
- "rc"
clone:
git:
image: woodpeckerci/plugin-git
settings:
partial: false
depth: 0
steps:
test:
image: julia:${JULIA_VERSION}
pull: true
when:
event: [pull_request, push]
commands:
- julia -e 'using Pkg; Pkg.activate(pwd()); Pkg.instantiate()'
- julia -e 'using Pkg; Pkg.activate(pwd()); Pkg.test()'
docs:
image: julia:${JULIA_VERSION}
when:
branch: master
event: push
matrix:
JULIA_VERSION: "1"
commands:
- julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
- julia --project=docs/ docs/make.jl
environment:
PROJECT_ACCESS_TOKEN:
from_secret: project_access_token

View file

@ -1,45 +0,0 @@
matrix:
JULIA_VERSION:
- "1.0"
- "1.6"
- "1"
- "rc"
pipeline:
test:
group: ci
image: julia:${JULIA_VERSION}
pull: true
when:
- event: pull_request
- event: push
branch: master
commands:
- julia --color=yes -e 'using Pkg; Pkg.activate(pwd()); Pkg.instantiate()'
- julia --color=yes -e 'using Pkg; Pkg.activate(pwd()); Pkg.test(;coverage=true)'
docs:
group: ci
image: julia:1-alpine3.17
when:
- event: push
branch: master
- event: manual
secrets:
- DOCS_REMOTE_USER
- DOCS_REMOTE_SERVER
- DOCS_REMOTE_DIR
- DOCS_KEY
- DOCS_PUBKEY
commands:
- apk add git openssh-client rsync
- mkdir -p $HOME/.ssh
- echo "${DOCS_KEY}" >> $HOME/.ssh/id_rsa
- chmod 0600 $HOME/.ssh/id_rsa
- git config --global user.email "woodpecker@millironx.com"
- git config --global user.name "woodpecker-bot"
- git config --global --add safe.directory /woodpecker/src
- julia --color=yes --project=docs -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
- julia --color=yes --project=docs docs/make.jl
- rsync -r --exclude .git docs/build/* ${DOCS_REMOTE_USER}@${DOCS_REMOTE_SERVER}:${DOCS_REMOTE_DIR}

View file

@ -7,8 +7,8 @@ version = "1.0.0"
TextWrap = "b718987f-49a8-5099-9789-dcd902bef87d" TextWrap = "b718987f-49a8-5099-9789-dcd902bef87d"
[compat] [compat]
julia = "1"
TextWrap = "1" TextWrap = "1"
julia = "1"
[extras] [extras]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

View file

@ -1,97 +0,0 @@
# This file is machine-generated - editing it directly is not advised
[[ANSIColoredPrinters]]
git-tree-sha1 = "574baf8110975760d391c710b6341da1afa48d8c"
uuid = "a4c015fc-c6ff-483c-b24f-f7ea428134e9"
version = "0.0.1"
[[Base64]]
uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
[[Cowsay]]
path = "/home/tchristensen/src/cowsay"
uuid = "b6370f49-8ad1-4651-ad9e-3639b35da0e9"
version = "0.1.0"
[[Dates]]
deps = ["Printf"]
uuid = "ade2ca70-3891-5945-98fb-dc099432e06a"
[[DocStringExtensions]]
deps = ["LibGit2"]
git-tree-sha1 = "b19534d1895d702889b219c382a6e18010797f0b"
uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
version = "0.8.6"
[[Documenter]]
deps = ["ANSIColoredPrinters", "Base64", "Dates", "DocStringExtensions", "IOCapture", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"]
git-tree-sha1 = "f425293f7e0acaf9144de6d731772de156676233"
uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
version = "0.27.10"
[[IOCapture]]
deps = ["Logging", "Random"]
git-tree-sha1 = "f7be53659ab06ddc986428d3a9dcc95f6fa6705a"
uuid = "b5f81e59-6552-4d32-b1f0-c071b021bf89"
version = "0.2.2"
[[InteractiveUtils]]
deps = ["Markdown"]
uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
[[JSON]]
deps = ["Dates", "Mmap", "Parsers", "Unicode"]
git-tree-sha1 = "8076680b162ada2a031f707ac7b4953e30667a37"
uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
version = "0.21.2"
[[LibGit2]]
deps = ["Base64", "NetworkOptions", "Printf", "SHA"]
uuid = "76f85450-5226-5b5a-8eaa-529ad045b433"
[[Logging]]
uuid = "56ddb016-857b-54e1-b83d-db4d58db5568"
[[Markdown]]
deps = ["Base64"]
uuid = "d6f4376e-aef5-505a-96c1-9c027394607a"
[[Mmap]]
uuid = "a63ad114-7e13-5084-954f-fe012c677804"
[[NetworkOptions]]
uuid = "ca575930-c2e3-43a9-ace4-1e988b2c1908"
[[Parsers]]
deps = ["Dates"]
git-tree-sha1 = "ae4bbcadb2906ccc085cf52ac286dc1377dceccc"
uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0"
version = "2.1.2"
[[Printf]]
deps = ["Unicode"]
uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7"
[[REPL]]
deps = ["InteractiveUtils", "Markdown", "Sockets", "Unicode"]
uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
[[Random]]
deps = ["Serialization"]
uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
[[SHA]]
uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce"
[[Serialization]]
uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
[[Sockets]]
uuid = "6462fe0b-24de-5631-8697-dd941f90decc"
[[Test]]
deps = ["InteractiveUtils", "Logging", "Random", "Serialization"]
uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
[[Unicode]]
uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"

View file

@ -1,3 +1,6 @@
[deps] [deps]
Cowsay = "b6370f49-8ad1-4651-ad9e-3639b35da0e9" Cowsay = "b6370f49-8ad1-4651-ad9e-3639b35da0e9"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
[compat]
Documenter = "1"

View file

@ -3,24 +3,48 @@ using Documenter
DocMeta.setdocmeta!(Cowsay, :DocTestSetup, :(using Cowsay); recursive=true) DocMeta.setdocmeta!(Cowsay, :DocTestSetup, :(using Cowsay); recursive=true)
struct GiteaRemote <: Documenter.Remote
host::String
user::String
repo::String
end
function Documenter.Remotes.repourl(remote::GiteaRemote)
return "https://$(remote.host)/$(remote.user)/$(remote.repo)"
end
function Documenter.Remotes.fileurl(remote::GiteaRemote, ref, filename, linerange)
if isnothing(linerange)
return "https://$(remote.host)/$(remote.user)/$(remote.repo)/src/commit/$ref/$filename"
else
return "https://$(remote.host)/$(remote.user)/$(remote.repo)/src/commit/$ref/$filename#L$(first(linerange))-$(last(linerange))"
end
end
function Documenter.Remotes.issueurl(remote::GiteaRemote, issuenumber)
return "https://$(remote.host)/$(remote.user)/$(remote.repo)/issues/$issuenumber"
end
makedocs(; makedocs(;
modules=[Cowsay], modules=[Cowsay],
authors="Thomas A. Christensen II <25492070+MillironX@users.noreply.github.com> and contributors", authors="Thomas A. Christensen II <25492070+MillironX@users.noreply.github.com> and contributors",
repo="https://github.com/MillironX/cowsay.jl/blob/{commit}{path}#{line}", repo=GiteaRemote("code.millironx.com", "millironx", "Cowsay.jl"),
sitename="cowsay.jl", sitename="Cowsay.jl",
format=Documenter.HTML(; format=Documenter.HTML(;
prettyurls=get(ENV, "CI", "false") == "true", prettyurls=get(ENV, "CI", "false") == "true",
canonical="https://millironx.com/Cowsay.jl", canonical="https://cowsay-jl.millironx.com/",
assets=String[], assets=String[],
), ),
pages=[ pages=[
"Home" => "index.md", "Home" => "index.md",
"Available Cowfiles" => "cows.md", "Available Cowfiles" => "cows.md",
"Make your own Cowfile" => "cowfiles.md", "Make your own Cowfile" => "cowfiles.md",
"Private API Reference" => "private.md",
], ],
) )
deploydocs(; deploydocs(;
repo="github.com/MillironX/Cowsay.jl", repo="code.millironx.com/millironx/Cowsay.jl",
devbranch="master", devbranch="master",
branch="pages",
) )

7
docs/src/private.md Normal file
View file

@ -0,0 +1,7 @@
# Private API Reference
Internal functions used by Cowsay.jl.
```@autodocs
Modules = [Cowsay]
```