From 18b4cecf61bd746f846e43f0d3bd1a1d6213bc83 Mon Sep 17 00:00:00 2001 From: "George G. Vega Yon" Date: Thu, 10 Sep 2026 23:21:46 -0600 Subject: [PATCH] Add CITATION.cff --- .Rbuildignore | 3 +- .github/workflows/validate-citation-cff.yml | 24 +++++++++++++ CITATION.cff | 37 +++++++++++++++++++++ NEWS.md | 3 +- 4 files changed, 65 insertions(+), 2 deletions(-) create mode 100644 .github/workflows/validate-citation-cff.yml create mode 100644 CITATION.cff diff --git a/.Rbuildignore b/.Rbuildignore index 2f946ce..6704c5e 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -27,4 +27,5 @@ _pkgdown\.yml$ Makefile ^CODE_OF_CONDUCT\.md$ ^README\.qmd$ -^AGENTS\.md$ \ No newline at end of file +^AGENTS\.md$ +^CITATION\.cff$ diff --git a/.github/workflows/validate-citation-cff.yml b/.github/workflows/validate-citation-cff.yml new file mode 100644 index 0000000..59f6976 --- /dev/null +++ b/.github/workflows/validate-citation-cff.yml @@ -0,0 +1,24 @@ +name: Validate CITATION.cff + +on: + pull_request: + paths: + - CITATION.cff + - .github/workflows/validate-citation-cff.yml + push: + paths: + - CITATION.cff + - .github/workflows/validate-citation-cff.yml + workflow_dispatch: + +permissions: + contents: read + +jobs: + validate: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 + - uses: citation-file-format/cffconvert-github-action@4cf11baa70a673bfdf9dad0acc7ee33b3f4b6084 # 2.0.0 + with: + args: "--validate" diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..c4592e4 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,37 @@ +cff-version: 1.2.0 +message: 'To cite package "ABCoptim" in publications use:' +type: software +license: MIT +title: 'ABCoptim: Implementation of Artificial Bee Colony (ABC) Optimization' +version: 0.15.0-99 +doi: 10.32614/CRAN.package.ABCoptim +abstract: An implementation of Karaboga (2005) Artificial Bee Colony Optimization + algorithm . This was developed upon the basic version + programmed in C and available at the algorithm's official website. +authors: +- family-names: Vega Yon + given-names: George + email: g.vegayon@gmail.com + orcid: https://orcid.org/0000-0002-3171-0844 +preferred-citation: + type: manual + title: 'ABCoptim: Implementation of Artificial Bee Colony (ABC) Optimization' + authors: + - family-names: Vega Yon + given-names: George + orcid: https://orcid.org/0000-0002-3171-0844 + email: g.vegayon@gmail.com + - family-names: Mu\~noz + given-names: Enyelbert + year: '2026' + notes: R package version 0.15.0-99 + url: https://github.com/gvegayon/ABCoptim + doi: 10.32614/CRAN.package.ABCoptim +repository: https://CRAN.R-project.org/package=ABCoptim +repository-code: https://github.com/gvegayon/ABCoptim +url: https://gvegayon.github.io/ABCoptim +contact: +- family-names: Vega Yon + given-names: George + email: g.vegayon@gmail.com + orcid: https://orcid.org/0000-0002-3171-0844 diff --git a/NEWS.md b/NEWS.md index 127e05e..584a03d 100644 --- a/NEWS.md +++ b/NEWS.md @@ -6,6 +6,8 @@ ## Internal changes +* Added repository citation metadata for GitHub and other CFF consumers. + * Internal changes only. Created the BeeHive C++ template, will eventually move it to inst/include/ so that others can link to it. @@ -29,4 +31,3 @@ * Objects of class `abc_answer` return the trace of the global optimums. -