Document backend/bin scripts and utilities#9
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
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.mddocumenting scripts, templates, and data files, plus “Review Notes” footnotes. - Added new
dotpy/utilities (format_table.py,gen_delta.py) and documented them indotpy/README.md; updatedAGENTS.mdto reference the new formatter. - Added CSV inventory artifacts under
backend/bin/sheets/and updatedTODO.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.
448780d to
84eaadd
Compare
84eaadd to
e914086
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Document
backend/binscripts and utilitiesSummary
Adds a comprehensive
backend/bin/README.mdreference 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 insheets/), then a systematic file-by-file review that corrected 13 factual errors in the descriptions.Changes
backend/bin/README.md(new)aptrust/,cronjobs/,monthlies/,rackham/,stats_monthlies/prep-logsis the orchestrator for the entire monthly stats pipeline (not just a log pre-processor)find-items-to-unrestrict-bio/rackonly print handles — they do not modify any database recordsmove-to-aptrust-regularuploads via AWS S3 CLI (aws s3 cp), not a REST APIreport-aptrust-statuscommand-line options are immediately overridden by hardcoded values and have no effectmeta_file*templates use the literal$METAVAKYEplaceholder (not$METAVALUE,$ORCID, etc.)report-double-originalfinds items with more than one ORIGINAL bundle, not multiple bitstreams within a bundlebackend/bin/sheets/(new)dotpy/(additions)format_table.py— auto-pads Markdown tables to consistent column widthsgen_delta.py— compares environmentdspace.cfgKubernetes secrets and regeneratesDELTA.mdREADME.md— documents alldotpy/utilitiesNotes
dotpy/_fix_footnotes.pywas 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.mdupdated per project conventions.