File tree Expand file tree Collapse file tree 2 files changed +3
-34
lines changed Expand file tree Collapse file tree 2 files changed +3
-34
lines changed Original file line number Diff line number Diff line change 1
1
stages :
2
2
- Platform Tests
3
3
- 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
35
4
36
5
Code Climate :
37
6
only :
Original file line number Diff line number Diff line change 4
4
<p >
5
5
<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>
6
6
<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>
8
8
<a href="https://redis.io"><img src="https://img.shields.io/badge/Redis-5.0-red.svg" alt="Redis 5.0"></a>
9
9
</p >
10
10
11
11
<p >
12
12
<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>
14
14
<a href="https://codeclimate.com/github/Mordil/RediStack/maintainability"><img src="https://api.codeclimate.com/v1/badges/b6fd5e7a3e669165a21b/maintainability" /></a>
15
15
</p >
16
16
</div >
@@ -77,7 +77,7 @@ print(result) // Optional("some value")
77
77
78
78
## Documentation
79
79
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) .
81
81
82
82
## Questions
83
83
You can’t perform that action at this time.
0 commit comments