kbendick commented on a change in pull request #3008: URL: https://github.com/apache/iceberg/pull/3008#discussion_r696329059
########## File path: dev/deploy-site.sh ########## @@ -0,0 +1,62 @@ +#!/usr/bin/env bash +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# + +set -e + +usage () { + echo "Usage: $0 [-r <git_remote>]" + echo " -r Specify Git remote name. Defaults to \"apache\"" + exit 1 +} + +# Default repository remote name +remote="apache" + +while getopts "r:" opt; do + case "${opt}" in + r) + remote="${OPTARG}" + ;; + *) + usage + ;; + esac +done + +shift $((OPTIND-1)) + +if [[ -n $1 ]]; then + >&2 echo "Error: unrecognized argument '$1'" + usage +fi + +scriptdir="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )" +projectdir="$(dirname "$scriptdir")" + +pushd . +trap "popd" EXIT + +# If the following commands stop working, please check this ASF INFRA +# page for updates: https://infra.apache.org/asfyaml-mkdocs.html +cd ${projectdir}/site +rm -rf site +mkdir site +cp ../.asf.yaml site/ +mkdocs gh-deploy --dirty -r ${remote} Review comment: Thanks for the clarification, Carl! Nit: Given that it's kind of lengthy, and that the comment has been copied over from that GitHub comment, would it be easier to just include that link instead? Perhaps something like the following (please correct me if my explanation is incorrect): ``` --dirty flag is required as we copy over files and leave the working git branch with uncommitted changes before the mkdocs gh-deploy call. See https://github.com/apache/iceberg/pull/2998#discussion_r693517612 for further clarification? ``` Again, just a nit and up to you to change or not. Thanks for helping me understand 👍 -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
