filipg/cookiecutter-amu-thesis
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity
12 Commits 1 Branch 1 Tag 128 KiB
TeX 90.1%
Groovy 2.7%
Shell 2.6%
sed 2.2%
Makefile 1.9%
Other 0.5%
11cd6589f2
Go to file
Filip Gralinski 11cd6589f2 Fix
2019-12-02 20:48:05 +01:00
{{cookiecutter.thesis_type}}-{{cookiecutter.thesis_surname}} Fix 2019-12-02 20:48:05 +01:00
hooks Init 2019-12-02 18:02:20 +01:00
.gitignore Init 2019-12-02 18:02:20 +01:00
CHANGELOG.md Init 2019-12-02 18:02:20 +01:00
cookiecutter.json Fixes 2019-12-02 20:10:16 +01:00
README.md Init 2019-12-02 18:02:20 +01:00

README.md

Template for AMU thesis

The template itself is in the {{cookiecutter.thesis_type}}-{{cookiecutter.thesis_surname}}.

In order to generate a project from the template:

  • install cookiecutter
  • find a cookiecutter-applica-pypackage release applicable (usually the latest release/tag listed at https://git.wmi.amu.edu.pl/filipg/cookiecutter-amu-thesis), say VERSION
  • run: cookiecutter https://git.wmi.amu.edu.pl/filipg/cookiecutter-amu-thesis.git --checkout VERSION

Interoperation with Overleaf

Overleaf handles git but it's very cr*ppy. It's better to upload a package to Overleaf first:

  1. Create a project locally.
  2. Run make
  3. Run make source-pack
  4. Upload the zip file to Overleaf.
  5. Copy project to some other place.
  6. Clone the repo from Overleaf: git clone https://git.overleaf.com/FUNNY-OVERLEAF-CODE PAPERID-paper
  7. Set remotes:
git remote add overleaf https://git.overleaf.com/FUNNY-OVERLEAF-CODE
git remote set-url origin git@git.wmi.amu.edu.pl:YOURID/YOUR-GITLAB-REPO
  1. Set credential helper so that stupid Overleaf won't ask about password: git config credential.helper "cache --timeout=10000000"
  2. Unfortunately, Overleaf will discard hidden files (.*) when a zip is uploaded, also file permissions will be somewhat broken (did I tell you how much I hate Overleaf?)
  3. … so you need to copy .cookiecutter.yml file and re-apply the template (cookiecutter https://git.wmi.amu.edu.pl/filipg/cookiecutter-amu-thesis.git --checkout VERSION --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists)
  4. Re-commit the files (including recovered .* files).
  5. Push the repo to Overleaf (fortunately, the .* will be treated correctly when this is done by git): git push overleaf master
  6. Push the repo to GitLab. git push origin master
  7. Set the Overleaf git remote in helpers/vars
  8. Now you can synchronize between GitLab repo and Overleaf manually or using helpers/synchro.sh script

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 cookiecutter-amu-thesis release/tag applicable, say VERSION
  • (do not refer to master in your projects!)
  • go to project root
  • run: cookiecutter https://git.wmi.amu.edu.pl/filipg/cookiecutter-amu-thesis.git --checkout VERSION --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists
  • check changes with git

Releasing a new version of the template

  • add an item to CHANGELOG.md
  • in case of breaking changes (M is incremented) describe clearly what actions are to be taken in CHANGELOG.md
  • tag master with the version