Skip to content

feat: pre-commit hook to update banks README #505

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
c-dilks merged 4 commits into from
Mar 26, 2025
Merged

feat: pre-commit hook to update banks README #505

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
52824ee
feat: pre-commit hook to update banks README
c-dilks Mar 24, 2025
261b170
test: re-trigger precommit bot
c-dilks Mar 26, 2025
36d4c13
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Mar 26, 2025
98ee57b
Merge branch 'development' into update-banks-readme
c-dilks Mar 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 2 additions & 7 deletions etc/bankdefs/util/dumpBankIDs.rb → .github/make_banks_readme.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,8 @@
# dump a table
puts """# Bank Group and Item IDs

This file was generated by
```bash
#{$0} #{ARGV.join ' '}
```

> [!IMPORTANT]
> Please re-run this script if you modify any of the bank definitions.
> [!NOTE]
> Iguana banks, which are defined in the Iguana repository, use group number 30000.

"""

Expand Down
2 changes: 2 additions & 0 deletions .github/make_banks_readme_precommit.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
#!/usr/bin/env sh
.github/make_banks_readme.rb etc/bankdefs/hipo4 > etc/bankdefs/hipo4/README.md
8 changes: 8 additions & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
repos:
- repo: local
hooks:
- id: make_banks_readme
name: make banks readme
entry: .github/make_banks_readme_precommit.sh
language: script
pass_filenames: false
26 changes: 17 additions & 9 deletions etc/bankdefs/hipo4/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,7 @@
# Bank Group and Item IDs

This file was generated by
```bash
etc/bankdefs/util/dumpBankIDs.rb etc/bankdefs/hipo4
```

> [!IMPORTANT]
> Please re-run this script if you modify any of the bank definitions.
> [!NOTE]
> Iguana banks, which are defined in the Iguana repository, use group number 30000.


## Group 40
Expand Down Expand Up @@ -381,13 +376,24 @@ etc/bankdefs/util/dumpBankIDs.rb etc/bankdefs/hipo4

| Item ID | Name | Description |
| --- | --- | --- |
| 12 | `AHDC::tdc` | TDC bank for the ALERT Wire Chamber |
| 10 | `AHDC::wf` | Waveform bank for the AHDC |
| 11 | `AHDC::adc` | ADC bank for the ALERT Wire Chamber |

## Group 22500

| Item ID | Name | Description |
| --- | --- | --- |
| 11 | `ATOF::adc` | ADC bank for the ALERT time-of-flight detector |
| 12 | `ATOF::tdc` | TDC bank for the ALERT TOF |
| 21 | `ATOF::hits` | Reconstructed ATOF hits |
| 22 | `ATOF::clusters` | Clusters in ATOF |

## Group 22600

| Item ID | Name | Description |
| --- | --- | --- |
| 21 | `RECOIL::hits` | RECOIL hits |
| 22 | `RECOIL::clusters` | reconstructed clusters from RECOIL |
| 23 | `RECOIL::crosses` | reconstructed crosses from RECOIL |

## Group 23000

Expand All @@ -399,3 +405,5 @@ etc/bankdefs/util/dumpBankIDs.rb etc/bankdefs/hipo4
| 24 | `AHDC::PreClusters` | Pre Clusters info |
| 25 | `AHDC::Clusters` | Clusters info |
| 26 | `AHDC::KFTrack` | Reco Kalman Filter Tracks |
| 30 | `AHDC_AI::Prediction` | Prediction given by AI |
| 31 | `ALERT::Projections` | Track Projections to ATOF |