458-Add question for citation files

[fdiblen]

Checks

• I have read the contribution guidelines
• This update is in line with what is recommended in the Python chapter of the Guide
• All user facing changes have been added to CHANGELOG.md

Description
This PR adds a question about citation. If the user decides to add citation,

• CITATION.cff is created
• cffconvert workflow, which validates the CITATION.cff file, is added
• a Github issue about citation is created by next_steps_citation.yml. next_steps_citation.yml then removes itself.
• fixes escape character issues in next_steps*yml workflows (see here)
• adds CITATION.cff to pyproject.toml
• adds cffconvert badge to README.md
• adds CITATION.cff to MANIFEST.in
• adds citation-related text to README.md, README.dev.md, CONTRIBUTING.md, project_setup.md

Related issues:

• Add optional question to copier questionnaire: cffconvert workflow and citation file #458
• Add optional question to copier questionnaire: next steps workflow #461
• 456-make online documentation optional #476

Instructions to review the pull request

Install the requirements

cd $(mktemp -d --tmpdir py-tmpl-XXXXXX)
pip install pipx
pipx install copier

Test 1:
Run the command below and say 'yes' to citation question

copier copy --vcs-ref 458_citation https://github.com/nlesc/python-template test_yes

Test 2:
Run the command below and say 'no' to citation question

copier copy --vcs-ref 458_citation https://github.com/nlesc/python-template test_no

What to check in Test 1 and Test 2:
You should see the files below only when you say 'yes':

• .github/workflows/next_steps_citation.yml
• .github/workflows/cffconvert.yml
• .github/next_steps/02_citation.md
• CITATION.cff

The text related to citation (any sentence includes the words citation, cite) will only be present when you say 'yes'.

Test 3:

• Push the generated package to a GitHub repository
• Check if cffconvert workflow runs
• Check if a Github issue about citation is created

Example test repository:
https://github.com/fdiblen/test_citation

[sjvrijn]

Looks good, except for the action failing on the echo command because of a missing single quote.
I'm a bit confused why the Citation issue has shown up twice in your demo repo though. I haven't been able to reproduce that, but would prefer to avoid duplicates if possible.

[sjvrijn]

Missing ' at the end of the line

[lyashevska]

Run echo 'Created issues that must be completed to have fully working Python package:
/home/runner/work/_temp/9d06e288-374f-4dd9-b641-81ec33ef6439.sh: line 1: unexpected EOF while looking for matching `''
Error: Process completed with exit code 2.

[fdiblen]

done

[lyashevska]

thanks @fdiblen I have tested all steps, it looks good but there is one typo which I highlighted.

[sverhoeven]

On

python-template/README.md

Line 22 in 566fe84

- Instructions how to make package [citable](template/.github/next_steps/02_citation.md.jinja)

the link is kaput. it should be '.github/next_steps/%7B%25%20if%20AddCitation%20%25%7D02_citation.md%7B%25%20endif%20%25%7D.jinja'

[sverhoeven]

This might be a problem for jobs running in parallel.

[fdiblen]

done

[sverhoeven]

I got a 'Next step: Citation data' issue and cffconvert ran in new repo.

[fdiblen]

Thank you for the review @sverhoeven!

[lyashevska]

This line is a duplicate. Should be removed.

[lyashevska]

It looks great @fdiblen! Ready to go 🥇