Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Manually update gh-pages at next release #506

Closed
FWDekker opened this issue Dec 5, 2023 · 1 comment
Closed

Manually update gh-pages at next release #506

FWDekker opened this issue Dec 5, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@FWDekker
Copy link
Owner

FWDekker commented Dec 5, 2023

The cd.yml workflow introduced in #505 will not automatically import old docs correctly. Some manual work is needed before publishing the release on GitHub:

If the up-to-date gh-pages is in the folder /tmp/gh-pages/ and the main branch is in /tmp/main/, then run

PDIR="/tmp/gh-pages/"
MDIR="/tmp/main/"

cd "$PDIR"
mkdir older/
mv gh-pages/v* older/

cd "$MDIR"
./gradlew -Pdokka.pagesDir="$PDIR"
cd -

rm -rf "$PDIR/"*
mv "$MDIR/build/dokka/html/"* "$PDIR/"

and commit and push the changes in /tmp/gh-pages/ to the gh-pages branch.

@FWDekker FWDekker added the documentation Improvements or additions to documentation label Dec 5, 2023
@FWDekker FWDekker self-assigned this Dec 5, 2023
@FWDekker
Copy link
Owner Author

FWDekker commented Dec 9, 2023

Fixed in d8515cb.

@FWDekker FWDekker closed this as completed Dec 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant