Skip to content

Commit c4c3d7a

Browse files
paulgessingerJustusRudolph
authored andcommitted
ci: Add script to sync CITATION.cff to other files (acts-project#4937)
This pull request introduces an automated workflow for synchronizing citation metadata across `CITATION.cff`, `.zenodo.json`, and `AUTHORS` files, ensuring consistency and maintainability. It adds a new script and pre-commit hook for this purpose, and updates the metadata in all three files to reflect the latest contributors and affiliations. **Citation metadata automation and updates:** * Added a new script `CI/sync_citation_metadata.py` to generate `.zenodo.json` and `AUTHORS` from `CITATION.cff`, and check for consistency between them. This script uses `typer`, `rich`, and `pyyaml` for CLI, output formatting, and YAML parsing. * Registered the new script as a pre-commit hook in `.pre-commit-config.yaml`, so citation metadata consistency is enforced automatically. **Metadata content updates:** * Updated `CITATION.cff`, `.zenodo.json`, and `AUTHORS` files to reflect the latest version (`v44.2.0`), new release date, and a significantly revised and expanded list of contributors and affiliations, with improved handling of unaffiliated contributors. [[1]](diffhunk://#diff-9b9f76394a441ff40bf8d7a0f3e0ddd7ae97abfa9a9a6abaedccf76dc4d51295L6-R125) [[2]](diffhunk://#diff-69450eccf330a9c709df151fad75b5a9c02976ac29bd5d251bb16eb367997892L4-R171) [[3]](diffhunk://#diff-ab6af77435f58cc0c9d4c31dfe05656e45187cc7c7fc02aada401a7642125463L3-R48) Blocked by: - acts-project#4917
1 parent cadebd8 commit c4c3d7a

File tree

5 files changed

+512
-129
lines changed

5 files changed

+512
-129
lines changed

.pre-commit-config.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,3 +106,11 @@ repos:
106106
require_serial: true
107107
args: [--indent=4]
108108
exclude: ^.zenodo.json$
109+
110+
- id: sync_citation_metadata
111+
name: sync citation metadata
112+
entry: CI/sync_citation_metadata.py
113+
language: python
114+
files: ^(CITATION\.cff|\.zenodo\.json|AUTHORS)$
115+
additional_dependencies: ["typer", "rich", "pyyaml"]
116+
pass_filenames: false

.zenodo.json

Lines changed: 100 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,127 +1,174 @@
11
{
22
"description": "Experiment-independent toolkit for (charged) particle track reconstruction in (high energy) physics experiments implemented in modern C++ ",
33
"license": "MPL-2.0",
4-
"title": "acts-project/acts: v11.0.0",
5-
"version": "v11.0.0",
4+
"title": "acts-project/acts: vv44.2.0",
5+
"version": "v44.2.0",
66
"upload_type": "software",
77
"creators": [
88
{
9-
"affiliation": "CERN",
10-
"name": "Andreas Salzburger"
9+
"affiliation": "Zhengzhou University",
10+
"name": "Xiaocong Ai"
1111
},
1212
{
13-
"affiliation": "CERN",
14-
"name": "Paul Gessinger"
13+
"affiliation": "Rutherford Appleton Laboratory",
14+
"name": "Tim Adye"
1515
},
1616
{
17-
"affiliation": "CERN / TUM Muenchen",
18-
"name": "Fabian Klimpel"
17+
"affiliation": "",
18+
"name": "Guilherme Almeida",
19+
"orcid": "0000-0002-4257-4278"
20+
},
21+
{
22+
"affiliation": "IJCLab",
23+
"name": "Corentin Allaire"
24+
},
25+
{
26+
"affiliation": "CERN, Aristotle University of Thessaloniki",
27+
"name": "Dimitra Amperiadou"
28+
},
29+
{
30+
"affiliation": "AGH University of Krakow",
31+
"name": "Tomasz Bold"
1932
},
2033
{
2134
"affiliation": "CERN",
22-
"name": "Moritz Kiehn"
35+
"name": "Pierfrancesco Butti"
2336
},
2437
{
25-
"affiliation": "CERN / JGU Mainz",
26-
"name": "Bastian Schlag"
38+
"affiliation": "CERN",
39+
"name": "Noemi Calace"
2740
},
2841
{
29-
"affiliation": "Universite Paris-Saclay / CNRS/IN2P3",
30-
"name": "Hadrien G."
42+
"affiliation": "Annecy LAPP",
43+
"name": "Jeremy Couthures"
3144
},
3245
{
33-
"affiliation": "University of Massachussets",
34-
"name": "Robert Langenberg"
46+
"affiliation": "CERN, University of Florence",
47+
"name": "Lorenzo Damenti"
48+
},
49+
{
50+
"affiliation": "University of Manitoba",
51+
"name": "Wouter Deconinck"
3552
},
3653
{
3754
"affiliation": "CERN",
38-
"name": "Corentin Allaire"
55+
"name": "Davide Di Croce"
3956
},
4057
{
41-
"affiliation": "DESY Hamburg",
42-
"name": "Xiaocong Ai"
58+
"affiliation": "CERN, JGU Mainz",
59+
"name": "Doga Elitez"
4360
},
4461
{
45-
"affiliation": "Universitaet Regensburg",
46-
"name": "Benjamin Huth"
62+
"affiliation": "Brandeis University",
63+
"name": "Luis Falda Coelho",
64+
"orcid": "0000-0002-2298-3605"
4765
},
4866
{
4967
"affiliation": "UC Berkeley",
5068
"name": "Louis-Guillaume Gagnon"
5169
},
5270
{
53-
"affiliation": "CERN",
54-
"name": "Noemi Calace"
71+
"affiliation": "Stanford University",
72+
"name": "Rocky Bala Garg"
5573
},
5674
{
5775
"affiliation": "CERN",
58-
"name": "Attila Krasznahorkay"
76+
"name": "Paul Gessinger"
5977
},
6078
{
61-
"affiliation": "UC Berkeley",
62-
"name": "Beomki Yeo"
79+
"affiliation": "DESY",
80+
"name": "Maximilian Goblirsch-Kolb"
81+
},
82+
{
83+
"affiliation": "IJCLab",
84+
"name": "Hadrien Grasland"
6385
},
6486
{
6587
"affiliation": "LBNL",
66-
"name": "Charles Leggett"
88+
"name": "Heather Gray"
6789
},
6890
{
69-
"affiliation": "Eotvos Lorand University",
70-
"name": "Czirkos Angela"
91+
"affiliation": "",
92+
"name": "Christian Gumpert"
7193
},
7294
{
73-
"affiliation": "UC Berkeley",
74-
"name": "Tomohiro Yamazaki"
95+
"affiliation": "University of Massachusetts, Amherst",
96+
"name": "Matthew Harris"
97+
},
98+
{
99+
"affiliation": "",
100+
"name": "Julia Hrdinka"
75101
},
76102
{
77103
"affiliation": "CERN",
78-
"name": "Joana Niermann"
104+
"name": "Benjamin Huth"
79105
},
80106
{
81-
"affiliation": "UC Berkeley",
82-
"name": "Irina Ene"
107+
"affiliation": "CERN",
108+
"name": "Johannes Junggeburth"
83109
},
84110
{
85-
"affiliation": "Oak Ridge National Laboratory",
86-
"name": "Joe Osborn"
111+
"affiliation": "",
112+
"name": "Moritz Kiehn"
87113
},
88114
{
89-
"affiliation": "Stanford University",
90-
"name": "Rocky Bala Garg"
115+
"affiliation": "",
116+
"name": "Fabian Klimpel"
91117
},
92118
{
93-
"affiliation": "CERN / TU Wien",
94-
"name": "Andreas Stefl"
119+
"affiliation": "",
120+
"name": "Robert Langenberg"
95121
},
96122
{
97-
"affiliation": "CERN / University of Coimbra",
98-
"name": "Luis Falda Coelho",
99-
"orcid": "0000-0002-2298-3605"
123+
"affiliation": "CERN",
124+
"name": "Leonardo Monaco"
125+
},
126+
{
127+
"affiliation": "CERN",
128+
"name": "Joana Niermann"
100129
},
101130
{
102-
"affiliation": "CERN / University of Graz",
131+
"affiliation": "BNL",
132+
"name": "Joe Osborn"
133+
},
134+
{
135+
"affiliation": "CERN, University of Graz",
103136
"name": "Alexander J. Pfleger",
104137
"orcid": "0000-0001-5524-7738"
105138
},
106139
{
107-
"affiliation": "University of Lisbon",
108-
"name": "Guilherme Almeida",
109-
"orcid": "0000-0002-4257-4278"
140+
"affiliation": "",
141+
"name": "Felix Russo",
142+
"orcid": "0009-0005-8975-2245"
143+
},
144+
{
145+
"affiliation": "CERN",
146+
"name": "Andreas Salzburger"
147+
},
148+
{
149+
"affiliation": "",
150+
"name": "Bastian Schlag"
110151
},
111152
{
112-
"affiliation": "CERN / University of Amsterdam",
153+
"affiliation": "Carleton University",
154+
"name": "Patrick Scholer"
155+
},
156+
{
157+
"affiliation": "CERN",
158+
"name": "Andreas Stefl"
159+
},
160+
{
161+
"affiliation": "CERN",
113162
"name": "Stephen Nicholas Swatman",
114163
"orcid": "0000-0002-3747-3229"
115164
},
116165
{
117-
"affiliation": "CERN / TU Wien",
118-
"name": "Felix Russo",
119-
"orcid": "0009-0005-8975-2245"
166+
"affiliation": "Weizmann Institute of Science",
167+
"name": "Roman Urmanov"
120168
},
121169
{
122-
"affiliation": "UC Berkeley",
123-
"name": "Carlo Varni",
124-
"orcid": "0000-0001-6733-4310"
170+
"affiliation": "AGH University of Krakow",
171+
"name": "Carlo Varni"
125172
}
126173
],
127174
"access_right": "open",

AUTHORS

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,35 @@
11
The following people have contributed to the project (in alphabetical order):
22

3-
- Xiaocong Ai, Zhengzhou University
43
- Tim Adye, Rutherford Appleton Laboratory
5-
- Dimitra Amperiadou, CERN, Aristotle University of Thessaloniki
4+
- Xiaocong Ai, Zhengzhou University
65
- Corentin Allaire, IJCLab
6+
- Dimitra Amperiadou, CERN, Aristotle University of Thessaloniki
77
- Tomasz Bold, AGH University of Krakow
88
- Pierfrancesco Butti, CERN
99
- Noemi Calace, CERN
10+
- Luis Falda Coelho, Brandeis University
1011
- Jeremy Couthures, Annecy LAPP
1112
- Lorenzo Damenti, CERN, University of Florence
1213
- Wouter Deconinck, University of Manitoba
1314
- Davide Di Croce, CERN
1415
- Doga Elitez, CERN, JGU Mainz
15-
- Luis Falda Coelho, Brandeis University
1616
- Louis-Guillaume Gagnon, UC Berkeley
17-
- Rocky Bala Garg, Standford
17+
- Rocky Bala Garg, Stanford University
1818
- Paul Gessinger, CERN
1919
- Maximilian Goblirsch-Kolb, DESY
2020
- Hadrien Grasland, IJCLab
2121
- Heather Gray, LBNL
2222
- Matthew Harris, University of Massachusetts, Amherst
2323
- Benjamin Huth, CERN
2424
- Johannes Junggeburth, CERN
25-
- Joana Niermann, CERN
2625
- Leonardo Monaco, CERN
26+
- Joana Niermann, CERN
27+
- Joe Osborn, BNL
2728
- Alexander J. Pfleger, CERN, University of Graz
2829
- Andreas Salzburger, CERN
29-
- Bastian Schlag, Standford University
3030
- Patrick Scholer, Carleton University
3131
- Andreas Stefl, CERN
32-
- Stephen Nicholas Swatman, CERN, University of Amsterdam
33-
- Joe Osborn, BNL
32+
- Stephen Nicholas Swatman, CERN
3433
- Roman Urmanov, Weizmann Institute of Science
3534
- Carlo Varni, AGH University of Krakow
3635

@@ -43,6 +42,7 @@ Not associated with scientific/academic organisations:
4342
- Fabian Klimpel
4443
- Robert Langenberg
4544
- Felix Russo
45+
- Bastian Schlag
4646

4747
See also the contributors list on github:
4848
https://github.com/acts-project/acts/graphs/contributors

0 commit comments

Comments
 (0)