Skip to content

Commit e020604

Browse files
AngryMaciekAngryMaciek
authored
refactor: add minor elements to the repo - round (3) (#59)
1 parent c599edf commit e020604

File tree

8 files changed

+176
-51
lines changed

8 files changed

+176
-51
lines changed

‎.github/workflows/dev.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: dev
2+
3+
on: [push]
4+
5+
jobs:
6+
7+
ubuntu:
8+
runs-on: ubuntu-22.04
9+
10+
steps:
11+
12+
- name: Checkout Repository
13+
uses: actions/checkout@v3
14+
15+
- name: Display compiler version
16+
run: g++ --version
17+
18+
- name: Install MPFR
19+
run: |
20+
sudo apt-get update -y
21+
sudo apt-get install -y libmpfr-dev
22+
23+
- name: Make!
24+
run: |
25+
cd hypercomplex
26+
make help
27+
28+
conda:
29+
runs-on: ubuntu-22.04
30+
31+
steps:
32+
33+
- name: Checkout Repository
34+
uses: actions/checkout@v3
35+
36+
- name: Setup Miniconda & Environment
37+
uses: conda-incubator/setup-miniconda@v2
38+
with:
39+
python-version: 3.11
40+
auto-update-conda: true
41+
activate-environment: hypercomplex-dev
42+
environment-file: environment.yml
43+
auto-activate-base: false
44+
45+
- name: Conda Info
46+
shell: bash -l {0}
47+
run: |
48+
conda info -a
49+
conda list
50+
51+
- name: Make!
52+
run: |
53+
cd hypercomplex
54+
make help

‎.github/workflows/include.yml‎

Lines changed: 0 additions & 42 deletions
This file was deleted.

.github/workflows/docs.yml renamed to .github/workflows/publish.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
1-
name: docs
1+
name: publish
22

33
on:
44
push:
5-
branches:
6-
- master
5+
tags:
6+
- 'v[0-9]+.[0-9]+.[0-9]+'
77

88
jobs:
99

1010
gh-pages:
11+
1112
runs-on: ubuntu-22.04
1213
env:
1314
test-directory: .test/docs

.github/workflows/install.yml renamed to .github/workflows/user.yml

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,47 @@
1-
name: Install
1+
name: Include&Install
22

33
on: [push]
44

55
jobs:
6+
7+
Include:
8+
runs-on: ${{ matrix.os }}
9+
strategy:
10+
matrix:
11+
os: [macos-12, ubuntu-22.04]
12+
env:
13+
working-directory: .test/include
14+
15+
steps:
16+
17+
- name: Install MPFR
18+
run: |
19+
if [ "$RUNNER_OS" == "Linux" ]; then
20+
sudo apt-get update -y
21+
sudo apt-get install -y libmpfr-dev
22+
elif [ "$RUNNER_OS" == "macOS" ]; then
23+
brew update
24+
brew install mpfr
25+
fi
26+
27+
- name: Checkout Repository
28+
uses: actions/checkout@v2
29+
30+
- name: Copy Library Directory
31+
working-directory: ${{env.working-directory}}
32+
run: cp -r ../../hypercomplex hypercomplex
33+
34+
- name: Display compiler version
35+
run: g++ --version
36+
37+
- name: Compile Test Program
38+
working-directory: ${{env.working-directory}}
39+
run: g++ --std=c++17 test.cpp -o test -lmpfr -lgmp
40+
41+
- name: Execute Test Program
42+
working-directory: ${{env.working-directory}}
43+
run: ./test
44+
645
Install:
746
runs-on: ${{ matrix.os }}
847
strategy:

‎.gitpod.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ tasks:
88
command: |
99
parse_git_branch() { git branch --show-current ; }
1010
export PS1="\e[1;37m(\$(parse_git_branch)) \e[0;33m\w \e[1;37m$\e[0m "
11+
pre-commit install
1112
echo "Ready to work!"
1213
echo "Remember to switch to a feature branch before starting the development :)"
1314

‎.pre-commit-config.yaml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
repos:
2+
3+
- repo: https://github.com/pre-commit/pre-commit-hooks
4+
rev: v4.4.0
5+
hooks:
6+
7+
- id: no-commit-to-branch
8+
name: "[01/09] Forbid committing to `master` branch"
9+
args: [--branch=master]
10+
always_run: true
11+
12+
- id: check-merge-conflict
13+
name: "[02/09] Check for merge conflict strings"
14+
always_run: true
15+
16+
- id: check-case-conflict
17+
name: "[03/09] Guard against case-insensitive filesystems"
18+
always_run: true
19+
20+
- id: fix-byte-order-marker
21+
name: "[04/09] Remove UTF-8 byte order marker (BOM)"
22+
always_run: true
23+
24+
- id: check-added-large-files
25+
name: "[05/09] Forbid commiting files bigger than 1MB"
26+
args: [— maxkb=1024]
27+
always_run: true
28+
29+
- id: trailing-whitespace
30+
name: "[06/09] Check for trailing whitespaces"
31+
args: [--markdown-linebreak-ext=md]
32+
always_run: true
33+
34+
- id: end-of-file-fixer
35+
name: "[07/09] Ensure 1 newline at the end of each file"
36+
always_run: true
37+
38+
- id: mixed-line-ending
39+
name: "[08/09] Correct mixed line endings"
40+
always_run: true
41+
42+
- id: check-yaml
43+
name: "[09/09] Check YAML files syntax"
44+
files: \.ya?ml$
45+
always_run: true

‎README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
[![Contribute with Gitpod](https://img.shields.io/badge/Contribute%20with-Gitpod-908a85?logo=gitpod)](https://gitpod.io/#https://github.com/AngryMaciek/hypercomplex)
2-
[![build](https://github.com/AngryMaciek/hypercomplex/workflows/Include/badge.svg?branch=master)](https://github.com/AngryMaciek/hypercomplex/actions?query=workflow%3AInclude)
3-
[![build](https://github.com/AngryMaciek/hypercomplex/workflows/Install/badge.svg?branch=master)](https://github.com/AngryMaciek/hypercomplex/actions?query=workflow%3AInstall)
4-
[![build](https://github.com/AngryMaciek/hypercomplex/workflows/Catch2/badge.svg?branch=master)](https://github.com/AngryMaciek/hypercomplex/actions?query=workflow%3ACatch2)
2+
[![pre-commit](https://img.shields.io/badge/pre--commit-+-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
3+
[![user](https://github.com/AngryMaciek/hypercomplex/workflows/Include&Install/badge.svg?branch=master)](https://github.com/AngryMaciek/hypercomplex/actions?query=workflow%3Auser)
4+
[![catch2](https://github.com/AngryMaciek/hypercomplex/workflows/Catch2/badge.svg?branch=master)](https://github.com/AngryMaciek/hypercomplex/actions?query=workflow%3ACatch2)
55
[![codecov](https://codecov.io/gh/AngryMaciek/hypercomplex/branch/master/graph/badge.svg?token=SSKOK4XR1M)](https://codecov.io/gh/AngryMaciek/hypercomplex)
66
[![Cpp17](https://img.shields.io/badge/C%2B%2B-17-blue)](https://en.wikipedia.org/wiki/C%2B%2B17)
7-
[![build](https://github.com/AngryMaciek/hypercomplex/workflows/cpplint/badge.svg?branch=master)](https://github.com/AngryMaciek/hypercomplex/actions?query=workflow%3Acpplint)
7+
[![cpplint](https://github.com/AngryMaciek/hypercomplex/workflows/cpplint/badge.svg?branch=master)](https://github.com/AngryMaciek/hypercomplex/actions?query=workflow%3Acpplint)
88
[![CodeFactor](https://www.codefactor.io/repository/github/angrymaciek/hypercomplex/badge)](https://www.codefactor.io/repository/github/angrymaciek/hypercomplex)
9-
[![docs](https://github.com/AngryMaciek/hypercomplex/workflows/docs/badge.svg?branch=master)](https://github.com/AngryMaciek/hypercomplex/actions?query=workflow%3Adocs)
9+
[![publish](https://github.com/AngryMaciek/hypercomplex/workflows/publish/badge.svg?branch=master)](https://github.com/AngryMaciek/hypercomplex/actions?query=workflow%3Apublish)
1010
[![DOI](https://joss.theoj.org/papers/10.21105/joss.05272/status.svg)](https://doi.org/10.21105/joss.05272)
1111

1212
<img src="img/logo.png" alt="drawing" height="30"/>

‎environment.yml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
###############################################################################
2+
#
3+
# Software to be installed in the environment
4+
#
5+
# AUTHOR: Maciek_Bak
6+
# AFFILIATION: Department_of_Mathematics_City_University_of_London
7+
# CONTACT: [email protected]
8+
# CREATED: 01-08-2023
9+
# LICENSE: Apache 2.0
10+
#
11+
###############################################################################
12+
---
13+
14+
name: hypercomplex-dev
15+
16+
channels:
17+
- conda-forge
18+
19+
dependencies:
20+
- compilers=1.6.0
21+
- cpplint=1.6.0
22+
- doxygen=1.9.7
23+
- make=4.3
24+
- mpfr=4.2.0
25+
- pre-commit=3.2.1
26+
27+
...

0 commit comments

Comments
 (0)