JuliaCI/PkgTemplates.jl

Version number in Citation plugin is hard-coded

Open

#389 opened on Feb 23, 2023

View on GitHub
 (2 comments) (2 reactions) (0 assignees)Julia (697 stars) (112 forks)batch import
good-first-issuehelp wantednew-feature

Description

The CITATION.bib file is hard-coded set version as v0.1.0 (#388 makes that hard coded to 1.0.0-dev instead) https://github.com/JuliaCI/PkgTemplates.jl/blob/aba46406eae5069baf71f60f834b8498f2899923/templates/CITATION.bib#L5

We should instead use the version specified in the ProjectFile plugin (if present).

I think this would be a great first issue for someone. Basically we would need to check the priority of Citation was after ProjectFile then during the hook stage use getplugin to see if there is a ProjectFile plugin loaded and if so load the version from that. which we would insert by putting a VERSION into the view and then updating the template to pull that. If there is no ProjectFile plugin present, maybe we should just omit the version line from the Citation.bib all together?

Contributor guide

Tech stack
None
Domain
documentationtooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Familiarity with Julia languageKnowledge of PkgTemplates.jl plugin system
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Look at the CITATION.bib template in templates/CITATION.bib and the ProjectFile plugin. Modify the template to use a version variable, and in the Citation plugin's hook, retrieve version from ProjectFile using getplugin if available. Ensure Citation priority is after ProjectFile. If no ProjectFile, omit the version line entirely.