From 14e7949fef6211e8cacde16f1407f4604106df7b Mon Sep 17 00:00:00 2001 From: Marc Fehling Date: Thu, 8 Sep 2022 11:53:02 -0600 Subject: [PATCH] Added 'sort' stage to CI. --- Jenkinsfile | 18 ++++++++++++++++++ README.md | 12 +++++++++--- 2 files changed, 27 insertions(+), 3 deletions(-) diff --git a/Jenkinsfile b/Jenkinsfile index 5e0c5b8c..90f45ffd 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -56,6 +56,24 @@ pipeline } } + stage("sort") + { + post { + failure { + githubNotify context: 'CI', description: 'publications not sorted', status: 'FAILURE' + } + } + steps + { + // sort entries and check if files have changed: + sh ''' + make sort + git diff + git diff-files --quiet || exit $? + ''' + } + } + stage("latex") { post { diff --git a/README.md b/README.md index 58be2dde..3cb2a292 100644 --- a/README.md +++ b/README.md @@ -40,15 +40,21 @@ $ git checkout -b my_awesome_new_publication Please try to select the correct entry type and to fill in as much of the mandatory fields for that selection. You can see find more information about this point in this [Wikipedia entry](https://en.wikipedia.org/wiki/BibTeX#Entry_types). If your publication has a URL or DOI number assigned to it, then it would be nice to enter that information as we will then generate a link straight to your publication. -5. Commit your changes to your local copy of the git repository. +5. Make sure that your entry is in the correct order and your citation key conforms to our style. +This step helps us to maintain the publication list and is completely automized. +You will need [bibtool](#installing-bibtool) and only have to call +``` +$ make sort +``` +6. Commit your changes to your local copy of the git repository. ``` $ git commit -m "Added entry " ``` -6. Push the changes to your fork of this repository +7. Push the changes to your fork of this repository ``` $ git push origin my_awesome_new_publication ``` -7. Setup a pull request for your addition(s) within GitHub. +8. Setup a pull request for your addition(s) within GitHub. ## Commonly used entry templates