1
0
mirror of https://github.com/qTox/qTox.git synced 2024-03-22 14:00:36 +08:00

chore(test-pr.sh): add test-pr.sh script as requested

Add missing copyright stuff to `merge-pr.sh`.

Refactored & split `merge-pr.sh` script, since most of required
code for `test-pr.sh` already existed there.

Differences from `merge-pr.sh`:
  * if there's no `upstream` remote, https version is used instead of
    git
  * merge commit *is not* GPG-signed (less hassle)
  * merge branch is named e.g. `test1234` instead of `merge1234`
  * instructions for pushing test branch onto upstream master are not
    printed
This commit is contained in:
Zetok Zalbavar 2016-06-18 20:10:45 +01:00
parent d94f5f3bd8
commit 784d42d8d7
No known key found for this signature in database
GPG Key ID: C953D3880212068A
3 changed files with 192 additions and 57 deletions

View File

@ -1,6 +1,6 @@
#!/bin/bash
#
# Copyright © 2016 Zetok Zalbavar
# Copyright © 2016 Zetok Zalbavar <zetok@openmailbox.org>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
@ -29,71 +29,34 @@
# before the appended shortlog.
#
PR=$1
set -e -o pipefail
readonly PR=$1
# make sure to add newlines to the message, otherwise merge message
# will not look well
if [[ ! -z $2 ]]
then
OPT_MSG="
readonly OPT_MSG="
$2
"
fi
# check if supplied var is a number; if not exit
if [[ ! "${PR}" =~ ^[[:digit:]]+$ ]]
then
echo "Not a PR number!" && \
exit 1
fi
# list remotes, and if there's no tux3 one, add it
if ! git remote | grep upstream > /dev/null
then
git remote add upstream git@github.com:tux3/qTox.git
fi
# print the message only if the merge was successful
after_merge_msg() {
echo ""
echo "PR #$PR was merged into «merge$PR» branch."
echo "To compare with master:"
echo ""
echo " git diff master..merge$PR"
echo ""
echo "To push that to master on github:"
echo ""
echo " git checkout master && git merge --ff merge$PR && git push upstream master"
echo ""
echo "After pushing to master, delete branches:"
echo ""
echo " git branch -d {merge,}$PR"
echo ""
echo "To discard any changes:"
echo ""
echo " git checkout master && git branch -D {merge,}$PR"
echo ""
source_functions() {
local fns_file="tools/lib/PR_bash.source"
source $fns_file
}
# print the message only if some merge step failed
after_merge_failure_msg() {
echo ""
echo "Merge failed."
echo ""
echo "You may want to remove not merged branches, if they exist:"
echo ""
echo " git checkout master && git branch -D {merge,}$PR"
echo ""
main() {
local remote_name="upstream"
local merge_branch="merge"
source_functions
exit_if_not_pr $PR
add_remote
get_sources
merge "-S" \
&& after_merge_msg $merge_branch \
|| after_merge_failure_msg $merge_branch
}
git fetch upstream && \
git checkout master && \
git rebase upstream/master master && \
git fetch upstream pull/$PR/head:$PR && \
git checkout master -b merge$PR && \
git merge --no-ff -S $PR -m "Merge pull request #$PR
$OPT_MSG
$(git shortlog master..$PR)" && \
after_merge_msg || after_merge_failure_msg
main

61
test-pr.sh Executable file
View File

@ -0,0 +1,61 @@
#!/bin/bash
#
# Copyright © 2016 Zetok Zalbavar <zetok@openmailbox.org>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# Script for testing pull requests. Works only when there are no merge
# conflicts. Assumes that working dir is a qTox git repo.
#
# usage:
# ./$script $pr_number $optional_message
#
#
# $pr_number number of the PR as shown on GH
# $optional_message message that is going to be put in merge commit,
# before the appended shortlog.
#
set -e -o pipefail
readonly PR=$1
# make sure to add newlines to the message, otherwise merge message
# will not look well
if [[ ! -z $2 ]]
then
readonly OPT_MSG="
$2
"
fi
source_functions() {
local fns_file="tools/lib/PR_bash.source"
source $fns_file
}
main() {
local remote_name="upstream"
local merge_branch="test"
source_functions
exit_if_not_pr $PR
add_remote "https"
get_sources
merge "--no-gpg-sign" \
&& after_merge_msg $merge_branch \
|| after_merge_failure_msg $merge_branch
}
main

111
tools/lib/PR_bash.source Normal file
View File

@ -0,0 +1,111 @@
#!/bin/bash
#
# Copyright © 2016 Zetok Zalbavar <zetok@openmailbox.org>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# Source for bash functions used in `/{merge,test}-pr.sh`.
#
# Only to be sourced in those files.
set -e -o pipefail
is_pr_number() {
# check if supplied var is a number; if not exit
[[ "$@" =~ ^[[:digit:]]+$ ]]
}
exit_if_not_pr() {
is_pr_number $@ \
|| (echo "Not a PR number!" \
&& exit 1 )
}
# check if remote is present
is_remote_present() {
git remote \
| grep $@ > /dev/null
}
# there's no tux3 remote, add it
# if `https` is supplied, https version of repo is used
add_remote() {
local remote_url="git@github.com:tux3/qTox.git"
local remote_name="upstream"
# change to https if needed
[[ "$@" == "https" ]] \
&& local remote_url="https://github.com/tux3/qTox.git"
is_remote_present $remote_name \
|| git remote add $remote_name "${remote_url}"
}
# print the message only if the merge was successful
#
# supply either `merge`, `test` or whatever else merge branch name you want
after_merge_msg() {
echo ""
echo "PR #$PR was merged into «$@$PR» branch."
echo "To compare with master:"
echo ""
echo " git diff master..$@$PR"
echo ""
if [[ "$@" == "merge" ]]
then
echo "To push that to master on github:"
echo ""
echo " git checkout master && git merge --ff $@$PR && git push upstream master"
echo ""
echo "After pushing to master, delete branches:"
echo ""
echo " git branch -d {$@,}$PR"
echo ""
fi
echo "To discard any changes:"
echo ""
echo " git checkout master && git branch -D {$@,}$PR"
echo ""
}
# print the message only if some merge step failed
after_merge_failure_msg() {
echo ""
echo "Merge failed."
echo ""
echo "You may want to remove not merged branches, if they exist:"
echo ""
echo " git checkout master && git branch -D {$@,}$PR"
echo ""
}
get_sources() {
add_remote
git fetch $remote_name && \
git checkout master && \
git rebase $remote_name/master master && \
git fetch $remote_name pull/$PR/head:$PR && \
git checkout master -b $merge_branch$PR
}
# check whether to sign
merge() {
local signed="$@"
git merge --no-ff $signed $PR -m "Merge pull request #$PR
$OPT_MSG
$(git shortlog master..$PR)"
}