Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 26 additions & 26 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ on:
jobs:
build:
name: Build Release

strategy:
matrix:
os: [ubuntu-latest, windows-latest, macos-latest]
Expand All @@ -21,29 +21,29 @@ jobs:
- os: macos-latest
release_suffix: out
runs-on: ${{ matrix.os }}

steps:
- uses: actions/checkout@v2
- name: Setup Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: '3.0'

- name: Install Ceedling
run: gem install ceedling

- name: Build Release
run: ceedling release


- name: Rename build binary
shell: pwsh
run: Move-Item -Path build/release/flowVC.out -Destination build/release/flowVC_${{ runner.os }}.${{ matrix.release_suffix}}

- name: Upload Build Artifact
uses: actions/upload-artifact@v4
with:
name: flowVC_${{ runner.os }}
path: build/release/flowVC_${{ runner.os }}.${{ matrix.release_suffix}}
overwrite: true
- uses: actions/checkout@v2

- name: Setup Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: '3.0'

- name: Install Ceedling
run: gem install ceedling

- name: Build Release
run: ceedling release


- name: Rename build binary
shell: pwsh
run: Move-Item -Path build/release/flowVC.out -Destination build/release/flowVC_${{ runner.os }}.${{ matrix.release_suffix}}

- name: Upload Build Artifact
uses: actions/upload-artifact@v4
with:
name: flowVC_${{ runner.os }}
path: build/release/flowVC_${{ runner.os }}.${{ matrix.release_suffix}}
overwrite: true
7 changes: 6 additions & 1 deletion .github/workflows/cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,16 @@ on:


jobs:

run-tests:
uses: ./.github/workflows/ci.yml

build-release:
uses: ./.github/workflows/build.yml

semantic-release:
needs: build-release
needs: [run-tests, build-release]

if: "!contains(github.event.head_commit.message, '[skip ci]')"

name: Semantic Release
Expand Down
57 changes: 39 additions & 18 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,32 +1,53 @@
---
name: CI

on:
# Manually triggered testing
workflow_dispatch:
push:
# Check every PR to main

# Called from another work flow
workflow_call:

pull_request:
branches:
- main
push:
# Called from CD, prevents duplicate running
branches-ignore:
- main

jobs:
docker-test:
runs-on: ubuntu-latest
build:
name: Run Tests

strategy:
matrix:
os: [ubuntu-latest, windows-latest, macos-latest]
include:
- os: ubuntu-latest
release_suffix: out
- os: windows-latest
release_suffix: exe
- os: macos-latest
release_suffix: out
runs-on: ${{ matrix.os }}

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

- name: Run all Tests using Docker
run: |
docker run \
--interactive \
--rm \
-u $(id -u):$(id -g) \
--volume .:/home/dev/project \
throwtheswitch/madsciencelab-plugins:1.0.0 \
ceedling gcov:all
- uses: actions/checkout@v2

- name: Setup Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: '3.0'

- name: Install Ceedling
run: gem install ceedling

- name: Run Tests
run: ceedling gcov:all

- name: Upload Coverage Report to Codecov
uses: codecov/codecov-action@v5
if: matrix.os == 'ubuntu-latest'
with:
token: ${{ secrets.CODECOV_TOKEN }}
token: ${{ secrets.CODECOV_TOKEN }}
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ jobs:
uses: JamesIves/github-pages-deploy-action@4.1.4
with:
branch: docs
folder: docs/public/
folder: docs/public/
16 changes: 7 additions & 9 deletions README.org
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
* flowVC




[[https://github.com/bkm82/flowVC/actions][https://github.com/bkm82/flowVC/workflows/CI/badge.svg]]
[[https://github.com/bkm82/flowVC/actions][https://github.com/bkm82/flowVC/workflows/CD/badge.svg]]
[[https://github.com/bkm82/flowVC/actions][https://github.com/bkm82/flowVC/workflows/Docs/badge.svg]]
[[../../actions][../../workflows/CI/badge.svg]]
[[../../actions][../../workflows/CD/badge.svg]]
[[../../actions][../../workflows/Docs/badge.svg]]
[[https://codecov.io/gh/bkm82/flowVC][https://codecov.io/gh/bkm82/flowVC/graph/badge.svg?token=1U1152BG8T]]

Flow Visualization Code forked from FlowPhysics/flowVC
Expand Down Expand Up @@ -44,7 +42,7 @@ You cannot compute FTLE and particle trajectories at the same time. The feature

#+begin_quote
[!Note]
Grab a pre-compiled binary for Windows Linux or macOS [[https://github.com/bkm82/flowVC/releases/latest][here]]
Grab a pre-compiled binary for Windows Linux or macOS [[../../releases/latest][here]]
Alternatly build it from source as shown below
#+end_quote

Expand Down Expand Up @@ -72,7 +70,7 @@ You cannot compute FTLE and particle trajectories at the same time. The feature
#+end_src

**** Report any Issues
[[https://github.com/bkm82/flowVC/issues][Issues]]
[[../../issues][Issues]]

** Installation

Expand Down Expand Up @@ -101,7 +99,7 @@ If you want to edit / modify the code, there are various ways to compile the cod

****** Clone the repository
#+begin_src shell
https://github.com/bkm82/flowVC.git
git clone <repo-url>
cd flowVC
#+end_src
****** To compile and run all of the tests, run
Expand All @@ -126,7 +124,7 @@ Alternatly, there is a docker image has the tooling installed.
***** Install [[https://docs.docker.com/engine/install/][Docker]]
***** Clone the repository
#+begin_src shell
https://github.com/bkm82/flowVC.git
git clone <repo-url>
cd flowVC
#+end_src

Expand Down