ci: extract cleanup into a separate script

Author: sonulen

.github/workflows/cleanup.yml

@@ -8,7 +8,6 @@ on:
     branches: [main]
 
 jobs:
-
   # Run cleaning process only if workflow is triggered by the non-"android-library-template" repository.
   template-cleanup:
     name: Template Cleanup
@@ -17,31 +16,14 @@ jobs:
     permissions:
       contents: write
     steps:
-
       # Check out current repository
       - name: Fetch Sources
         uses: actions/checkout@v4
 
       # Cleanup project
       - name: Cleanup
         run: |
-          # Prepare variables
-          NAME="${GITHUB_REPOSITORY##*/}"
-          SAFE_NAME=$(echo $NAME | sed 's/[^a-zA-Z0-9]//g' | tr '[:upper:]' '[:lower:]')
-
-          # Replace
-          sed -i "s/stub/$SAFE_NAME/g" $(find . -type f -not -path "**/build/**" -not -path "**/.**")
-          sed -i "s/Stub/$NAME/g" $(find . -type f -not -path "**/build/**" -not -path "**/.**")
-
-          # Move stub
-          mv stub/src/main/kotlin/Stub.kt stub/src/main/kotlin/$NAME.kt
-          mv stub/ $SAFE_NAME
-
-          # Cleanup
-          rm .github/workflows/cleanup.yml
-
-          # Remove leftover empty directories
-          find . -type d -empty -delete
+          ./cleanup.sh "${GITHUB_REPOSITORY##*/}"
 
       # Commit modified files
       - name: Commit files

.github/workflows/main.yml

@@ -23,6 +23,8 @@ jobs:
           java-version: 17
       - name: Setup Gradle
         uses: gradle/actions/setup-gradle@v3
+      - name: Cleanup project
+        run: ./cleanup.sh TestTemplate
       - name: Run Check
         run: ./gradlew check detektAll detektReleaseAll
 

README.md

@@ -39,6 +39,6 @@ For major changes, please open an issue first to discuss what you would like to
 ## Checklist after repository creation (remove after checked)
 
 - Update developers in [publishing plugin](buildSrc/src/main/kotlin/convention.publishing.gradle.kts)
-- remove `./cleanup.sh TestTemplate` from [main.yml](.github/workflows/main.yml)
+- remove `Cleanup` step from [main.yml](.github/workflows/main.yml)
 
 [license]: ../LICENSE

cleanup.sh

@@ -0,0 +1,40 @@
+#!/usr/bin/env bash
+
+set -e
+
+RESET="\033[0m"
+F_BOLD="\033[1m"
+F_BOLD_RESET="\033[22m"
+C_RED="\033[31m"
+C_GREEN="\033[32m"
+
+function log_success() { printf -- "\n${F_BOLD}${C_GREEN}%s${RESET}\n" "$*"; }
+function log_error() { printf -- "\n${F_BOLD}${C_RED}ERROR:${F_BOLD_RESET} %s${RESET}\n" "$*"; }
+
+if [[ $# -ne 1 ]]; then
+  log_error "Please specify the actual repository name. Usage: ./cleanup.sh MyRepositoryName"
+  exit 1
+fi
+
+NAME="$1"
+SAFE_NAME="$(echo $NAME | sed 's/[^a-zA-Z0-9]//g' | tr '[:upper:]' '[:lower:]')"
+
+STUB="%Stub%"
+SAFE_STUB="%stub%"
+
+# Replace
+sed -i "s/$SAFE_STUB/$SAFE_NAME/g" $(find . -type f -not -path "**/build/**" -not -path "**/.**")
+sed -i "s/$STUB/$NAME/g" $(find . -type f -not -path "**/build/**" -not -path "**/.**")
+
+# Move stub
+mv stub/src/main/kotlin/Stub.kt stub/src/main/kotlin/$NAME.kt
+mv stub/ $SAFE_NAME
+
+# Cleanup
+if [[ $GITHUB_ACTIONS ]]; then
+  rm .github/workflows/cleanup.yml
+  rm -- "$0"
+fi
+
+# Remove leftover empty directories
+find . -type d -empty -delete