Skip to content

Commit 5f805bd

Browse files
committed
Merge branch 'fix-broken-app-quickstart' into 'main'
Remove erroneous ordered list item See merge request sr/eda/docs!95
2 parents 60a9878 + df53f32 commit 5f805bd

3 files changed

Lines changed: 26 additions & 8 deletions

File tree

.gitlab-ci.yml

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
11
variables:
22
GIT_DEPTH: 0
3-
MKDOCS_IMAGE: cr.srlinux.dev/pub/mkdocs-material-insiders:9.6.1-insiders-4.53.15-hellt
3+
MKDOCS_IMAGE: ghcr.io/eda-labs/mkdocs-material:v9.7.1-2
44

55
htmltest:
66
stage: test
7-
needs:
8-
- job: build
9-
artifacts: true
107
image:
118
name: cr.srlinux.dev/pub/debian:bookworm-slim
129
script:
@@ -15,12 +12,17 @@ htmltest:
1512
- ./bin/htmltest -c docs/htmltest.yml
1613
rules:
1714
- if: $CI_PIPELINE_SOURCE == "merge_request_event"
15+
when: manual
1816

1917
build:
2018
stage: test
2119
image:
2220
name: $MKDOCS_IMAGE
2321
entrypoint: [""]
22+
cache:
23+
key: mkdocs-cache
24+
paths:
25+
- .cache
2426
script:
2527
- mkdocs build --site-dir site
2628
artifacts:
@@ -35,11 +37,27 @@ upload_preview:
3537
- job: build
3638
artifacts: true
3739
image:
38-
name: node:lts-alpine
40+
name: $MKDOCS_IMAGE
41+
entrypoint: [""]
3942
before_script:
43+
- apk add --no-cache nodejs npm curl
4044
- npm install -g wrangler
4145
script:
42-
- wrangler pages deploy site --project-name=eda-docs --branch=$CI_COMMIT_REF_NAME
46+
- wrangler pages deploy site --project-name=eda-docs --branch=$CI_COMMIT_REF_NAME | tee /tmp/wrangler.log
47+
- DEPLOY_URL=$(grep -oE 'https?://[^[:space:]]+' /tmp/wrangler.log | sed -n '1p')
48+
- ALIAS_URL=$(grep -oE 'https?://[^[:space:]]+' /tmp/wrangler.log | sed -n '2p')
49+
- |
50+
if [ -n "$DEPLOY_URL" ] && [ -n "$ALIAS_URL" ] && [ -n "$CI_MERGE_REQUEST_IID" ]; then
51+
BODY=$(printf "Preview deploy: %s\nPreview alias: %s" "$DEPLOY_URL" "$ALIAS_URL")
52+
curl --request POST \
53+
--header "PRIVATE-TOKEN: $GITLAB_TOKEN" \
54+
--data-urlencode "body=$BODY" \
55+
--write-out " status=%{http_code}\n" \
56+
--silent --show-error --fail \
57+
"$CI_API_V4_URL/projects/$CI_PROJECT_ID/merge_requests/$CI_MERGE_REQUEST_IID/notes"
58+
else
59+
echo "Preview URLs or MR IID missing; skipping comment."
60+
fi
4361
rules:
4462
- if: $CI_PIPELINE_SOURCE == "merge_request_event"
4563

docs/development/apps/quick-start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Without further ado, let's get started by going into a directory where we want t
4848
edabuilder create app banners #(1)!
4949
```
5050
51-
1. //// warning
51+
//// warning
5252
If your application name is more than one word, the name must be in a kebab-case format.
5353
5454
In this example, the app name is simply `banners`, but if you wanted to name it "my banners", then you should've named it `my-banners`.

run.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ fi
2727
# set the branch name for versioned docs
2828
MIKE_BRANCH_NAME="__versioned-docs__"
2929

30-
MKDOCS_VERSION=${MKDOCS_VERSION:-v9.7.1-1}
30+
MKDOCS_VERSION=${MKDOCS_VERSION:-v9.7.1-2}
3131

3232
MKDOCS_INET_IMAGE=ghcr.io/eda-labs/mkdocs-material:${MKDOCS_VERSION}
3333
MKDOCS_NOKIA_IMAGE=registry.srlinux.dev/pub/mkdocs-material-insiders:${MKDOCS_VERSION}

0 commit comments

Comments
 (0)