Skip to content

Add Citation.cff and incorporate updates into maven build#6244

Open
duncdrum wants to merge 3 commits intoeXist-db:developfrom
duncdrum:dp-feat-cit
Open

Add Citation.cff and incorporate updates into maven build#6244
duncdrum wants to merge 3 commits intoeXist-db:developfrom
duncdrum:dp-feat-cit

Conversation

@duncdrum
Copy link
Copy Markdown
Contributor

close #6243

- Updated CITATION.cff description
- Introduced a new Maven profile for citation release metadata updates.
- Added a GitHub Actions workflow to validate the CITATION.cff schema.
- Updated .gitignore to exclude temporary files created during the build process.
- drop swh
@duncdrum duncdrum added this to the eXist-7.0.0 milestone Apr 15, 2026
@duncdrum duncdrum requested a review from a team as a code owner April 15, 2026 16:28
@duncdrum duncdrum added this to v7.0.0 Apr 15, 2026
@duncdrum duncdrum added the enhancement new features, suggestions, etc. label Apr 15, 2026
Comment thread CITATION.cff Outdated
Comment thread CITATION.cff Outdated
Copy link
Copy Markdown
Member

@line-o line-o left a comment

Choose a reason for hiding this comment

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

I like the idea of updating the citation file automatically. I did not read the documentation yet, does it need to be branch based? As currently it will be 6.4.1 even though one might cite 7.0.0-SNAPSHOT code, right?

@duncdrum
Copy link
Copy Markdown
Contributor Author

duncdrum commented Apr 15, 2026

Not really branch based. The target for citations styles is usually a versioned release, ideally this file would have been generated with the release, and will only change with the next release. But bootstrapping has to happen at some point. The Github UI support for the file, will kick in once it appears on the default branch.

Folks are free to build references from this for whatever fork branch commit etc. This is making the software as a whole citeable. It's not supposed to replace or overwrite code references in computer science dissertations.

What fields would you suggest to add or modify? Take a look at the docs and let me know.

@duncdrum duncdrum requested a review from a team April 16, 2026 14:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement new features, suggestions, etc.

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

[feature] add CITATION.cff to help our academic users

2 participants