Skip to content

Commit d5ed8fc

Browse files
committed
Remove Jazzy documentation job and rely on Swift Package Index
1 parent 0465b34 commit d5ed8fc

File tree

2 files changed

+3
-34
lines changed

2 files changed

+3
-34
lines changed

.gitlab/ci/main.yml

Lines changed: 0 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,6 @@
11
stages:
22
- Platform Tests
33
- Quality Checks
4-
- Docs
5-
6-
pages:
7-
stage: Docs
8-
only:
9-
- tags
10-
image: norionomura/jazzy
11-
tags:
12-
- docker
13-
variables:
14-
MODULE_NAME: "RediStack"
15-
REPO_URL: "https://gitlab.com/mordil/swift-redi-stack"
16-
script: |
17-
export VERSION=$(git describe --abbrev=0 --tags || echo "0.0.0")
18-
swift build
19-
sourcekitten doc --spm-module "$MODULE_NAME" > "./$MODULE_NAME.json"
20-
jazzy --clean \
21-
--author "Nathan Harris (Mordil)" \
22-
--readme "./README.md" \
23-
--author_url "https://www.mordil.info" \
24-
--github_url "$REPO_URL" \
25-
--github-file-prefix "$REPO_URL/blob/$VERSION" \
26-
--root-url "https://mordil.gitlab.io/swift-redi-stack/" \
27-
--module "$MODULE_NAME" \
28-
--module-version "$VERSION" \
29-
--theme docs/theme \
30-
--sourcekitten-sourcefile "./$MODULE_NAME.json" \
31-
--output "./public"
32-
artifacts:
33-
paths:
34-
- public
354

365
Code Climate:
376
only:

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
<p>
55
<a href="https://github.com/swift-server/sswg/blob/master/process/incubation.md#sandbox-level"><img src="https://img.shields.io/badge/sswg-sandbox-lightgrey.svg" alt="SSWG Maturity"></a>
66
<a href="https://gitlab.com/Mordil/RediStack/blob/master/LICENSE.txt"><img src="https://img.shields.io/badge/License-Apache%202.0-yellow.svg" alt="Apache 2 License"></a>
7-
<a href="https://swift.org"><img src="https://img.shields.io/badge/Swift-5.2+-orange.svg" alt="Swift 5.2+"></a>
7+
<a href="https://swift.org"><img src="https://img.shields.io/badge/Swift-5.5+-orange.svg" alt="Swift 5.5+"></a>
88
<a href="https://redis.io"><img src="https://img.shields.io/badge/Redis-5.0-red.svg" alt="Redis 5.0"></a>
99
</p>
1010

1111
<p>
1212
<a href="https://gitlab.com/Mordil/RediStack/pipelines"><img src="https://gitlab.com/Mordil/RediStack/badges/master/pipeline.svg" alt="Build Status"></a>
13-
<a href="https://docs.redistack.info"><img src="https://docs.redistack.info/badge.svg" alt="Documentation Coverage"></a>
13+
<a href="https://swiftpackageindex.com/Mordil/RediStack/master/documentation/redistack"><img src="https://img.shields.io/badge/SPI-Documentation-blue.svg" alt="Documentation Coverage"></a>
1414
<a href="https://codeclimate.com/github/Mordil/RediStack/maintainability"><img src="https://api.codeclimate.com/v1/badges/b6fd5e7a3e669165a21b/maintainability" /></a>
1515
</p>
1616
</div>
@@ -77,7 +77,7 @@ print(result) // Optional("some value")
7777
7878
## Documentation
7979

80-
The docs for the latest tagged release are always available at [docs.redistack.info](http://docs.redistack.info).
80+
The docs for the latest tagged release are always available from the [Swift Package Index](https://swiftpackageindex.com/Mordil/RediStack/master/documentation/redistack).
8181

8282
## Questions
8383

0 commit comments

Comments
 (0)