Skip to content

Document backend/bin scripts and utilities#9

Merged
gkostin1966 merged 1 commit into
mainfrom
backend-bin
Apr 22, 2026
Merged

Document backend/bin scripts and utilities#9
gkostin1966 merged 1 commit into
mainfrom
backend-bin

Conversation

@gkostin1966
Copy link
Copy Markdown
Collaborator

Document backend/bin scripts and utilities

Summary

Adds a comprehensive backend/bin/README.md reference covering all 58 operational scripts, XML templates, and data files in the DSpace backend bin directory. The README was produced in two passes: an initial draft synthesised from the pre-existing GPT inventory (CSV in sheets/), then a systematic file-by-file review that corrected 13 factual errors in the descriptions.

Changes

backend/bin/README.md (new)

  • 6 sections: top-level scripts, aptrust/, cronjobs/, monthlies/, rackham/, stats_monthlies/
  • Each file's row includes: linked filename, type (Perl/Ruby/XSLT/XML template/etc.), and a plain-English description
  • A Review Notes section at the bottom documents all 13 corrections with numbered footnotes; notable fixes include:
    • prep-logs is the orchestrator for the entire monthly stats pipeline (not just a log pre-processor)
    • find-items-to-unrestrict-bio/rack only print handles — they do not modify any database records
    • move-to-aptrust-regular uploads via AWS S3 CLI (aws s3 cp), not a REST API
    • report-aptrust-status command-line options are immediately overridden by hardcoded values and have no effect
    • All XML meta_file* templates use the literal $METAVAKYE placeholder (not $METAVALUE, $ORCID, etc.)
    • report-double-original finds items with more than one ORIGINAL bundle, not multiple bitstreams within a bundle

backend/bin/sheets/ (new)

  • Three CSV inventory files (GPT-generated analysis used as source material during documentation)

dotpy/ (additions)

  • format_table.py — auto-pads Markdown tables to consistent column widths
  • gen_delta.py — compares environment dspace.cfg Kubernetes secrets and regenerates DELTA.md
  • README.md — documents all dotpy/ utilities

Notes

  • dotpy/_fix_footnotes.py was committed as part of this branch. It is a one-off repair script that has already been applied; consider squashing it out or removing it before merge if you prefer a clean history.
  • TODO.md / DONE.md updated per project conventions.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds documentation for the backend/bin operational scripts/utilities and introduces new dotpy/ helper scripts to support Markdown table formatting and regenerating config diffs.

Changes:

  • Added a comprehensive backend/bin/README.md documenting scripts, templates, and data files, plus “Review Notes” footnotes.
  • Added new dotpy/ utilities (format_table.py, gen_delta.py) and documented them in dotpy/README.md; updated AGENTS.md to reference the new formatter.
  • Added CSV inventory artifacts under backend/bin/sheets/ and updated TODO.md / DONE.md.

Reviewed changes

Copilot reviewed 7 out of 12 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
backend/bin/README.md New reference documenting backend/bin scripts and templates, including review footnotes.
backend/bin/sheets/DBDocs Scripts Inventory - duplicated filenames.csv Adds an inventory artifact used as source material for the documentation.
dotpy/format_table.py New utility to auto-format Markdown tables by recalculating/padding columns.
dotpy/gen_delta.py New utility to compare from-kube.*.dspace.cfg files and regenerate DELTA.md.
dotpy/_fix_footnotes.py One-off script used to normalize footnote markers in the bin README.
dotpy/README.md Documents the new dotpy/ utilities and their usage.
AGENTS.md Updates table-formatting guidance to recommend format_table.py.
TODO.md Minor formatting change.
DONE.md Adds a completion entry describing the new backend/bin/README.md work.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread dotpy/README.md Outdated
Comment thread dotpy/gen_delta.py Outdated
Comment thread dotpy/gen_delta.py Outdated
Comment thread dotpy/gen_delta.py Outdated
Comment thread dotpy/gen_delta.py Outdated
@gkostin1966 gkostin1966 merged commit 23860b7 into main Apr 22, 2026
1 check passed
@gkostin1966 gkostin1966 deleted the backend-bin branch April 22, 2026 19:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants