diff --git a/.github/workflows/known_tonies.yaml b/.github/workflows/build_directories.yaml similarity index 57% rename from .github/workflows/known_tonies.yaml rename to .github/workflows/build_directories.yaml index 8240695..ff4a79c 100644 --- a/.github/workflows/known_tonies.yaml +++ b/.github/workflows/build_directories.yaml @@ -1,4 +1,4 @@ -name: build known tonies for each language +name: Build directory markdown files on: push: @@ -11,16 +11,16 @@ jobs: contents: write steps: - - name: checkout + - name: Checkout uses: actions/checkout@v4 with: ref: ${{ github.head_ref }} - - name: build known tonies - run: ./build_known_tonies.sh + - name: Build directories + run: ./build_directories.sh - name: Commit changes uses: stefanzweifel/git-auto-commit-action@v5 with: - file_pattern: '*/*.md' - commit_message: update language specific known tonies list + file_pattern: "*/*.md" + commit_message: Auto update directory markdown files diff --git a/.github/workflows/validate.yaml b/.github/workflows/validate_files.yaml similarity index 57% rename from .github/workflows/validate.yaml rename to .github/workflows/validate_files.yaml index 7100bcc..6c48371 100644 --- a/.github/workflows/validate.yaml +++ b/.github/workflows/validate_files.yaml @@ -1,10 +1,10 @@ -name: Validate NFC Files +name: Validate NFC files on: push: workflow_dispatch: pull_request: - types: [ opened, synchronize, reopened ] + types: [opened, synchronize, reopened] jobs: validation: @@ -14,5 +14,5 @@ jobs: - name: Checkout repository uses: actions/checkout@v4 - - name: validate - run: ./validation.sh + - name: Run validation + run: ./validate_files.sh diff --git a/build_known_tonies.sh b/build_directories.sh similarity index 82% rename from build_known_tonies.sh rename to build_directories.sh index 8b8f460..b1ead13 100755 --- a/build_known_tonies.sh +++ b/build_directories.sh @@ -1,6 +1,6 @@ #!/usr/bin/env bash -echo "Building known tonies for each folder" +echo "Building directory markdown files for known tonies" while read -r LANG_DIR; do NFC_FILES=() @@ -13,9 +13,9 @@ while read -r LANG_DIR; do echo "${FOLDER} has ${NFC_FILES_COUNT}" { - echo "# ${NFC_FILES_COUNT} ${FOLDER} NFC Files" + echo "# ${FOLDER} Tonies (${NFC_FILES_COUNT} files)" echo "" - echo "automatically generated, do not edit" + echo "*Note: this file is automatically generated, do not edit manually*" echo "" echo "| Folder | Filename |" echo "|--------|----------|" diff --git a/validation.sh b/validate_files.sh similarity index 100% rename from validation.sh rename to validate_files.sh