#785 Antora 3.0 related updates
Merged 2 years ago by bcotton. Opened 2 years ago by siosm.
fedora-docs/ siosm/release-notes antora3  into  master

file modified
+17 -16
@@ -3,30 +3,30 @@ 

  image="docker.io/antora/antora"

  cmd="--html-url-extension-style=indexify site.yml"

  

- if [ "$(uname)" == "Darwin" ]; then

+ if uname | grep -iwq darwin; then

      # Running on macOS.

      # Let's assume that the user has the Docker CE installed

      # which doesn't require a root password.

      echo ""

      echo "This build script is using Docker container runtime to run the build in an isolated environment."

      echo ""

-     docker run --rm -it -v $(pwd):/antora $image $cmd

+     docker run --rm -it -v "$(pwd):/antora" "${image}" "${cmd}"

  

- elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then

+ elif uname | grep -iq linux; then

      # Running on Linux.

      # there isn't an antora/aarch64 container, antora can be installed locally

      # Check whether podman is available, else faill back to docker

      # which requires root.

  

      if [ -f /usr/local/bin/antora ]; then

-         /usr/local/bin/antora $cmd

-     elif [[ `uname -m` == "aarch64" ]]; then

+         /usr/local/bin/antora "${cmd}"

+     elif uname -m | grep -iwq aarch64; then

          echo "no antora/aarch64 container try just \`npm install -g @antora/cli @antora/site-generator-default\`"

      elif [ -f /usr/bin/podman ]; then

          echo ""

          echo "This build script is using Podman to run the build in an isolated environment."

          echo ""

-         podman run --rm -it -v $(pwd):/antora:z $image $cmd

+         podman run --rm -it -v "$(pwd):/antora:z" "${image}" "${cmd}"

  

      elif [ -f /usr/bin/docker ]; then

          echo ""
@@ -34,18 +34,19 @@ 

          echo ""

  

          if groups | grep -wq "docker"; then

- 	    docker run --rm -it -v $(pwd):/antora:z $image $cmd

- 	else

+             docker run --rm -it -v "$(pwd):/antora:z" "${image}" "${cmd}"

+         else

+             echo "You might be asked for your password."

+             echo "You can avoid this by adding your user to the 'docker' group,"

+             echo "but be aware of the security implications."

+             echo "See https://docs.docker.com/install/linux/linux-postinstall/"

              echo ""

-             echo "This build script is using $runtime to run the build in an isolated environment. You might be asked for your password."

-             echo "You can avoid this by adding your user to the 'docker' group, but be aware of the security implications. See https://docs.docker.com/install/linux/linux-postinstall/."

-             echo ""

-             sudo docker run --rm -it -v $(pwd):/antora:z $image $cmd

- 	fi

+             sudo docker run --rm -it -v "$(pwd):/antora:z" "${image}" "${cmd}"

+         fi

      else

          echo ""

- 	echo "Error: Container runtime haven't been found on your system. Fix it by:"

- 	echo "$ sudo dnf install podman"

- 	exit 1

+         echo "Error: Container runtime haven't been found on your system. Fix it by:"

+         echo "$ sudo dnf install podman"

+         exit 1

      fi

  fi

file modified
+3 -3
@@ -1,13 +1,13 @@ 

  #!/bin/sh

  

- if [ "$(uname)" == "Darwin" ]; then

+ if [ "$(uname)" = "Darwin" ]; then

      # Running on macOS.

      # Let's assume that the user has the Docker CE installed

      # which doesn't require a root password.

      echo "The preview will be available at http://localhost:8080/"

-     docker run --rm -v $(pwd):/antora:ro -v $(pwd)/nginx.conf:/etc/nginx/conf.d/default.conf:ro -p 8080:80 nginx

+     docker run --rm -v "$(pwd):/antora:ro" -v "$(pwd)/nginx.conf:/etc/nginx/conf.d/default.conf:ro" -p 8080:80 nginx

  

- elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then

+ elif [ "$(expr substr "$(uname -s)" 1 5)" = "Linux" ]; then

      # Running on Linux.

      # Fedora Workstation has python3 installed as a default, so using that

      echo ""

file modified
+2 -2
@@ -1,6 +1,6 @@ 

  site:

    title: Local Preview

-   start_page: fedora:release-notes:index

+   start_page: fedora:release-notes:index.adoc

  content:

    sources:

     - url: .
@@ -18,5 +18,5 @@ 

    destinations:

    - provider: archive

  runtime:

-   pull: true

+   fetch: true

    cache_dir: ./cache

rebased onto e6f3fe73b1c3b1e7c0afe27d78458d0decebeaf3

2 years ago

rebased onto 32bed61

2 years ago

Pull-Request has been merged by bcotton

2 years ago