LedgerSMB icon indicating copy to clipboard operation
LedgerSMB copied to clipboard

Incorporate the ADR index creation into an automated process?

Open neilt opened this issue 3 months ago • 2 comments

Need to decide if the create ADR index code create_adr_index is going to be run:

  1. manually (whenever ADRs are changed) or,
  2. automatically at as part of the build, release or prep for release process.

If manually, then there are no additional changes required and this issue can be closed.

If automatically, then 2 changes need to be made:

  • [ ] Remove the code in create_adr_index lines 114 - 115 that add the last build date to the end of index.md. This is not needed if the code is run automatically and will result in unnecessary git changes even when index.md's main content does not change.
  • [ ] Add the execution of create_adr_index to the selected automated process.

neilt avatar Oct 03 '25 12:10 neilt

What about running it as part of our test suite and failing the test of the file changes? Like the test for the README file and the "blacklist" SQL file.

ehuelsmann avatar Oct 07 '25 18:10 ehuelsmann

Works for me. We would still need to remove create_adr_index lines 114 - 115 .

neilt avatar Oct 07 '25 21:10 neilt