-
Notifications
You must be signed in to change notification settings - Fork 15
/
first-time-setup.sh
executable file
·130 lines (102 loc) · 6.29 KB
/
first-time-setup.sh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
#!/bin/bash
set -e
GREEN='\033[0;32m'
PURPLE='\033[1;35m'
YELLOW='\033[0;33m'
BLUE='\033[1;34m'
JURISDICTION_NAME=${JURISDICTION_NAME:-$COUNTRY_NAME} # backwards compatibility
# Support non-interactive setup through env variables
if [[ $JURISDICTION_NAME ]] && [[ $REPOSITORY_URL ]]
then continue=Y
fi
if [[ ! $CI ]] && [[ -d .git ]]
then
echo 'It seems you cloned this repository, or already initialised it.'
echo 'Refusing to go further as you might lose work.'
echo "If you are certain this is a new repository, run 'cd $(dirname $0) && rm -rf .git' to erase the history."
exit 2
fi
while [[ ! "$JURISDICTION_NAME" ]]
do
echo -e "${GREEN}The name of the jurisdiction (usually a country, e.g. New Zealand, France…) you will model the rules of: \033[0m"
read JURISDICTION_NAME
done
lowercase_jurisdiction_name=$(echo $JURISDICTION_NAME | tr '[:upper:]' '[:lower:]' | sed 'y/āáǎàēéěèīíǐìōóǒòūúǔùǖǘǚǜĀÁǍÀĒÉĚÈĪÍǏÌŌÓǑÒŪÚǓÙǕǗǙǛ/aaaaeeeeiiiioooouuuuüüüüAAAAEEEEIIIIOOOOUUUUÜÜÜÜ/')
NO_SPACES_JURISDICTION_LABEL=$(echo $lowercase_jurisdiction_name | sed -r 's/[ ]+/_/g') # allow for hyphens to be used in jurisdiction names
SNAKE_CASE_JURISDICTION=$(echo $NO_SPACES_JURISDICTION_LABEL | sed -r 's/[-]+/_/g') # remove hyphens for use in Python
while [[ ! "$REPOSITORY_URL" ]]
do
echo -e "${GREEN}Your Git repository URL: \033[0m (i.e. https://githost.example/organisation/openfisca-jurisdiction)"
read REPOSITORY_URL
done
REPOSITORY_FOLDER=$(echo ${REPOSITORY_URL##*/})
cd $(dirname $0) # support being called from anywhere on the file system
echo -e "${PURPLE}Jurisdiction title set to: \033[0m${BLUE}$JURISDICTION_NAME\033[0m"
# Removes hyphens for python environment
echo -e "${PURPLE}Jurisdiction Python label: \033[0m${BLUE}$SNAKE_CASE_JURISDICTION\033[0m"
echo -e "${PURPLE}Git repository URL : \033[0m${BLUE}$REPOSITORY_URL\033[0m"
while [[ $continue != "y" ]] && [[ $continue != "Y" ]]
do
read -p "Would you like to continue (type Y for yes, N for no): " continue
if [[ $continue == "n" ]] || [[ $continue == "N" ]]
then exit 3
fi
done
parent_folder=${PWD##*/}
package_name="openfisca_$SNAKE_CASE_JURISDICTION"
last_bootstrapping_line_number=$(grep --line-number '^## Writing the Legislation' README.md | cut -d ':' -f 1)
last_changelog_number=$(grep --line-number '^# Example Entry' CHANGELOG.md | cut -d ':' -f 1)
first_commit_message='Initial import from OpenFisca country-template'
second_commit_message='Customise country-template through script'
if [[ ! $CI ]]
then
echo
cd ..
mv $parent_folder openfisca-$NO_SPACES_JURISDICTION_LABEL
cd openfisca-$NO_SPACES_JURISDICTION_LABEL
echo -e "${PURPLE}* ${PURPLE}Initialise git repository\033[0m"
git init --initial-branch=main > /dev/null 2>&1
git add .
git commit --no-gpg-sign --message "$first_commit_message" --author='OpenFisca Bot <[email protected]>' --quiet
echo -e "${PURPLE}* ${PURPLE}Initial git commit made to 'main' branch: '\033[0m${BLUE}$first_commit_message\033[0m${PURPLE}'\033[0m"
fi
all_module_files=`find openfisca_country_template -type f ! -name "*.DS_Store"`
echo -e "${PURPLE}* ${PURPLE}Replace default country_template references\033[0m"
# Use intermediate backup files (`-i`) with a weird syntax due to lack of portable 'no backup' option. See https://stackoverflow.com/q/5694228/594053.
sed -i.template "s|openfisca-country_template|openfisca-$NO_SPACES_JURISDICTION_LABEL|g" README.md Makefile pyproject.toml CONTRIBUTING.md
sed -i.template "s|country_template|$SNAKE_CASE_JURISDICTION|g" README.md pyproject.toml .flake8 Makefile MANIFEST.in $all_module_files
sed -i.template "s|Country-Template|$JURISDICTION_NAME|g" README.md pyproject.toml .github/PULL_REQUEST_TEMPLATE.md CONTRIBUTING.md
echo -e "${PURPLE}* ${PURPLE}Remove bootstrap instructions\033[0m"
sed -i.template -e "3,${last_bootstrapping_line_number}d" README.md # remove instructions lines
echo -e "${PURPLE}* ${PURPLE}Prepare \033[0m${BLUE}README.MD\033[0m${PURPLE} and \033[0m${BLUE}CONTRIBUTING.md\033[0m"
sed -i.template "s|https://example.com/repository|$REPOSITORY_URL|g" README.md CONTRIBUTING.md
echo -e "${PURPLE}* ${PURPLE}Prepare \033[0m${BLUE}CHANGELOG.md\033[0m"
sed -i.template -e "1,${last_changelog_number}d" CHANGELOG.md # remove country-template CHANGELOG leaving example
echo -e "${PURPLE}* ${PURPLE}Prepare \033[0m${BLUE}pyproject.toml\033[0m"
sed -i.template "s|https://github.com/openfisca/country-template|$REPOSITORY_URL|g" pyproject.toml
sed -i.template 's|:: 5 - Production/Stable|:: 1 - Planning|g' pyproject.toml
sed -i.template 's|^version = "[0-9.]*"|version = "0.0.1"|g' pyproject.toml
sed -i.template "s|repository_folder|$REPOSITORY_FOLDER|g" README.md
find . -name "*.template" -type f -delete
echo -e "${PURPLE}* ${PURPLE}Rename package to: \033[0m${BLUE}$package_name\033[0m"
git mv openfisca_country_template $package_name
echo -e "${PURPLE}* ${PURPLE}Remove single use first time setup files\033[0m"
git rm .github/workflows/first-time-setup.yml > /dev/null 2>&1
git rm first-time-setup.sh > /dev/null 2>&1
if [[ $CI ]]
then exit 0 # committing and tagging take directly place in the GitHub Actions workflow
fi
git add .
git commit --no-gpg-sign --message "$second_commit_message" --author='OpenFisca Bot <[email protected]>' --quiet
git tag "0.0.1"
echo -e "${PURPLE}* ${PURPLE}Second commit and first tag made on 'main' branch: '\033[0m${BLUE}$second_commit_message\033[0m${PURPLE}'\033[0m"
echo
echo -e "${YELLOW}* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * \033[0m"
echo -e "${YELLOW}*\033[0m"
echo -e "${YELLOW}*\033[0m Bootstrap complete, you can now push this codebase to your remote repository.\033[0m"
echo -e "${YELLOW}*\033[0m First, set up the remote with '${BLUE}git remote add origin <SSH repository URL>\033[0m'" # do not set this up automatically because we only know the HTTPS URL, which needs interactive authentication
echo -e "${YELLOW}*\033[0m You can then '${BLUE}git push origin main\033[0m'"
echo -e "${YELLOW}*\033[0m Then refer to the \033[0m${BLUE}README.md\033[0m"
echo -e "${YELLOW}*\033[0m The parent directory name has been changed, you can use ${BLUE}cd ../openfisca-${NO_SPACES_JURISDICTION_LABEL}\033[0m to navigate to it"
echo -e "${YELLOW}*\033[0m"
echo -e "${YELLOW}* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * \033[0m"