Skip to content

Commit

Permalink
Switch from GitLab to GitHub
Browse files Browse the repository at this point in the history
This includes updating URLs, removing GitLab configuration files and updating docs
  • Loading branch information
alexpovel committed May 11, 2022
1 parent d6d80fd commit 7a33ee3
Show file tree
Hide file tree
Showing 11 changed files with 15 additions and 183 deletions.
2 changes: 1 addition & 1 deletion .devcontainer/image/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ RUN useradd --create-home ${USER}
LABEL \
maintainer="Alex Povel <[email protected]>" \
org.label-schema.description="TeXLive with most packages, JavaRE, Inkscape, pandoc and more" \
org.label-schema.vcs-url="https://collaborating.tuhh.de/alex/latex-cookbook" \
org.label-schema.vcs-url="https://github.com/alexpovel/latex-cookbook" \
org.label-schema.schema-version="1.0"

ARG INSTALL_DIR="/install"
Expand Down
11 changes: 1 addition & 10 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,19 +1,10 @@
# This file tells platforms like GitLab how to treat certain files, e.g.
# for syntax highlighting.

# GitLab uses the Rouge Ruby gem; for available languages, see:
# https://github.com/rouge-ruby/rouge/wiki/List-of-supported-languages-and-lexers

# bib -> latex does not help much, since it is also not valid latex, but at
# least highlights comments (%) correctly
*.bib linguist-language=latex
*.bib gitlab-language=latex

# Bash is wrong, it is really a plain-text file.
# However, it gets us comment highlighting (hiding/grey)
# and is close enough.
# However, it gets us comment highlighting (hiding/grey) and is close enough.
*.profile linguist-language=bash
*.profile gitlab-language=bash

# Do not include git config files in archives (e.g. when downloading as ZIP):
.git* export-ignore
122 changes: 0 additions & 122 deletions .gitlab-ci.yml

This file was deleted.

27 changes: 0 additions & 27 deletions .gitlab/issue_templates/Bug.md

This file was deleted.

10 changes: 0 additions & 10 deletions .gitlab/issue_templates/Feature-Request.md

This file was deleted.

2 changes: 0 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

[[_TOC_]]

## [Unreleased]

## [4.0.0] - 2021-10-18
Expand Down
7 changes: 5 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@
# `make file.pdf` *both locally and in CI*.
# Without make, we would otherwise have very different build steps in local and CI
# environments.
# Additionally, using `make`, the CI instructions (.gitlab-ci.yml) can be simplified
# considerably, leading to decoupling.
# Additionally, using `make`, the CI instructions (.gitlab-ci.yml, GitHub actions etc.)
# can be simplified considerably, leading to decoupling.
# Moving CI systems then becomes much easier.


Expand Down Expand Up @@ -65,6 +65,9 @@ PANDOC_FLAGS = --defaults=pandoc/defaults.yaml
# See also:
# https://www.gnu.org/software/make/manual/html_node/Conditional-Syntax.html#Conditional-Syntax
# https://docs.gitlab.com/ee/ci/variables/predefined_variables.html
#
# That same environment variable is defined for GitHub Actions as well:
# https://docs.github.com/en/actions/learn-github-actions/environment-variables#default-environment-variables
ifdef CI
# In container, run commands directly:
LATEXMK = latexmk
Expand Down
2 changes: 1 addition & 1 deletion chapters/frontmatter/preface.tex
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,6 @@
\paragraph{Source Repository}
The source repository for this document is at
\begin{center}
\url{https://collaborating.tuhh.de/alex/latex-cookbook} .
\url{https://github.com/alexpovel/latex-cookbook} .
\end{center}
Any references to the \enquote{source} or \enquote{repository} refer to that project.
9 changes: 4 additions & 5 deletions chapters/mainmatter/usage.tex
Original file line number Diff line number Diff line change
Expand Up @@ -166,11 +166,10 @@ \subsection{Compilation steps}
\end{displayquote}
Good riddance to that.

If all of this is embedded into a pipeline on GitLab, your documents are built whenever
you \texttt{git push} to the remote server (or whenever you configure it to).
It does not get simpler; the downside is of course the lengthier setup, but all of that
is explained in the
\href{https://collaborating.tuhh.de/alex/latex-cookbook/-/blob/master/README.md}{README}.
If all of this is embedded into a pipeline on GitLab, GitHub Actions, or similar,
your documents are built whenever you \texttt{git push} to the remote server
(or whenever you configure it to).
It does not get simpler; the downside is of course the lengthier setup.
Also, the repository itself is a live demonstration where everything is set up already!

\subsubsection{Slow compilation}
Expand Down
4 changes: 2 additions & 2 deletions pandoc/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
author: [Alex Povel]
subject: "Advantages of a workflow using LaTeX with GitLab"
keywords: [LaTeX, GitLab, CI, CD, Markdown]
subject: "Advantages of a workflow using LaTeX with GitLab, GitHub Actions etc."
keywords: [LaTeX, CI, CD, Markdown]
2 changes: 1 addition & 1 deletion tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ If it does, `poetry` will complain to you accordingly.
In such a case, [`pyenv`](https://github.com/pyenv/pyenv) has worked well for me to set
up a suitable, local or system-wide Python interpreter of *any* desired version.

The [setup for the CI pipeline](../.gitlab-ci.yml) is quite different.
The setup for the CI pipeline (GitHub Actions) is quite different.
Take a look if you like, but the steps there are not applicable to local usage.

## Running
Expand Down

0 comments on commit 7a33ee3

Please sign in to comment.