Bump up version
This commit is contained in:
parent
6e2fa4e92a
commit
b5d2086ff6
11
CHANGELOG.md
11
CHANGELOG.md
@ -1,4 +1,15 @@
|
|||||||
|
|
||||||
|
<a name="5.5.0"></a>
|
||||||
|
## 5.5.0 (2023-10-03)
|
||||||
|
|
||||||
|
Updates:
|
||||||
|
|
||||||
|
* Update Coling template
|
||||||
|
|
||||||
|
Fixes:
|
||||||
|
|
||||||
|
* Remove some broken tests
|
||||||
|
|
||||||
<a name="5.4.6"></a>
|
<a name="5.4.6"></a>
|
||||||
## 5.4.6 (2022-12-20)
|
## 5.4.6 (2022-12-20)
|
||||||
|
|
||||||
|
14
README.md
14
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:
|
In order to generate a project from the template:
|
||||||
|
|
||||||
* install cookiecutter
|
* 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 5.4.6
|
* find a paper-cutter tag applicable (usually the latest tag listed at <https://git.wmi.amu.edu.pl/filipg/paper-cutter/releases>), say 5.5.0
|
||||||
* run: `cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 5.4.6`
|
* run: `cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 5.5.0`
|
||||||
|
|
||||||
You will be asked to choose a LaTeX template, at the moment the
|
You will be asked to choose a LaTeX template, at the moment the
|
||||||
following templates are handled:
|
following templates are handled:
|
||||||
@ -59,7 +59,7 @@ git remote set-url origin YOUR-GIT-REPO
|
|||||||
password: `git config credential.helper "cache --timeout=10000000"`
|
password: `git config credential.helper "cache --timeout=10000000"`
|
||||||
8. Unfortunately, Overleaf will discard hidden files (`.*`) when a zip
|
8. Unfortunately, Overleaf will discard hidden files (`.*`) when a zip
|
||||||
is uploaded, also file permissions will be somewhat broken
|
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.4.6 --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.5.0 --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists`)
|
||||||
10. Re-commit the files (including recovered `.*` files).
|
10. Re-commit the files (including recovered `.*` files).
|
||||||
11. Push the repo to Overleaf (fortunately, the `.*` will be treated
|
11. Push the repo to Overleaf (fortunately, the `.*` will be treated
|
||||||
correctly when this is done by git): `git push overleaf master`
|
correctly when this is done by git): `git push overleaf master`
|
||||||
@ -73,10 +73,10 @@ Updating package with updated template
|
|||||||
To keep your codebase in sync with template you need to occasionally reapply the template.
|
To keep your codebase in sync with template you need to occasionally reapply the template.
|
||||||
Here's how:
|
Here's how:
|
||||||
|
|
||||||
* find a paper-cutter tag applicable, say 5.4.6
|
* find a paper-cutter tag applicable, say 5.5.0
|
||||||
* (do *not* refer to master in your projects!)
|
* (do *not* refer to master in your projects!)
|
||||||
* go to project root
|
* go to project root
|
||||||
* run: `cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 5.4.6 --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.5.0 --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists`
|
||||||
* check changes with git
|
* check changes with git
|
||||||
|
|
||||||
Editing the files
|
Editing the files
|
||||||
@ -99,7 +99,7 @@ Switching to another conference or journal template is easy.
|
|||||||
If not, get in touch with Filip Graliński.
|
If not, get in touch with Filip Graliński.
|
||||||
2. Commit or stash any uncommitted changes.
|
2. Commit or stash any uncommitted changes.
|
||||||
3. Change the `latex_template` value accordingly in the `.cookiecutter.yml` file. Commit the 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.4.6 --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.5.0 --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists`).
|
||||||
5. Compare `metadata.tex` against the right metadata template file
|
5. Compare `metadata.tex` against the right metadata template file
|
||||||
(`*/*-template-meta.tex` in `_latex-templates/`) and make any fixes
|
(`*/*-template-meta.tex` in `_latex-templates/`) and make any fixes
|
||||||
needed. This is the only thing that needs to be done manually
|
needed. This is the only thing that needs to be done manually
|
||||||
@ -172,7 +172,7 @@ Variables to be set in GitLab UI
|
|||||||
|
|
||||||
## Authors
|
## Authors
|
||||||
|
|
||||||
Prepared by Filip Graliński (Applica.ai).
|
Prepared by Filip Graliński (while at Adam Mickiewicz University / Applica.ai).
|
||||||
|
|
||||||
### Contributors
|
### Contributors
|
||||||
|
|
||||||
|
@ -6,5 +6,5 @@ variables:
|
|||||||
# THIS IS AN UGLY WORK-AROUND
|
# THIS IS AN UGLY WORK-AROUND
|
||||||
include:
|
include:
|
||||||
- project: 'research/paper-cutter'
|
- project: 'research/paper-cutter'
|
||||||
ref: '5.4.6'
|
ref: '5.5.0'
|
||||||
file: 'main.yml'
|
file: 'main.yml'
|
||||||
|
Loading…
Reference in New Issue
Block a user