filipg/paper-cutter
2
1
Fork 0
Code Issues Pull Requests Releases 33 Wiki Activity

Bump up version

Browse Source
This commit is contained in:
Filip Gralinski 2021-09-21 21:52:58 +02:00
parent 34c067e34c
commit bdd9ac7b59
3 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CHANGELOG.md
View File

@ -1,4 +1,11 @@
<a name="4.6.0"></a>
## 4.6.0 (2021-09-21)
Enhancements:
* Add generating declarations of contributions
<a name="4.5.0"></a>
## 4.5.0 (2021-09-17)

12
README.md
View File

@ -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 <https://git.wmi.amu.edu.pl/filipg/paper-cutter/releases>), say 4.5.0
* run: `cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 4.5.0`
* find a paper-cutter tag applicable (usually the latest tag listed at <https://git.wmi.amu.edu.pl/filipg/paper-cutter/releases>), say 4.6.0
* run: `cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 4.6.0`
You will be asked to choose a LaTeX template, at the moment the
following templates are handled:
@ -54,7 +54,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 4.5.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 4.6.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`
@ -68,10 +68,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 4.5.0
* find a paper-cutter tag applicable, say 4.6.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 4.5.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 4.6.0 --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists`
* check changes with git
Editing the files
@ -94,7 +94,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 4.5.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 4.6.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

2
{{cookiecutter.paper_repo_name}}/.gitlab-ci.yml
View File

@ -6,5 +6,5 @@ variables:
# THIS IS AN UGLY WORK-AROUND
include:
- project: 'research/paper-cutter'
ref: '4.5.0'
ref: '4.6.0'
file: 'main.yml'