From f1a0053982b5dff0c6cb69a0b30a2b599aa2fffe Mon Sep 17 00:00:00 2001
From: Miguel Angel Reina Ortega <miguelangel.reinaortega@etsi.org>
Date: Mon, 22 Apr 2024 08:59:53 +0200
Subject: [PATCH] Clean up after merging toMkdocs branch
---
.gitlab-ci.yml | 9 ------
generateChangemarks/.gitlab-ci.yml | 41 +++++++++++++--------------
generateChangemarks/dockerfile.pandoc | 4 +--
publish_on_pages.sh | 28 ------------------
publish_spec.sh | 4 +--
spec_on_pages.sh | 4 +--
toMkdocs/dockerfile.mike | 5 ----
toMkdocs/index.md | 2 --
8 files changed, 25 insertions(+), 72 deletions(-)
delete mode 100644 toMkdocs/dockerfile.mike
delete mode 100644 toMkdocs/index.md
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 5dcc3a2..f68badc 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -38,15 +38,6 @@ Build Pandoc docker image:
changes:
- generateChangemarks/dockerfile.pandoc
-Build Mike docker image:
- stage: build
- before_script: cd toMkdocs
- script: docker build --tag mike:$CI_COMMIT_BRANCH -f dockerfile.mike .
- rules:
- - if: $CI_COMMIT_BRANCH && $CI_PROJECT_NAME == "scripts"
- changes:
- - toMkdocs/dockerfile.mike
-
Upgrade index for pages:
stage: upgrade
before_script:
diff --git a/generateChangemarks/.gitlab-ci.yml b/generateChangemarks/.gitlab-ci.yml
index 12c6e99..285529b 100644
--- a/generateChangemarks/.gitlab-ci.yml
+++ b/generateChangemarks/.gitlab-ci.yml
@@ -26,7 +26,7 @@ Word CR:
- merge_requests
before_script:
- |
- curl "${CI_API_V4_URL}/projects/$TOOLS_SCRIPTS_PROJECT_ID/repository/files/generate_changemarks%2Esh/raw?ref=toMkdocs" >> generate_changemarks.sh
+ curl "${CI_API_V4_URL}/projects/$TOOLS_SCRIPTS_PROJECT_ID/repository/files/generate_changemarks%2Esh/raw?ref=master" >> generate_changemarks.sh
- chmod +x generate_changemarks.sh
- |
curl "${CI_API_V4_URL}/projects/$TOOLS_SCRIPTS_PROJECT_ID/repository/files/onem2m_delimiter_start%2Edocx/raw?ref=master" >> onem2m_delimiter_start.docx
@@ -64,7 +64,7 @@ Publish spec:
- tags
before_script:
- |
- curl "${CI_API_V4_URL}/projects/$TOOLS_SCRIPTS_PROJECT_ID/repository/files/publish_spec%2Esh/raw?ref=toMkdocs" >> publish_spec.sh
+ curl "${CI_API_V4_URL}/projects/$TOOLS_SCRIPTS_PROJECT_ID/repository/files/publish_spec%2Esh/raw?ref=master" >> publish_spec.sh
- chmod +x publish_spec.sh
- |
curl "${CI_API_V4_URL}/projects/$TOOLS_SCRIPTS_PROJECT_ID/repository/files/Spec-template%2Edocx/raw?ref=master" >> onem2m_spec_template.docx
@@ -95,17 +95,17 @@ pages:
rules:
# Simulated creation of tag pipeline
- - if: ($CLEAN_WEB_PAGES == 'false' || $CLEAN_WEB_PAGES == 'true') && $TMPTAG != "none" ## Replace this by CI_COMMIT_TAG when test finished
- variables:
- TAG_NAME: $TMPTAG
+ #- if: ($CLEAN_WEB_PAGES == 'false' || $CLEAN_WEB_PAGES == 'true') && $TMPTAG != "none" ## Replace this by CI_COMMIT_TAG when test finished
+ # variables:
+ # TAG_NAME: $TMPTAG
# Normal creation of tag pipeline
- - if: ($CLEAN_WEB_PAGES == 'false' || $CLEAN_WEB_PAGES == 'true') && $CI_COMMIT_TAG ## Replace this by CI_COMMIT_TAG when test finished
+ - if: ($CLEAN_WEB_PAGES == 'false' || $CLEAN_WEB_PAGES == 'true') && $CI_COMMIT_TAG
variables:
- TMPTAG: $CI_COMMIT_TAG
+ TAG_NAME: $CI_COMMIT_TAG
# Pipeline triggered from web to remove some docs versions -> CLEAN_WEB_PAGES set to an existing tag name
- if: ($CLEAN_WEB_PAGES != "false" && $CLEAN_WEB_PAGES != "true") && $CI_PIPELINE_SOURCE == "web"
variables:
- TAG_NAME: $CLEAN_WEB_PAGES
+ TAG_NAME: none
# Upgrade of index.html (not used anymore)
- if: $CI_PIPELINE_SOURCE == "trigger"
variables:
@@ -116,43 +116,42 @@ pages:
- apt-get update -qq && apt-get -qq install -y git curl > /dev/null
# Retrieval of required files from tools/scripts
- |
- curl "${CI_API_V4_URL}/projects/$TOOLS_SCRIPTS_PROJECT_ID/repository/files/toMkdocs%2Fimages%2Ffavicon%2Eico/raw?ref=toMkdocs" >> favicon.html
+ curl "${CI_API_V4_URL}/projects/$TOOLS_SCRIPTS_PROJECT_ID/repository/files/toMkdocs%2Fimages%2Ffavicon%2Eico/raw?ref=master" >> favicon.html
- mkdir -p docs/images && mv favicon.html docs/images/
- |
- curl "${CI_API_V4_URL}/projects/$TOOLS_SCRIPTS_PROJECT_ID/repository/files/toMkdocs%2Fimages%2Fonem2m%2Epng/raw?ref=toMkdocs" >> onem2m.png
+ curl "${CI_API_V4_URL}/projects/$TOOLS_SCRIPTS_PROJECT_ID/repository/files/toMkdocs%2Fimages%2Fonem2m%2Epng/raw?ref=master" >> onem2m.png
- mv onem2m.png docs/images/
- |
- curl "${CI_API_V4_URL}/projects/$TOOLS_SCRIPTS_PROJECT_ID/repository/files/toMkdocs%2Fimages%2Fonem2m_sq%2Epng/raw?ref=toMkdocs" >> onem2m_sq.png
+ curl "${CI_API_V4_URL}/projects/$TOOLS_SCRIPTS_PROJECT_ID/repository/files/toMkdocs%2Fimages%2Fonem2m_sq%2Epng/raw?ref=master" >> onem2m_sq.png
- mv onem2m_sq.png docs/images/
- |
- curl "${CI_API_V4_URL}/projects/$TOOLS_SCRIPTS_PROJECT_ID/repository/files/toMkdocs%2Fimages%2FWord%2Epng/raw?ref=toMkdocs" >> Word.png
+ curl "${CI_API_V4_URL}/projects/$TOOLS_SCRIPTS_PROJECT_ID/repository/files/toMkdocs%2Fimages%2FWord%2Epng/raw?ref=master" >> Word.png
- mkdir -p docs/download/images && mv Word.png docs/download/images/
- |
- curl "${CI_API_V4_URL}/projects/$TOOLS_SCRIPTS_PROJECT_ID/repository/files/toMkdocs%2Fimages%2FEpub%2Epng/raw?ref=toMkdocs" >> Epub.png
+ curl "${CI_API_V4_URL}/projects/$TOOLS_SCRIPTS_PROJECT_ID/repository/files/toMkdocs%2Fimages%2FEpub%2Epng/raw?ref=master" >> Epub.png
- mv Epub.png docs/download/images/
- |
- curl "${CI_API_V4_URL}/projects/$TOOLS_SCRIPTS_PROJECT_ID/repository/files/toMkdocs%2Fimages%2FPdf%2Epng/raw?ref=toMkdocs" >> Pdf.png
+ curl "${CI_API_V4_URL}/projects/$TOOLS_SCRIPTS_PROJECT_ID/repository/files/toMkdocs%2Fimages%2FPdf%2Epng/raw?ref=master" >> Pdf.png
- mv Pdf.png docs/download/images/
- |
- curl "${CI_API_V4_URL}/projects/$TOOLS_SCRIPTS_PROJECT_ID/repository/files/toMkdocs%2Fstylesheets%2Fextra%2Ecss/raw?ref=toMkdocs" >> extra.css
+ curl "${CI_API_V4_URL}/projects/$TOOLS_SCRIPTS_PROJECT_ID/repository/files/toMkdocs%2Fstylesheets%2Fextra%2Ecss/raw?ref=master" >> extra.css
- mkdir -p docs/stylesheets && mv extra.css docs/stylesheets/
- |
- curl "${CI_API_V4_URL}/projects/$TOOLS_SCRIPTS_PROJECT_ID/repository/files/toMkdocs%2Fmkdocs%2Eyml/raw?ref=toMkdocs" >> mkdocs.yml
+ curl "${CI_API_V4_URL}/projects/$TOOLS_SCRIPTS_PROJECT_ID/repository/files/toMkdocs%2Fmkdocs%2Eyml/raw?ref=master" >> mkdocs.yml
- |
- curl "${CI_API_V4_URL}/projects/$TOOLS_SCRIPTS_PROJECT_ID/repository/files/toMkdocs%2FindexDownload%2Emd/raw?ref=toMkdocs" >> indexDownload.md
+ curl "${CI_API_V4_URL}/projects/$TOOLS_SCRIPTS_PROJECT_ID/repository/files/toMkdocs%2FindexDownload%2Emd/raw?ref=master" >> indexDownload.md
- mkdir -p docs/download && mv indexDownload.md docs/download/index.md
- |
- curl "${CI_API_V4_URL}/projects/$TOOLS_SCRIPTS_PROJECT_ID/repository/files/toMkdocs%2FtoMkdocs%2Epy/raw?ref=toMkdocs" >> toMkdocs.py
+ curl "${CI_API_V4_URL}/projects/$TOOLS_SCRIPTS_PROJECT_ID/repository/files/toMkdocs%2FtoMkdocs%2Epy/raw?ref=master" >> toMkdocs.py
- |
export SPEC_NAME=$(ls | grep T*.md | cut -d'.' -f1)
- |
- curl "${CI_API_V4_URL}/projects/$TOOLS_SCRIPTS_PROJECT_ID/repository/files/spec_on_pages%2Esh/raw?ref=toMkdocs" >> spec_on_pages.sh
+ curl "${CI_API_V4_URL}/projects/$TOOLS_SCRIPTS_PROJECT_ID/repository/files/spec_on_pages%2Esh/raw?ref=master" >> spec_on_pages.sh
- chmod +x spec_on_pages.sh
- echo "'$TAG_NAME'"
script:
-# - ./spec_on_pages.sh toMkdocs.py $MIKE_ACCESS_TOKEN $CI_SERVER_HOST $CI_PROJECT_PATH "$GITLAB_USER_NAME" $GITLAB_USER_EMAIL $CI_COMMIT_SHA $SPEC_NAME $CI_PROJECT_NAME $TAG_NAME $CLEAN_WEB_PAGES
- - ./spec_on_pages.sh toMkdocs.py $MIKE_ACCESS_TOKEN $CI_SERVER_HOST $CI_PROJECT_PATH "$GITLAB_USER_NAME" $GITLAB_USER_EMAIL $CI_COMMIT_SHA $SPEC_NAME $CI_PROJECT_NAME $TMPTAG $CLEAN_WEB_PAGES
+ - ./spec_on_pages.sh toMkdocs.py $MIKE_ACCESS_TOKEN $CI_SERVER_HOST $CI_PROJECT_PATH "$GITLAB_USER_NAME" $GITLAB_USER_EMAIL $CI_COMMIT_SHA $SPEC_NAME $CI_PROJECT_NAME $TAG_NAME $CLEAN_WEB_PAGES
artifacts:
paths:
- public/
\ No newline at end of file
diff --git a/generateChangemarks/dockerfile.pandoc b/generateChangemarks/dockerfile.pandoc
index 4cc768a..bb9d0bf 100644
--- a/generateChangemarks/dockerfile.pandoc
+++ b/generateChangemarks/dockerfile.pandoc
@@ -3,9 +3,7 @@ FROM pandoc/core:3-ubuntu
RUN apt-get update -y && \
apt-get install -y npm &&\
npm install --global mermaid-filter &&\
- apt-get install -y texlive-xetex
-
-#texlive-latex-base texlive-latex-recommended texlive-fonts-recommended
+ apt-get install -y texlive-latex-base texlive-latex-recommended texlive-fonts-recommended
CMD ["/bin/sh"]
diff --git a/publish_on_pages.sh b/publish_on_pages.sh
index e9c45f7..9dd2fb4 100644
--- a/publish_on_pages.sh
+++ b/publish_on_pages.sh
@@ -1,12 +1,6 @@
#!/bin/bash
DOCKER_IMAGE=logiqx/python-bs4:3.9-slim
-MIKE_DOCKER_IMAGE=mike:master
-#BACKUP=false
-PAGES_BRANCH=gl-pages
-#HTTPS_REMOTE=https://gitlab-ci-token:${ACCESS_TOKEN}@${CI_SERVER_HOST}/rep/${CI_PROJECT_PATH}.git
-HTTPS_REMOTE=https://gitlab-ci-token:mytoken@git.onem2m.org/specifications/${3}.git
-
echo "\n------ Checking for docker image --------"
docker pull "$DOCKER_IMAGE"
@@ -73,28 +67,6 @@ else
docker run --rm -v $(pwd):/tmp -w /tmp "$DOCKER_IMAGE" python3 $1 -re "$7_$4" "$4/$7_$4.docx" "$5"
fi
-####### GENERATE NAV SPEC #######
-## Temporary trial
-#rm public/index.html
-echo "------ Generate input for mkdocs --------"
-docker run --rm -u $(id -u):$(id -g) -v $(pwd):/tmp -w /tmp "$MIKE_DOCKER_IMAGE" python3 $8 --title ${3^^} "./$7.md"
-
-echo "------ Move to docs folder --------"
-ls
-mv ${3^^}/ docs/
-cat _nav.yml >> mkdocs.yml
-
-echo "------ Generating site --------"
-docker run --rm -u $(id -u):$(id -g) -v $(pwd):/tmp -w /tmp "$MIKE_DOCKER_IMAGE" /bin/sh -c 'git config user.name ci-bot && git config user.email ci-bot@example.com && mike deploy --deploy-prefix site -r $HTTPS_REMOTE -b $PAGES_BRANCH -u $4 latest && mike set-default --deploy-prefix site -r $HTTPS_REMOTE -b $PAGES_BRANCH latest'
-#docker run --rm -u $(id -u):$(id -g) -v $(pwd):/tmp -w /tmp "$MIKE_DOCKER_IMAGE" /bin/sh -c 'git config user.name ci-bot && git config user.email ci-bot@example.com && mike set-default latest'
-#docker run --rm -u $(id -u):$(id -g) -v $(pwd):/tmp -w /tmp "$MIKE_DOCKER_IMAGE" mkdocs build -d site
-
-echo "------ Move output to public folder --------"
-cp -r site/* public/
-rm -r site/
-
-###########################
-
echo "------ Zip the content and publish the zip again ------"
zip -r "content.zip" "public"
mv "content.zip" "public/"
diff --git a/publish_spec.sh b/publish_spec.sh
index f58dcae..fcb2baa 100755
--- a/publish_spec.sh
+++ b/publish_spec.sh
@@ -1,7 +1,7 @@
#!/bin/bash
-DOCKER_IMAGE=pandoc:toMkdocs
-TOOLS_DOCKER_IMAGE=generatechangemarks:toMkdocs
+DOCKER_IMAGE=pandoc:master
+TOOLS_DOCKER_IMAGE=generatechangemarks:master
echo "\n------ Checking for docker image --------"
docker pull "$DOCKER_IMAGE"
diff --git a/spec_on_pages.sh b/spec_on_pages.sh
index 7a09ead..71a25f0 100644
--- a/spec_on_pages.sh
+++ b/spec_on_pages.sh
@@ -74,8 +74,8 @@ if [[ ${10} == v* ]]; then
sed -i 's/VERSION/'${10}'/g' docs/download/index.md
echo " - Download: 'download/index.md'" >> mkdocs.yml
fi
-#if [[ ${11} =~ miguel[0-9]* ]]; then ##change to ^v* when testing finished
-if [ ${11} == "false" ]; then ##change to ^v* when testing finished
+
+if [ ${11} == "false" ]; then
echo "------ Generating site --------"
echo "Generating docs version ${10}..."
majorVersion=$(echo ${10} | grep -o v[1-9]*\. | grep -o [1-9]*)
diff --git a/toMkdocs/dockerfile.mike b/toMkdocs/dockerfile.mike
deleted file mode 100644
index fb317ca..0000000
--- a/toMkdocs/dockerfile.mike
+++ /dev/null
@@ -1,5 +0,0 @@
-FROM python:3.9-slim-bullseye
-
-RUN pip install rich mkdocs-material mkdocs-rss-plugin mike && \
- apt-get update &&\
- apt-get install -y git
diff --git a/toMkdocs/index.md b/toMkdocs/index.md
deleted file mode 100644
index 5302922..0000000
--- a/toMkdocs/index.md
+++ /dev/null
@@ -1,2 +0,0 @@
-Welcome to oneM2M Specifications
-
--
GitLab