From d106bf4b66b91052e6866137e458df37a87947f1 Mon Sep 17 00:00:00 2001 From: Vojtech Knaisl Date: Wed, 16 Aug 2023 15:30:59 +0200 Subject: [PATCH] WIP --- .github/workflows/build.yml | 2 +- Makefile | 4 ++-- README.md | 13 +++++++++++-- assets/custom.js | 1 + changelog.rst | 4 ++-- scripts/main.py | 13 +++++++------ 6 files changed, 24 insertions(+), 13 deletions(-) create mode 100644 assets/custom.js diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 31931e6..87c3c90 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -35,7 +35,7 @@ jobs: env: PUBLIC_IMAGE_PREFIX: 'datastewardshipwizard' - IMAGE_NAME: 'guide-changelog' + IMAGE_NAME: 'wizard-changelog' DOCKER_META_CONTEXT: '.' DOCKER_META_FILE: './Dockerfile' DOCKER_META_PLATFORMS: 'linux/amd64,linux/arm64' diff --git a/Makefile b/Makefile index c928db4..d1bbc5e 100644 --- a/Makefile +++ b/Makefile @@ -20,5 +20,5 @@ clean: .PHONY: docker docker: - docker build -t guide-changelog:local . - docker run --rm --name "guide-changelog" -p 8888:8080 guide-changelog:local + docker build -t wizard-changelog:local . + docker run --rm --name "wizard-changelog" -p 8888:8080 wizard-changelog:local diff --git a/README.md b/README.md index 57ff8d6..d585be6 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,24 @@ -# Guide Changelog +# Wizard Changelog [![User Guide](https://img.shields.io/badge/docs-User%20Guide-informational)](https://guide.ds-wizard.org) [![License](https://img.shields.io/github/license/ds-wizard/guide-changelog)](LICENSE) -*Changelog for Data Stewardship Wizard Guide +*Changelog for Data Stewardship Wizard* ### Requirements - **Python** (recommended 3.11) - **Makefile** (recommended 3.81) + +### Run + +For building the changelog, please run the following from the root of the project + +```bash +$ make build +``` + ## License This project is licensed under the Apache License v2.0 - see the [LICENSE](LICENSE) file for more details. \ No newline at end of file diff --git a/assets/custom.js b/assets/custom.js new file mode 100644 index 0000000..7088bf7 --- /dev/null +++ b/assets/custom.js @@ -0,0 +1 @@ +console.log('Loaded Wizard changelog...') diff --git a/changelog.rst b/changelog.rst index acd6bc6..97ffb13 100644 --- a/changelog.rst +++ b/changelog.rst @@ -1,5 +1,5 @@ -Wizard Guide Changelog -********************** +Wizard Changelog +**************** .. This is a workaround to random anchor links generation by Sphinx diff --git a/scripts/main.py b/scripts/main.py index b58cdc2..aec900e 100644 --- a/scripts/main.py +++ b/scripts/main.py @@ -28,24 +28,25 @@ f_out.write( line .replace( - 'Wizard Guide Changelog', - """Wizard Guide Changelog + 'Wizard Changelog', + """Wizard Changelog + """ ) .replace( - '

Wizard Guide Changelog

', + '

Wizard Changelog

', '' ) .replace( - '
', + '
', """

-
| Guide Changelog
+
| Wizard Changelog

-
+
""" ) )