Merge pull request #188 from bids-standard/doc/scrive_for_180

Add scrive for #180 and workflow to check for changes in changelog.d

Author: effigies

.github/scripts/scriv_check.sh

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+# Modified from https://github.com/tarides/changelog-check-action/tree/main
+
+set -uo pipefail
+
+if [ "${NO_CHANGELOG_LABEL}" = "true" ]; then
+    # 'no changelog' set, so finish successfully
+    exit 0
+else
+    # a changelog check is required
+    # fail if the diff is empty
+    if git diff --exit-code "origin/${BASE_REF}" -- "changelog.d/"; then
+        cat <<END >&2
+User-visible changes should come with an entry in the changelog.
+Create a changelog blurb with "uvx scriv create --edit".
+If no changelog entry is needed, then set the "no changelog" label.
+END
+        exit 1
+    fi
+fi

.github/workflows/validation.yml

@@ -22,3 +22,15 @@ jobs:
         python-version: 3
     - name: Validate CITATION.cff
       run: pipx run cffconvert --validate
+  check_change_log:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    - name: Check for changes in changelog
+      env:
+        BASE_REF: ${{ github.event.pull_request.base.ref }}
+        NO_CHANGELOG_LABEL: ${{ contains(github.event.pull_request.labels.*.name, 'no changelog') }}
+      run: .github/scripts/scriv_check.sh
+      shell: bash

changelog.d/20250324_121157_rosswilsonblair_scriv_for_180.md

@@ -0,0 +1,47 @@
+<!--
+A new scriv changelog fragment.
+
+Uncomment the section that is right (remove the HTML comment wrapper).
+-->
+
+### Added
+
+- Validate directory names names according to `schema.rules.directories` entries.
+  Use rules to identify "opaque" directories whose contents are unspecified by BIDS.
+
+<!--
+### Changed
+
+- A bullet item for the Changed category.
+
+-->
+<!--
+### Fixed
+
+- A bullet item for the Fixed category.
+
+-->
+<!--
+### Deprecated
+
+- A bullet item for the Deprecated category.
+
+-->
+<!--
+### Removed
+
+- A bullet item for the Removed category.
+
+-->
+<!--
+### Security
+
+- A bullet item for the Security category.
+
+-->
+<!--
+### Infrastructure
+
+- A bullet item for the Infrastructure category.
+
+-->