Update doc info for new version

tools/README.md

@@ -1,83 +1,121 @@
 # README
 
-## Add a new version:
+## Add a new version
 
-1. Update `.env` to the new version
+Use `NEW_VER` as the placeholder in the steps below (for example `2.17`). Keep
+commands idempotent by running scripts with the `-o/--override` flag whenever a
+file already exists.
 
-1. Add a line to `VAR:url_postfixes` in the file
-   `00_fetch_ud_clarin-dspace_metadata.py`, like:
-   > "2.16": "11234/1-5901",  # 319 treebanks, 179 languages, released May 15, 2025.
-
-   and execute:
-   ```
-   ./00_fetch_ud_clarin-dspace_metadata.py
-   ```
-
-1. Add a line to `ARRAY:VER_MAPPINGS` in the file
-   `00`, like:
-   > VER_MAPPING["2.16"]="bc0cc9b94112253e3ea1e00b2dbe3a46c5f53fe3"
-
-   and execute:
+1. **Start new branch ${NEW_VER}**
    ```
-   ./00_fetch_ud_codes_and_flags.sh -o
-   ./01_fetch_ud_repos.sh
+   git checkout -b ${NEW_VER}
    ```
 
-1. Execute:
+2. **Add PID info**
+   - Edit `.env` and set `UD_VER=NEW_VER`:
+     ```
+     NEW_VER=2.17
+     echo "UD_VER=${NEW_VER}" > .env
+     ```
+   - In `00_fetch_ud_clarin-dspace_metadata.py`, add a new entry to the
+     `url_postfixes` dict, e.g.
+     ```
+     "2.17": "11234/1-6000",  # <treebanks/languages>, released <date>
+     ```
+   - Fetch the metadata artefacts:
+     ```
+     ./00_fetch_ud_clarin-dspace_metadata.py -o
+     ```
+
+3. **Add/update docs-commit mapping**
+   - In `00_fetch_ud_codes_and_flags.sh`, append the git hash for the new
+     release to `VER_MAPPING`, e.g.
+     ```
+     VER_MAPPING["2.17"]="bea0c0e56c64cad41e60f479a8eca87dc571113f"
+     ```
+   - Refresh the codes/flags map and fetch the repositories list:
+     ```
+     ./00_fetch_ud_codes_and_flags.sh -o
+     ./01_fetch_ud_repos.sh
+     ```
+   - Commit the newly generated and changed files:
+     ```
+     git commit -m "Add PID,docs-commit info for new version" \
+        tools/00_fetch_ud_clarin-dspace_metadata.py tools/00_fetch_ud_codes_and_flags.sh
+
+     git add etc/codes_and_flags-${NEW_VER}.yaml
+     git commit -m"Add etc/codes_and_flags-${NEW_VER}.yaml" \
+        etc/codes_and_flags-${NEW_VER}.yaml
+
+     git commit -m"Bump to ${NEW_VER}: etc/codes_and_flags-latest.yaml" \
+        etc/codes_and_flags-latest.yaml
+     ```
+
+4. **Create the NEW_VER repositories branch**
    ```
-   cd UD_repos/                   # change into the directory where all UD data resides
-   git checkout -b 2.16           # start a new branch for the new version
-   . .UD_submodules_add.commands  # update the submodules
-   git add -u                     # (or check if new directories have been added...)
-   git commit -m"Bump to 2.16"    # commit
+   cd UD_repos/                      # change into the directory with all UD data
+   git checkout -b ${NEW_VER}
+   . .UD_submodules_add.commands     # update/initialise submodules
+   git add -u                        # add new content (!check for new directories/content)
+   # FIXME:
+   git submodule foreach git status | grep -v .tag- | grep -v Entering | grep -v HEAD | grep -v Untracked | grep -v '<file>' | grep -v nothing | grep -v master
+   git commit -m "Bump to ${NEW_VER}"
    cd ..
    ```
 
-1. Execute:
+5. **Regenerate metadata, README, and Python template**
    ```
    ./02_traverse_ud_repos.py -o
    ./03_fill_universal_dependencies_tamplate.py -o
-
-   git log   # find the HASH *before* the "WIP" and
-   git reset HASH
-   git add README-2.16 metadata-2.16.json universal_dependencies-2.16
-   git commit -m"Add README-2.16 metadata-2.16.json universal_dependencies-2.16"
-   git checkout -b 2.16
-   cp README-2.16 ../README.md ; cp metadata-2.16.json ../metadata.json ; cp universal_dependencies-2.16 ../universal_dependencies.py
-   git commit -m"Sync README.md metadata.json universal_dependencies.py" ../README.md ../metadata.json ../universal_dependencies.py
-   git checkout main
-   git commit -m"WIP: 2.16 - Sync README.md metadata.json universal_dependencies.py" ../README.md ../metadata.json ../universal_dependencies.py
-   git push origin 2.14
-   git push -f origin main
    ```
+   Review the generated files (`README-${NEW_VER}`, `metadata-${NEW_VER}.json`,
+   `universal_dependencies-${NEW_VER}`) before committing.
 
-## 00 (./etc/)
-### `00_fetch_ud_clarin-dspace_metadata.py`
-Download `./etc/citation-VER` and `./etc/description-VER` UD metadata files for
-the different releases from the lindat clarin-dspace repository.
-
-### `00_fetch_ud_codes_and_flags.sh`
-Download `./etc/codes_and_flags.yaml`, a yaml file mapping UD (long) language
-names to metadata from UD `docs-automation` at GitHub.
-
-
-## 01
-Identify all relevant UD repositories from GitHub:
-* https://github.com/UniversalDependencies/
-and generate a list of submodules to add to a (newly created) repository in the
-subdirectory `./UD_Repos/`.
-
-
-## 02
-Collect relevant metadata from local UD directories:
-- extracting the '# Summary' from the beginning and machine readable
-  metadata from the end of the README.{md,txt} file
-- using the UD directory name for collecting metadata from the
-  codes_and_flags.yaml file
-- collecting {dev,train,test}.conllu files.
+6. **Commit and sync artefacts**
+   ```
+   git add README-${NEW_VER} metadata-${NEW_VER}.json universal_dependencies-${NEW_VER}
+   git commit -m "Add README-${NEW_VER} metadata-${NEW_VER}.json universal_dependencies-${NEW_VER}"
 
+   cp README-${NEW_VER} ../README.md
+   cp metadata-${NEW_VER}.json ../metadata.json
+   cp universal_dependencies-${NEW_VER} ../universal_dependencies.py
+   git commit -m "Sync README.md metadata.json universal_dependencies.py" ../README.md ../metadata.json ../universal_dependencies.py
 
-## 03
-Use `./templates/` and generate:
-- `universal_dependencies.py`
-- `README.md`
+   git checkout main
+   git merge ${NEW_VER}
+   git commit -m "Bump to ${NEW_VER}: README.md metadata.json universal_dependencies.py" ../README.md ../metadata.json ../universal_dependencies.py
+   git push origin ${NEW_VER}
+   git push -f origin main
+   ```
+   Adjust the final push commands if your workflow requires pull requests or
+   protected branches.
+
+
+## Overview of files and directories
+1. **00 (./etc/)**
+   - `00_fetch_ud_clarin-dspace_metadata.py`
+     Download `./etc/citation-VER` and `./etc/description-VER` UD metadata files for
+     the different releases from the lindat clarin-dspace repository.
+
+   - `00_fetch_ud_codes_and_flags.sh`
+     Download `./etc/codes_and_flags.yaml`, a yaml file mapping UD (long) language
+     names to metadata from UD `docs-automation` at GitHub.
+
+2. **01**
+   - Identify all relevant UD repositories from GitHub:
+     * https://github.com/UniversalDependencies/
+     and generate a list of submodules to add to a (newly created) repository in the
+     subdirectory `./UD_Repos/`.
+
+3. **02**
+   - Collect relevant metadata from local UD directories:
+     - extract the '# Summary' from the beginning and machine readable
+       metadata from the end of the README.{md,txt} file
+   - use the UD directory name for collecting metadata from the
+     codes_and_flags.yaml file
+   - collect {dev,train,test}.conllu files.
+
+4. **03**
+   Use `./templates/` and generate:
+     - `universal_dependencies.py`
+     - `README.md`