Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
T
theodolite
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Analyze
Contributor analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Sören Henning
theodolite
Commits
2b3bc270
Commit
2b3bc270
authored
3 years ago
by
Sören Henning
Browse files
Options
Downloads
Plain Diff
Merge branch 'use-crd-docs-image' into 'master'
Use official crdoc container image Closes
#307
See merge request
!220
parents
ac0e3dc5
c1eadd20
No related branches found
No related tags found
1 merge request
!220
Use official crdoc container image
Pipeline
#6336
passed
3 years ago
Stage: build
Stage: test
Stage: check
Stage: deploy
Changes
2
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
.gitlab-ci.yml
+20
-9
20 additions, 9 deletions
.gitlab-ci.yml
docs/README.md
+1
-1
1 addition, 1 deletion
docs/README.md
with
21 additions
and
10 deletions
.gitlab-ci.yml
+
20
−
9
View file @
2b3bc270
...
@@ -79,26 +79,37 @@ test-docs-links:
...
@@ -79,26 +79,37 @@ test-docs-links:
-
build-docs
-
build-docs
script
:
bundle exec htmlproofer --assume-extension --allow_hash_href ./_site
script
:
bundle exec htmlproofer --assume-extension --allow_hash_href ./_site
build-docs-crds
:
stage
:
build
image
:
name
:
ghcr.io/fybrik/crdoc:0.6.1
entrypoint
:
[
"
"
]
script
:
/crdoc --resources theodolite/crd/ --template docs/api-reference/crds.tmpl --output docs/api-reference/crds.ref.md
artifacts
:
paths
:
-
docs/api-reference/crds.ref.md
expire_in
:
1 week
rules
:
-
changes
:
-
docs/api-reference/crds.tmpl
-
theodolite/crd/**/*
-
when
:
manual
allow_failure
:
true
test-docs-crds-regression
:
test-docs-crds-regression
:
stage
:
test
stage
:
test
image
:
golang
needs
:
-
build-docs-crds
image
:
alpine:3.15
before_script
:
before_script
:
-
cd docs
-
cd docs
-
go install fybrik.io/crdoc@latest
script
:
script
:
-
crdoc --resources ../theodolite/crd/ --template api-reference/crds.tmpl --output api-reference/crds.ref.md
-
cmp api-reference/crds.md api-reference/crds.ref.md
-
cmp api-reference/crds.md api-reference/crds.ref.md
artifacts
:
artifacts
:
when
:
on_failure
when
:
on_failure
paths
:
paths
:
-
docs/api-reference/crds.ref.md
-
docs/api-reference/crds.ref.md
expire_in
:
1 week
expire_in
:
1 week
rules
:
-
changes
:
-
docs/api-reference/crds.tmpl
-
theodolite/crd/**/*
-
when
:
manual
allow_failure
:
true
# Theodolite Helm Chart
# Theodolite Helm Chart
...
...
This diff is collapsed.
Click to expand it.
docs/README.md
+
1
−
1
View file @
2b3bc270
...
@@ -39,5 +39,5 @@ crdoc --resources ../theodolite/crd/ --template api-reference/crds.tmpl --outpu
...
@@ -39,5 +39,5 @@ crdoc --resources ../theodolite/crd/ --template api-reference/crds.tmpl --outpu
With the following command, crdoc is executed in Docker:
With the following command, crdoc is executed in Docker:
```
sh
```
sh
docker run
--rm
-v
"
`
pwd
`
/../theodolite/crd/"
:/crd
-u
$UID
-v
"
`
pwd
`
/api-reference"
:/api-reference ghcr.io/fybrik/crdoc:0.6.
0
--resources
/crd/
--template
/api-reference/crds.tmpl
--output
/api-reference/crds.md
docker run
--rm
-v
"
`
pwd
`
/../theodolite/crd/"
:/crd
-v
"
`
pwd
`
/api-reference"
:/api-reference ghcr.io/fybrik/crdoc:0.6.
1
--resources
/crd/
--template
/api-reference/crds.tmpl
--output
/api-reference/crds.md
```
```
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment