Skip to content

Commit bf54a08

Browse files
authored
Deploy docs, improve CI workflow (#2)
Also removes redundant `dev` badge from README and pushes doc previews for PRs.
1 parent 8e44a72 commit bf54a08

File tree

4 files changed

+25
-4
lines changed

4 files changed

+25
-4
lines changed

.github/workflows/CI.yml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
name: CI
22
on:
3-
- push
4-
- pull_request
3+
pull_request:
4+
push:
5+
branches:
6+
- master
7+
tags: '*'
58
jobs:
69
test:
710
name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
@@ -11,7 +14,7 @@ jobs:
1114
matrix:
1215
version:
1316
- '1.3'
14-
- '1.6'
17+
- '1'
1518
- 'nightly'
1619
os:
1720
- ubuntu-latest

.github/workflows/Documenter.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Documenter
2+
on:
3+
push:
4+
branches: [master]
5+
tags: [v*]
6+
pull_request:
7+
8+
jobs:
9+
Documenter:
10+
name: Documentation
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v2
14+
- uses: julia-actions/julia-buildpkg@latest
15+
- uses: julia-actions/julia-docdeploy@latest
16+
env:
17+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
18+
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# ModuleDocstrings
22

33
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaDocs.github.io/ModuleDocstrings.jl/stable)
4-
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaDocs.github.io/ModuleDocstrings.jl/dev)
54
[![Build Status](https://github.com/JuliaDocs/ModuleDocstrings.jl/workflows/CI/badge.svg)](https://github.com/JuliaDocs/ModuleDocstrings.jl/actions)
65
[![Coverage](https://codecov.io/gh/JuliaDocs/ModuleDocstrings.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaDocs/ModuleDocstrings.jl)
76

docs/make.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,5 @@ makedocs(;
2121
deploydocs(;
2222
repo="github.com/JuliaDocs/ModuleDocstrings.jl",
2323
devbranch="main",
24+
push_preview = true,
2425
)

0 commit comments

Comments
 (0)