Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(ci): add ci submodule #68

Merged
merged 7 commits into from
Oct 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions .github/workflows/base-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,20 +29,29 @@ jobs:
container: baoproject/bao:latest
steps:
- uses: actions/checkout@v2
josecm marked this conversation as resolved.
Show resolved Hide resolved
- run: |
with:
fetch-depth: 0
submodules: recursive
- run: |
git config --global --add safe.directory $(realpath .)
make spelling

format-check:
docformat:
runs-on: ubuntu-latest
container: baoproject/bao:latest
steps:
- uses: actions/checkout@v2
- run: doc8 source/ --ignore D000
with:
fetch-depth: 0
submodules: recursive
- run: make rst-format

build:
runs-on: ubuntu-latest
container: baoproject/bao:latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
submodules: recursive
- run: make html
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "ci"]
path = ci
url = [email protected]:bao-project/bao-ci.git
17 changes: 9 additions & 8 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Minimal makefile for Sphinx documentation
#

root_dir:=$(realpath .)
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?= -W -a
Expand All @@ -12,16 +12,17 @@ BUILDDIR = build
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help format Makefile ci
.PHONY: help

# Instantiate CI rules
include ci/ci.mk

# doc8 format checker
# Checks the format of the reST sources.
format:
@doc8 source/ --ignore D000
$(call ci, rstformat, $(SOURCEDIR))

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
%:
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

ci: format html spelling
ci: rst-format html spelling
.PHONY: ci
1 change: 1 addition & 0 deletions ci
Submodule ci added at fd9396
Loading