pokeapi/Resources/scripts/updater.sh

202 lines
5.7 KiB
Bash
Raw Normal View History

2020-04-23 19:48:55 +00:00
#!/bin/bash
2020-04-25 20:50:08 +00:00
# Executed when the master branch of PokeAPI/pokeapi gets updated
# Runs in CircleCI
# Generates new data using the latest changes of PokeAPI/pokeapi in order to open a Pull Request towards PokeAPI/api-data
2020-04-23 19:48:55 +00:00
set -o pipefail
org='PokeAPI'
data_repo='api-data'
2020-04-25 19:15:41 +00:00
engine_repo='pokeapi'
branch_name='updated-data'
2020-04-25 19:15:41 +00:00
username='pokeapi-machine-user'
email='pokeapi.co@gmail.com'
2020-04-30 21:53:46 +00:00
# Exit the script notifying the user about its success
cleanexit() {
2020-04-25 19:15:41 +00:00
echo "Exiting"
echo "$2"
2020-04-30 12:51:52 +00:00
if [ "$1" -gt "0" ]; then
notify_engine_pr "end_failed"
else
notify_engine_pr "end_success"
fi
2020-04-25 20:50:08 +00:00
exit $1
2020-04-25 19:15:41 +00:00
}
2020-04-23 19:48:55 +00:00
# Create and use a personal folder
2020-04-23 19:48:55 +00:00
prepare() {
2020-04-24 20:49:53 +00:00
mkdir -p ./repositories
2020-04-25 19:15:41 +00:00
cd repositories || cleanexit 1 "Failed to cd"
}
# Not used
# Check and return the number of the Pull Request that started this job
2020-04-25 19:15:41 +00:00
get_invokator_pr_number() {
if [ -z "$CIRCLE_PULL_REQUEST" ]; then
echo "${CIRCLE_PULL_REQUEST##*/}"
fi
2020-04-23 19:48:55 +00:00
}
# Clone the repository containing the static JSON files
2020-04-23 19:48:55 +00:00
clone() {
2020-04-25 19:15:41 +00:00
git clone "https://github.com/${org}/${data_repo}.git" "$data_repo"
2020-04-23 19:48:55 +00:00
}
# Configure git to use the supplied user when committing
2020-04-23 19:48:55 +00:00
configure_git() {
2020-04-25 19:15:41 +00:00
git config --global user.name "$username"
git config --global user.email "$email"
}
2020-04-30 12:51:52 +00:00
pr_input_updater_start() {
2020-04-25 19:15:41 +00:00
cat <<EOF
{
2020-04-30 21:53:46 +00:00
"body": "A [PokeAPI/api-data](https://github.com/PokeAPI/api-data) refresh has started. In 40 minutes a Pull Request will be created over there and assigned to the PokeAPI Core team to be reviewed. If approved and merged new data will soon be available worldwide."
2020-04-25 19:15:41 +00:00
}
EOF
}
2020-04-30 12:51:52 +00:00
pr_input_updater_end_success() {
cat <<EOF
{
2020-04-30 21:53:46 +00:00
"body": "The updater script has finished its job and has now opened a Pull Request towards the [PokeAPI/api-data](https://github.com/PokeAPI/api-data/pulls) repository with the updated data."
2020-04-30 12:51:52 +00:00
}
EOF
}
pr_input_updater_end_failed() {
cat <<EOF
{
2020-04-30 21:53:46 +00:00
"body": "The updater script couldn't finish its job. Please check [CircleCI's logs](https://app.circleci.com/pipelines/github/PokeAPI/pokeapi)."
2020-04-30 12:51:52 +00:00
}
EOF
}
2020-04-30 21:53:46 +00:00
# If the job was started by a Pull Request, add a comment to notify the users
2020-04-30 12:51:52 +00:00
notify_engine_pr() {
2020-04-30 17:42:56 +00:00
if [[ $1 == "start" || $1 == "end_failed" || $1 == "end_success" ]]; then
2020-04-30 12:51:52 +00:00
if ! [ -z "$CIRCLE_PULL_REQUEST" ]; then
engine_repo_pr_number="${CIRCLE_PULL_REQUEST##*/}"
curl -f -H "Authorization: token $MACHINE_USER_GITHUB_API_TOKEN" -X POST --data "$(pr_input_updater_$1)" "https://api.github.com/repos/$org/$engine_repo/issues/${engine_repo_pr_number}/comments"
fi
2020-04-25 19:15:41 +00:00
fi
2020-04-23 19:48:55 +00:00
}
# Run the updater script (https://github.com/PokeAPI/api-data/blob/master/updater/cmd.bash) which will generate the new pokeapi data and push it to the api-data repository under a new branch
2020-04-24 20:49:53 +00:00
run_updater() {
2020-04-25 19:15:41 +00:00
cd "${data_repo}/updater" || cleanexit 1 "Failed to cd"
# Wait to be sure PokeAPI/pokeapi:origin/master has been updated on Github with the lastest merged PR content
sleep 10
# Build the updater image
2020-04-24 20:49:53 +00:00
docker build -t pokeapi-updater .
2020-04-25 19:15:41 +00:00
if [ $? -ne 0 ]; then
cleanexit 1 "Failed to build the pokeapi-updater image"
fi
# Run the updater
docker run --privileged -e COMMIT_EMAIL="$email" -e COMMIT_NAME="$username" -e BRANCH_NAME="$branch_name" -e REPO_POKEAPI="https://github.com/${org}/${engine_repo}.git" -e REPO_DATA="https://${MACHINE_USER_GITHUB_API_TOKEN}@github.com/${org}/${data_repo}.git" pokeapi-updater
if [ $? -ne 0 ]; then
2020-04-25 20:50:08 +00:00
cleanexit 1 "Failed to run the pokeapi-updater container"
2020-04-25 19:15:41 +00:00
fi
cd .. || cleanexit 1 "Failed to cd"
2020-04-23 19:48:55 +00:00
}
# Check if the updater script has pushed the data to a new branch
2020-04-25 19:15:41 +00:00
check_remote_branch() {
# Wait for Github to update origin/${branch_name}
sleep 10
2020-04-25 19:15:41 +00:00
curl -f -H "Authorization: token $MACHINE_USER_GITHUB_API_TOKEN" -X GET "https://api.github.com/repos/$org/$data_repo/branches/$1"
if [ $? -ne 0 ]; then
cleanexit 1 "The updater script failed to push the new data"
2020-04-25 19:15:41 +00:00
fi
}
2020-04-24 20:49:53 +00:00
pr_input_content() {
2020-04-23 19:48:55 +00:00
cat <<EOF
{
"title": "API data update",
2020-04-25 19:15:41 +00:00
"body": "Incoming data generated by https://github.com/${org}/${engine_repo} CircleCI worker",
2020-04-23 19:48:55 +00:00
"head": "$branch_name",
"base": "master",
"assignees": [
"Naramsim"
],
"labels": [
"api-data-update"
]
}
EOF
}
# Create a Pull Request to merge the branch recently pushed by the updater with the master branch
create_pr() {
2020-04-30 12:51:52 +00:00
data_repo_pr_number=$(curl -H "Authorization: token $MACHINE_USER_GITHUB_API_TOKEN" -X POST --data "$(pr_input_content)" "https://api.github.com/repos/$org/$data_repo/pulls" | jq '.number')
if [[ "$data_repo_pr_number" = "null" ]]; then
cleanexit 1 "Couldn't create the Pull Request"
fi
2020-04-30 12:51:52 +00:00
echo "$data_repo_pr_number"
}
pr_input_assignees_and_labels() {
2020-04-23 20:31:08 +00:00
cat <<EOF
{
"assignees": [
"Naramsim"
],
"labels": [
"api-data-update"
]
}
EOF
}
# Assign the PR to Naramsim and add a label
customize_pr() {
# Wait for Github to open the PR
sleep 10
2020-04-30 12:51:52 +00:00
data_repo_pr_number=$1
curl -H "Authorization: token $MACHINE_USER_GITHUB_API_TOKEN" -X PATCH --data "$(pr_input_assignees_and_labels)" "https://api.github.com/repos/$org/$data_repo/issues/$data_repo_pr_number"
if [ $? -ne 0 ]; then
echo "Couldn't add Assignees and Labes to the Pull Request"
fi
}
2020-04-25 20:50:08 +00:00
pr_input_reviewers() {
2020-04-23 19:48:55 +00:00
cat <<EOF
{
"reviewers": [
"Naramsim"
2020-04-25 20:50:08 +00:00
],
"team_reviewers": [
"core-team"
2020-04-23 19:48:55 +00:00
]
}
EOF
}
# Request the Core team to review the Pull Request
add_reviewers_to_pr() {
2020-04-30 12:51:52 +00:00
data_repo_pr_number=$1
curl -H "Authorization: token $MACHINE_USER_GITHUB_API_TOKEN" -X POST --data "$(pr_input_reviewers)" "https://api.github.com/repos/$org/$data_repo/pulls/$data_repo_pr_number/requested_reviewers"
2020-04-24 19:18:26 +00:00
if [ $? -ne 0 ]; then
echo "Couldn't add Reviewers to the Pull Request"
fi
2020-04-23 19:48:55 +00:00
}
prepare
configure_git
2020-04-30 21:53:46 +00:00
clone
2020-04-30 12:51:52 +00:00
notify_engine_pr "start"
2020-04-24 20:49:53 +00:00
run_updater
2020-04-25 19:15:41 +00:00
check_remote_branch "$branch_name"
2020-04-30 12:51:52 +00:00
data_repo_pr_number=$(create_pr)
customize_pr "$data_repo_pr_number"
add_reviewers_to_pr "$data_repo_pr_number"
2020-04-25 20:50:08 +00:00
cleanexit 0 'Done'