Skip to content

Commit

Permalink
update template (#10)
Browse files Browse the repository at this point in the history
* add placeholder workflow

* update template

* fix build error

* updage badge in README.md

* update .gitignore

Co-authored-by: Markus Hofbauer <[email protected]>

---------

Co-authored-by: Markus Hofbauer <[email protected]>
  • Loading branch information
dariusptrs and hofbi authored Jul 8, 2024
1 parent faf3f6a commit 5353805
Show file tree
Hide file tree
Showing 17 changed files with 505 additions and 150 deletions.
12 changes: 12 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"name": "LaTeX4Ei Devcontainer",
"image": "makeappdev/uselatex:latest",
"extensions": [
"eamodio.gitlens",
"James-Yu.latex-workshop",
"ms-azuretools.vscode-docker",
"ms-vscode-remote.vscode-remote-extensionpack",
"ms-vscode.cmake-tools",
"twxs.cmake"
],
}
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: 🔍 Search for existing issues first.
url: https://github.com/latex4ei/Allgemein/issues
about: Please search to see if an issue already exists, either in this repo or our common issue in https://github.com/latex4ei/Allgemein/issues
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Feature request
description: Suggest an idea for this project
labels: [enhancement]
assignees: []

body:
- type: markdown
attributes:
value: |
**Is your feature request related to a problem? Please describe.**
- type: textarea
id: problem-description
attributes:
label: Problem Description
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

- type: markdown
attributes:
value: |
**Describe the solution you'd like**
- type: textarea
id: solution-description
attributes:
label: Solution Description
description: A clear and concise description of what you want to happen.

- type: markdown
attributes:
value: |
**Describe alternatives you've considered**
- type: textarea
id: alternatives-description
attributes:
label: Alternatives Description
description: A clear and concise description of any alternative solutions or features you've considered.

- type: markdown
attributes:
value: |
**Additional context**
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context or screenshots about the feature request here.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/inhaltlicher_fehler.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Inhaltlicher Fehler
description: Hilf uns Fehler zu Verbessern
labels: [bug]
assignees: []

body:
- type: markdown
attributes:
value: |
**Fehlerbeschreibung**
- type: textarea
id: error-description
attributes:
label: Fehlerbeschreibung
description: Beschreibe hier den Fehler

- type: markdown
attributes:
value: |
**Referenz**
- type: textarea
id: reference
attributes:
label: Referenz
description: Wenn möglich immer eine Referenz zum Skript o.ä. angeben oder als Screenshot mit einfügen.
60 changes: 60 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: CI

on:
push:
branches: [ master, main ]
pull_request:
branches: [ master, main ]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.12.2'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r scripts/requirements.txt
- name: Run pytest
run: pytest

build:
runs-on: ubuntu-latest
container: makeappdev/uselatex:latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Configure Git safe directory with GITHUB_WORKSPACE
run: git config --global --add safe.directory $GITHUB_WORKSPACE

- name: Build
run: |
cmake --version; pdflatex --version
mkdir -p build && cd build
cmake ..
make
- name: Prepare Deployment
if: github.ref == 'refs/heads/master' || github.ref == 'refs/heads/main'
run: |
mkdir -p export
echo "# This branch is for deployment only" >> export/README.md
cp build/*.pdf export
cp build/git.id export
- name: Deploy
if: github.ref == 'refs/heads/master' || github.ref == 'refs/heads/main'
uses: JamesIves/[email protected]
with:
branch: gh-pages
folder: export
single-commit: true
silent: true
38 changes: 38 additions & 0 deletions .github/workflows/update.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Update README and LaTeX Build File

on:
workflow_dispatch:

jobs:
update-and-create-pr:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.12.2'

- name: Run update script
run: python scripts/update_files.py

- name: Configure Git
run: |
git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
- name: Commit changes to a new branch
run: |
git checkout -b changes/${{ github.run_id }}
git add .
git commit -m "Apply automated updates"
git push -u origin changes/${{ github.run_id }}
- name: Create Pull Request
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
gh pr create --base main --head changes/${{ github.run_id }} --title "Specify project URLs and CMake project" --body "Please review the changes applied by the automated script."
7 changes: 5 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
build/

Systemtheorie.pdf
*.pdf
!img/*.pdf

## Core latex/pdflatex auxiliary files:
*.aux
Expand Down Expand Up @@ -111,4 +112,6 @@ sympy-plots-for-*.tex/

# xindy
*.xdy
StochastischeSignale.pdf
git.id
*.DS_Store
*.pyc
32 changes: 0 additions & 32 deletions .travis.yml

This file was deleted.

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# LaTeX4EI Systemtheorie

[![Build Status](https://travis-ci.org/latex4ei/Systemtheorie.svg?branch=master)](https://travis-ci.org/latex4ei/Systemtheorie)
[![Actions Status](https://github.com/latex4ei/Systemtheorie/workflows/CI/badge.svg)](https://github.com/latex4ei/Systemtheorie)
[![Join the chat at https://gitter.im/LaTeX4Ei/Lobby](https://badges.gitter.im/LaTeX4Ei/Lobby.svg)](https://gitter.im/LaTeX4Ei/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

Write beautiful latex cheat sheets with minimal effort.
Expand Down
Loading

0 comments on commit 5353805

Please sign in to comment.