diff --git a/.github/workflows/block-forbidden-paths.yml b/.github/workflows/block-forbidden-paths.yml new file mode 100644 index 0000000..3c0fde6 --- /dev/null +++ b/.github/workflows/block-forbidden-paths.yml @@ -0,0 +1,26 @@ +name: Block suggestion folders from main + +on: + pull_request: + branches: + - main + +jobs: + check-forbidden-paths: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - name: Prevent suggestion folders being merged into main + run: | + FORBIDDEN_PATHS=( + "splitleaf-data/texts/suggestions/" + "splitleaf-data/tunes/suggestions/" + ) + + for path in "${FORBIDDEN_PATHS[@]}"; do + if git diff --name-only origin/main...HEAD | grep "^${path}"; then + echo "❌ Files in ${path} are development-only and must not be merged into main." + exit 1 + fi + done diff --git a/texts/suggestions/readme.md b/texts/suggestions/readme.md new file mode 100644 index 0000000..57ed633 --- /dev/null +++ b/texts/suggestions/readme.md @@ -0,0 +1,23 @@ +## Suggest new text editions here +Upload your suggested texts into this folder. If possible, please upload a .txt file of your Psalm(s) that employs the following format for **each** psalm. If you do not know some of this information, you can leave it blank. However, please add an empty line between the header and title (metre), and another between the title (metre) and the first stanza. Each subsequent stanza should have a blank line before it. +``` +Long Title: The Psalms of David in Metre +Short Title: Psalms in Metre +Publisher: Church of Scotland +Date: 1650 + +Psalm 21 (CM) + +1 The king in thy great strength, O Lord, +Shall very joyful be; +In thy salvation rejoice +How vehemently shall he! + +2 Thou hast bestowed upon him all +That his heart would request; +And thou from him didst not withhold +Whate'er his lips expressed. +``` +### Important notes +1. We can accept other file formats (Word, PDF, etc.). However, it may take us some time to process them. We will have to format the texts as described above. +2. We cannot publish any content without copyright permission. We may, therefore, contact you for help in getting that permission. diff --git a/texts/suggestions/test.txt b/texts/suggestions/test.txt new file mode 100644 index 0000000..484ba93 --- /dev/null +++ b/texts/suggestions/test.txt @@ -0,0 +1 @@ +This is a test.