From b93d89b214c0b1c3bf36a8ac65e8cfb6445b5c3e Mon Sep 17 00:00:00 2001 From: Laurenz Rettig <53396064+rettigl@users.noreply.github.com> Date: Sun, 12 Jan 2025 01:09:13 +0100 Subject: [PATCH 1/3] Update README.md Set default docs to stable version --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index df51b61e..d953358f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![Documentation Status](https://github.com/OpenCOMPES/sed/actions/workflows/documentation.yml/badge.svg)]([https://opencompes.github.io/sed/](https://opencompes.github.io/docs/sed/latest/)) +[![Documentation Status](https://github.com/OpenCOMPES/sed/actions/workflows/documentation.yml/badge.svg)]([https://opencompes.github.io/sed/](https://opencompes.github.io/docs/sed/stable/)) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) ![](https://github.com/OpenCOMPES/sed/actions/workflows/linting.yml/badge.svg?branch=main) ![](https://github.com/OpenCOMPES/sed/actions/workflows/testing_multiversion.yml/badge.svg?branch=main) @@ -58,11 +58,11 @@ pip install sed-processor # Documentation Comprehensive documentation including several workflow examples can be found here: -https://opencompes.github.io/docs/sed/latest/ +https://opencompes.github.io/docs/sed/stable/ # Contributing -Users are welcome to contribute to the development of **sed-processor**. Information how to contribute, including how to install developer versions can be found in the [documentation](https://opencompes.github.io/docs/sed/latest/misc/contribution.html) +Users are welcome to contribute to the development of **sed-processor**. Information how to contribute, including how to install developer versions can be found in the [documentation](https://opencompes.github.io/docs/sed/stable/misc/contribution.html) We would like to thank our contributors! From 34f0fa40ac1c8fcc1680afbdd0f05895b6d02da9 Mon Sep 17 00:00:00 2001 From: rettigl Date: Sun, 12 Jan 2025 22:20:01 +0100 Subject: [PATCH 2/3] fix badge link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d953358f..ae4b766f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![Documentation Status](https://github.com/OpenCOMPES/sed/actions/workflows/documentation.yml/badge.svg)]([https://opencompes.github.io/sed/](https://opencompes.github.io/docs/sed/stable/)) +[![Documentation Status](https://github.com/OpenCOMPES/sed/actions/workflows/documentation.yml/badge.svg)](https://opencompes.github.io/docs/sed/stable/) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) ![](https://github.com/OpenCOMPES/sed/actions/workflows/linting.yml/badge.svg?branch=main) ![](https://github.com/OpenCOMPES/sed/actions/workflows/testing_multiversion.yml/badge.svg?branch=main) From bb43e404c25ec968e83d7f9c99541f50db455c06 Mon Sep 17 00:00:00 2001 From: rettigl Date: Sun, 12 Jan 2025 22:22:45 +0100 Subject: [PATCH 3/3] create latest link on publish remove old docs before copy --- .github/workflows/documentation.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 2bdc8cee..17db4420 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -131,10 +131,14 @@ jobs: VERSION=${GITHUB_REF#refs/tags/} echo "folder=sed/$VERSION" >> $GITHUB_OUTPUT rm docs-repo/sed/stable + rm -rf docs-repo/sed/latest ln -s -r docs-repo/sed/$VERSION docs-repo/sed/stable + ln -s -r docs-repo/sed/$VERSION docs-repo/sed/latest elif [[ $GITHUB_REF == refs/heads/main ]]; then + rm -rf docs-repo/sed/latest echo "folder=sed/latest" >> $GITHUB_OUTPUT else + rm -rf docs-repo/sed/develop echo "folder=sed/develop" >> $GITHUB_OUTPUT fi