From a3c31131b1cf54b4544ee6c63ee7cd886cc07b81 Mon Sep 17 00:00:00 2001 From: Florian3k Date: Tue, 21 Nov 2023 11:34:05 +0100 Subject: [PATCH] scaladoc - remove test deployment from CI --- .github/workflows/scaladoc.yaml | 15 ------ scaladoc/scripts/linkstovisit.txt | 13 ------ scaladoc/scripts/mk-index.sh | 77 ------------------------------- scaladoc/scripts/tocheck.txt | 0 4 files changed, 105 deletions(-) delete mode 100644 scaladoc/scripts/linkstovisit.txt delete mode 100755 scaladoc/scripts/mk-index.sh delete mode 100644 scaladoc/scripts/tocheck.txt diff --git a/.github/workflows/scaladoc.yaml b/.github/workflows/scaladoc.yaml index 3108f2b94562..31d9dbdd0336 100644 --- a/.github/workflows/scaladoc.yaml +++ b/.github/workflows/scaladoc.yaml @@ -62,21 +62,6 @@ jobs: - name: Generate documentation for example project using dotty-sbt run: ./project/scripts/sbt "sbt-test/scripted sbt-dotty/scaladoc" - - name: Generate index file - run: scaladoc/scripts/mk-index.sh scaladoc/output > scaladoc/output/index.html - - - name: Upload documentation to server - uses: azure/CLI@v1 - if: env.AZURE_STORAGE_SAS_TOKEN - env: - PR_NUMBER: ${{ github.event.pull_request.number }} - with: - inlineScript: | - DOC_DEST=$(echo pr-${PR_NUMBER:-${GITHUB_REF##*/}} | tr -d -c "[-A-Za-z0-9]") - echo uplading docs to https://scala3doc.virtuslab.com/$DOC_DEST - az storage container create --name $DOC_DEST --account-name scala3docstorage --public-access container - az storage blob upload-batch --overwrite true -s scaladoc/output -d $DOC_DEST --account-name scala3docstorage - stdlib-sourcelinks-test: runs-on: ubuntu-latest # if false - disable flaky test diff --git a/scaladoc/scripts/linkstovisit.txt b/scaladoc/scripts/linkstovisit.txt deleted file mode 100644 index c615ece17d35..000000000000 --- a/scaladoc/scripts/linkstovisit.txt +++ /dev/null @@ -1,13 +0,0 @@ -./self/api/dotty.tools.scaladoc/tasty/comments/wiki/-converter/index.html,on any page try minimizing window to see if relative styles are applied correctly -./self/api/dotty.tools.scaladoc/-base-key/index.html,is searchbar correct width -./self/api/dotty.tools.scaladoc/as-map.html,are logos in good propotions -./self/api/dotty.tools.scaladoc/model/api/as-signature.html,is sidebar not collapsing/overlaying -./self/api/dotty.tools.scaladoc/-documentable-element/index.html,are overrides pointing to correct function? is filtering working -./self/api/dotty.tools.scaladoc/model/api/-member/index.html,is source link pointing to correct element (object Member)? -./self/api/dotty.tools.scaladoc/-scala-content-node/index.html,you can see is graph properly rendered; can you navigate by nodes up and down the hierarchy -./self/api/index/index.html,package overview -./self/api/dotty.tools.scaladoc/index.html,example package -./self/api/dotty.tools.scaladoc/-documentable-element/index.html,example classlike -./self/api/dotty.tools.scaladoc/get-from-extra.html,example package level method -./self/api/dotty.tools.scaladoc/put.html,example extension -./self/api/dotty.tools.scaladoc/-dot-diagram-builder/build.html,example method diff --git a/scaladoc/scripts/mk-index.sh b/scaladoc/scripts/mk-index.sh deleted file mode 100755 index d4d72aec0d84..000000000000 --- a/scaladoc/scripts/mk-index.sh +++ /dev/null @@ -1,77 +0,0 @@ -#!/usr/bin/env bash - -# NOTE that this file is used in CI - -MYDIR="$(dirname "$(readlink -f "$0")")" - - -function html-beginning { - cat << EOF - - -EOF -} - -function html-ending { -cat << EOF - - -EOF -} - -function print-beginning { - cat << EOF -

$1

- -EOF -} - -cd "$1" || exit - - -html-beginning -print-beginning "Available project:" -for f in * -do - ! [[ -d $f ]] && continue - # assuming that there's only one "root" index file - # if there's a static site, it's at depth 1 - # otherwise at depth 2 - INDEX=$(find "$f" -maxdepth 1 -name 'index.html') - if [[ -z $INDEX ]] - then - INDEX=$(find "$f" -maxdepth 2 -name 'index.html') - fi - print-list-element "$INDEX" "$f" -done -print-ending - -print-beginning "Links for manual testing:" -while read line; do - print-list-element-text "$line" -done < "$MYDIR/tocheck.txt" - -while read line; do - IFS=',' read INDEX f <<< "${line}" - print-list-element "$INDEX" "$f" -done < "$MYDIR/linkstovisit.txt" -print-ending -html-ending diff --git a/scaladoc/scripts/tocheck.txt b/scaladoc/scripts/tocheck.txt deleted file mode 100644 index e69de29bb2d1..000000000000