Fixed company in mkpr.sh, mkrepo.sh, paste.sh

Author: jokram

TODO.md

@@ -0,0 +1,104 @@
+# TODO for configurable-company
+
+- [ ] `checkout.sh`: Necessary only if using submodules
+- [ ] `clean-checkout.sh`: Could be optimized if not using submodules
+- [ ] `clone.sh`: Necessary only if using Git LFS
+- [ ] `copr.sh`: Necessary only if using GitHub Enterprise
+- [ ] `enable-public-push.sh`: Necessary only if working additionally with github.com
+- [ ] `help.sh`: Help should be generated out of single commands.  
+  Maybe some commands will be skipped for a certain company
+- [ ] `install-helper.ps1`: to be analyzed
+- [ ] `install.bat`: to be analyzed
+- [ ] `install.sh`: to be analyzed
+- [ ] `mkpr.sh`: Necessary only if using GitHub Enterprise
+  - [x] Variables needs to be renamed (`GITHUB_*` => `GHE_*`)
+  - [x] `adsk` needs to be replaced with `$KIT_ID`
+  - [ ] slug specific code must be isolated
+- [ ] `mkrepo.sh`: Necessary only if using GitHub Enterprise
+  - [x] Variables needs to be renamed (`GITHUB_*` => `GHE_*`)
+- [ ] `paste.sh`: Necessary only if using GitHub Enterprise
+  - [x] Variables needs to be renamed (`GITHUB_*` => `GHE_*`)
+- [ ] `pull.sh`: Necessary only if using submodules
+- [ ] `setup.sh`: Split different tasks into separate scripts for better tailoring
+- [x] `show-deleted.sh`: OK
+- [ ] `teardown.sh`: Contains string << YOUR GITHUB SERVER >>. Should be replaced with
+  `$GHE_SERVER`
+- [x] `version.sh`: OK
+
+## Features
+- Submodules
+- Git LFS
+- GitHub Enterprise
+
+## Platforms
+- Windows
+- Mac OSx
+- Linux
+
+## Use Cases
+
+### Company adds company specific script
+There shall be a way to store company specific scripts. These scripts shall be
+included in help, ...
+
+### Company patches generic script
+There shall be a way to patch existing generic scripts for a company.
+
+### Company deletes generic script
+There shall be a way to delete generic scripts for a company, because they might
+be dangerous or the use case is not covered in that company.
+
+### Company updates generic scripts
+When updating the generic scripts to a new version then the added, patched and
+deleted scripts shall be kept. It is the repsonsiblity of the company to check
+if the company adaptations are still valid.
+
+### User specific scripts
+If users write own scripts they should not be overwritten when an update is done.
+
+## Design Ideas
+
+### Company specific folder
+On top-level there shall be a new folder with the $KIT_ID name, e.g. adsk which
+contains company specific scripts. When this folder only exists on a branch
+`adsk-production` then a merge would never have a conflict, because this folder
+only exists in that branch and not on the `master` branch.
+
+Proposed directory structure:
+```
+lib             => generic scripts, so move all scripts here
+lib/lnx         => generic linux specific scripts
+lib/osx         => generic OSx specific scripts
+lib/win         => generic windows specific scripts
+lib/other       => generic other specific scripts
+<company>       => company OS independent scripts
+<company>/lnx   => company linux specific scripts
+<company>/osx   => company osx specific scripts
+<company>/win   => company windows specific scripts
+<company>/other => company windows specific scripts
+```
+
+### Company adds company specific script
+Put the script in `<company>` folder.
+To get this working the `config.include` must be changed:
+```shell
+   ...
+   elif [ -e \"$KIT_PATH/<company>/$COMMAND.sh\" ]; then
+      bash \"$KIT_PATH/$COMMAND.sh\" $@; \
+  ...
+```
+### Company Adaptations
+#### Alternative A: disallow features in `enterprise.constants`
+- Some features (= scripts) might be dangerous
+- Based on values in `enterprise.constants` features (= scripts) shall be enabled
+  / disabled.
+- Therefore each script must check if the feature is allowed to avoid direct calls
+- In `config.include` there should be a check if the featrue is allowed before
+  calling it
+
+#### Alternative B: setup.sh shall run a company specific setup.sh
+In `setup.sh` at the end run `$KIT_ID/setup.sh` (if it exists) which contains
+company specific setup, e.g. scripts to be added, patched, or removed:
+- Added scripts: copy from a company folder to the main folder
+- Patched scripts: copy and overwrite from a company folder to the main folder
+- Removed scripts: delete from the main folder

mkpr.sh

@@ -33,11 +33,11 @@ KIT_PATH=$(dirname "$0")
 . "$KIT_PATH/lib/setup_helpers.sh"
 
 set +e
-BASE_BRANCH=$(git config 'adsk.pr-base-default')
+BASE_BRANCH=$(git config '$KIT_ID.pr-base-default')
 set -e
 CURRENT_BRANCH=$(git rev-parse --abbrev-ref HEAD)
-for BRANCH in $(git config --get-regexp 'adsk\.pr-base-branch-' | sed 's/.* //'); do
-    BRANCH=${BRANCH#adsk.pr-base-branch-}
+for BRANCH in $(git config --get-regexp '$KIT_ID\.pr-base-branch-' | sed 's/.* //'); do
+    BRANCH=${BRANCH#$KIT_ID.pr-base-branch-}
     shopt -s nocasematch
     case "$CURRENT_BRANCH" in
       *$BRANCH*)
@@ -50,7 +50,7 @@ done
 
 if [ -z "$BASE_BRANCH" ]
 then
-    error_exit "No base branch found.\n  Please configure your default Pull Request base with:\n  git config --local adsk.pr-base-default YourBaseBranch"
+    error_exit "No base branch found.\n  Please configure your default Pull Request base with:\n  git config --local $KIT_ID.pr-base-default YourBaseBranch"
 else
     print_success "Pull Request base: $BASE_BRANCH"
 fi
@@ -63,8 +63,8 @@ fi
 
 git push --set-upstream $REMOTE "$CURRENT_BRANCH"
 
-USER=$(git config adsk.github.account)
-PASSWORD="$(get_credentials $GITHUB_SERVER $USER)"
+USER=$(git config $KIT_ID.github.account)
+PASSWORD="$(get_credentials $GHE_SERVER $USER)"
 SLUG_REGEX='/autodesk\.com[:\/]([^\/]+\/[^\/\.]+)/ && print "$1\n"'
 SLUG=$(git config --get remote.$REMOTE.url | perl -ne "$SLUG_REGEX")
 
@@ -81,7 +81,7 @@ fi
 
 PR_URL=$(curl $CURL_RETRY_OPTIONS --silent --fail --user "$USER:$PASSWORD" -X POST \
         --data "{\"title\": \"$CURRENT_BRANCH\", \"head\": \"$CURRENT_BRANCH\", \"base\": \"$BASE_BRANCH\"}" \
-        "https://$GITHUB_SERVER/api/v3/repos/$SLUG/pulls" \
+        "https://$GHE_SERVER/api/v3/repos/$SLUG/pulls" \
     | perl -ne 'print "$1\n" if m%^\s*"html_url":\s*"(.*\/pull\/[0-9]+)"[,]?$%i' \
 )
 

mkrepo.sh

@@ -14,13 +14,13 @@ KIT_PATH=$(dirname "$0")
 . "$KIT_PATH/enterprise.constants"
 . "$KIT_PATH/lib/setup_helpers.sh"
 
-ADS_USER=$(git config --global adsk.github.account)
-[ -z "$ADS_USER" ] && error_exit 'Username must not be empty!'
+GHE_USER=$(git config --global $KIT_ID.github.account)
+[ -z "$GHE_USER" ] && error_exit 'Username must not be empty!'
 
-SERVER=$(git config --global adsk.github.server)
+SERVER=$(git config --global $KIT_ID.github.server)
 [ -z "$SERVER" ] && error_exit 'Server must not be empty!'
 
-TOKEN="$(get_credentials $SERVER $ADS_USER)"
+TOKEN="$(get_credentials $SERVER $GHE_USER)"
 [ -z "$TOKEN" ] && echo "Missing GitHub token" && exit 1
 
 URL="https://$SERVER/api/v3/user/repos"
@@ -39,4 +39,4 @@ then
   exit $STATUS
 fi
 
-echo "repo 'https://$SERVER/$ADS_USER/$REPO' created!"
+echo "repo 'https://$SERVER/$GHE_USER/$REPO' created!"

paste.sh

@@ -10,24 +10,24 @@ KIT_PATH=$(dirname "$0")
 . "$KIT_PATH/enterprise.constants"
 . "$KIT_PATH/lib/setup_helpers.sh"
 
-ADS_USER=$(git config --global adsk.github.account)
-SERVER=$(git config --global adsk.github.server)
+GHE_USER=$(git config --global $KIT_ID.github.account)
+SERVER=$(git config --global $KIT_ID.github.server)
 
-if [ -z "$ADS_USER" ]; then
+if [ -z "$GHE_USER" ]; then
   error_exit 'Username must not be empty!'
 fi
 
 if [ -z "$SERVER" ]; then
   error_exit 'Server must not be empty!'
 fi
 
-ADS_PASSWORD_OR_TOKEN="$(get_credentials $SERVER $ADS_USER)"
+GHE_PASSWORD_OR_TOKEN="$(get_credentials $SERVER $GHE_USER)"
 
-[ -z "$ADS_PASSWORD_OR_TOKEN" ] && echo "Could not obtain password or token" && exit 1
-[ "$ADS_PASSWORD_OR_TOKEN" = "" ] && echo "Blank password or token" && exit 1
+[ -z "$GHE_PASSWORD_OR_TOKEN" ] && echo "Could not obtain password or token" && exit 1
+[ "$GHE_PASSWORD_OR_TOKEN" = "" ] && echo "Blank password or token" && exit 1
 
 perl $KIT_PATH/lib/paste.pl \
-    --user $ADS_USER \
-    --token $ADS_PASSWORD_OR_TOKEN \
+    --user $GHE_USER \
+    --token $GHE_PASSWORD_OR_TOKEN \
     --server $SERVER \
     $@