From d7131d264244bfc3c9de619a371e2f074b66ab3c Mon Sep 17 00:00:00 2001 From: Filip Gralinski Date: Sat, 12 Feb 2022 12:04:55 +0100 Subject: [PATCH] Bump up version --- CHANGELOG.md | 10 +++++++++- README.md | 12 ++++++------ {{cookiecutter.paper_repo_name}}/.gitlab-ci.yml | 2 +- 3 files changed, 16 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 644816b..6bd8b13 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,16 @@ + + +## 5.2.0 (2022-02-12) + +Enhancements: + +* Contribution declarations are optional now + ## 5.1.0 (2022-01-22) -Enhancements +Enhancements: * Add Beeminder support (you can add an [Odometer goal](https://help.beeminder.com/article/68-odometer-goals) to track diff --git a/README.md b/README.md index 6d27a3d..4b2647d 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,8 @@ The template itself is in the `{{cookiecutter.paper_id}}-paper`. In order to generate a project from the template: * install cookiecutter -* find a paper-cutter tag applicable (usually the latest tag listed at ), say 5.1.0 -* run: `cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 5.1.0` +* find a paper-cutter tag applicable (usually the latest tag listed at ), say 5.2.0 +* run: `cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 5.2.0` You will be asked to choose a LaTeX template, at the moment the following templates are handled: @@ -57,7 +57,7 @@ git remote set-url origin YOUR-GIT-REPO password: `git config credential.helper "cache --timeout=10000000"` 8. Unfortunately, Overleaf will discard hidden files (`.*`) when a zip is uploaded, also file permissions will be somewhat broken -9. … so you need to copy `.cookiecutter.yml` file and re-apply the template (`cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 5.1.0 --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists`) +9. … so you need to copy `.cookiecutter.yml` file and re-apply the template (`cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 5.2.0 --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists`) 10. Re-commit the files (including recovered `.*` files). 11. Push the repo to Overleaf (fortunately, the `.*` will be treated correctly when this is done by git): `git push overleaf master` @@ -71,10 +71,10 @@ Updating package with updated template To keep your codebase in sync with template you need to occasionally reapply the template. Here's how: -* find a paper-cutter tag applicable, say 5.1.0 +* find a paper-cutter tag applicable, say 5.2.0 * (do *not* refer to master in your projects!) * go to project root -* run: `cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 5.1.0 --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists` +* run: `cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 5.2.0 --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists` * check changes with git Editing the files @@ -97,7 +97,7 @@ Switching to another conference or journal template is easy. If not, get in touch with Filip Graliński. 2. Commit or stash any uncommitted changes. 3. Change the `latex_template` value accordingly in the `.cookiecutter.yml` file. Commit the changes. -4. Re-run the template (as if updating, see above: `cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 5.1.0 --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists`). +4. Re-run the template (as if updating, see above: `cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 5.2.0 --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists`). 5. Compare `metadata.tex` against the right metadata template file (`*/*-template-meta.tex` in `_latex-templates/`) and make any fixes needed. This is the only thing that needs to be done manually diff --git a/{{cookiecutter.paper_repo_name}}/.gitlab-ci.yml b/{{cookiecutter.paper_repo_name}}/.gitlab-ci.yml index 33ebde5..e822011 100644 --- a/{{cookiecutter.paper_repo_name}}/.gitlab-ci.yml +++ b/{{cookiecutter.paper_repo_name}}/.gitlab-ci.yml @@ -6,5 +6,5 @@ variables: # THIS IS AN UGLY WORK-AROUND include: - project: 'research/paper-cutter' - ref: '5.1.0' + ref: '5.2.0' file: 'main.yml'