Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refractor v2 #6

Merged
merged 81 commits into from
Sep 21, 2024
Merged

Refractor v2 #6

merged 81 commits into from
Sep 21, 2024

Conversation

nguy8tri
Copy link
Collaborator

@nguy8tri nguy8tri commented Sep 17, 2024

Description

This refractor targets a few more things:

  1. Installation Script for installing dependencies of FOUND (install.sh)
    a. For Linux: Debian, Ubuntu, Redhat, Fedora, CentOS (if there exists apt-get, yum, or dnf)
    b. For macOS (via brew)
    c. Rejects other OS systems
    d. Besides Ubuntu/Debian (so apt-get) and Oracle (so yum), the other installation commands are a bit a shot in the dark and need extra verification, but they appear to be correct
  2. Makefile extra targets
    a. Code Coverage is now avaliable via the target coverage, and website is in build/documentation/coverage/index.html
    b. Doxygen is now avaliable via the target doxygen_generate, and website is in build/documentation/doxygen/index.html
    c. Doxygen is initial, there is no cover page (because right now, we don't really have anything to show perse)
  3. Docker container for executing workflows
  4. Workflow: Full build, test, lint, documentation
    a. Doxygen Build upon Pull Request and for Mainline
    b. Code Coverage Generated upon Pull Request and for Mainline
    c. Build should be locatable to associate with PRs
  5. Workflow: Addition of Artifacts to Description upon PR update
  6. Workflow: Cleanup of Doxygen/Coverage from Pull Requests

Artifacts for PR #6 (DO NOT CHANGE)

@nguy8tri nguy8tri requested a review from tan7271 September 18, 2024 04:27
install.sh Outdated Show resolved Hide resolved
Copy link

@zeddie888 zeddie888 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove mac installation instructions for now (since untetsed)

@nguy8tri nguy8tri requested a review from zeddie888 September 21, 2024 16:12
Copy link

@zeddie888 zeddie888 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@nguy8tri nguy8tri merged commit f370c67 into main Sep 21, 2024
6 checks passed
nguy8tri added a commit that referenced this pull request Sep 21, 2024
author Tri Nguyen <[email protected]> 1726553383 -0700
committer Tri Nguyen <[email protected]> 1726962211 -0700

Trying another deploy-pages target

Fixed syntax

Modified doccumentation creation

Commented out code to see where the problem is

Commented out code to see where the problem is

Added runs-on

Commented out code to see where the problem is

Commented out code to see where the problem is

Commented out code to see where the problem is

added uses to upload pages artifact

condensed targets

Changed upload pages to v3

Changed to expanded build style to accomodate coverage from different branches

Changed to expanded build style to accomodate coverage from different branches

Experimenting with higher level directories

Fixed experiment

Figured that auto-deploying works now?

Testing final workflow changes

Added double brackets

Added auto-install script and changed build workflow

CHanged trigger to test workflow

Final Changes

Changed README.md to use install script

Changed workflow to use main instead of master

Updated doxygen.sh to update the doxygen file

Simplified Doxygen file and redirected stdout into terminal for debugging

Different redirection style for stderr and stdout

Removed /dev/tty from doxygen.sh

Exit on command failure for doxygen.sh for live build

Revert error check, because we already check the main error

Added workflow for uploading

Fixed syntax error

Trying another style

Comment out require line

Taking it out instead

Updateing github to github.rest

Changed order of headers

Changed header to correct position

Changed the bodies

Update with edit and synchronizing

Added console logging for debugging

Added console logging for debugging

Trying different style

Trying even more basic style

Changed to ` style quotes to include PR var in string

Make the coverage categories different

Add better closing workflow

Updated install commands

Modified install command to actually run alternate scripts

PR Changes + shifted valgrind run of test suite to target

Improve Readibility for workflow

Refractor v2 (#6)
nguy8tri added a commit that referenced this pull request Sep 22, 2024
commit f370c67
Author: Tri Nguyen <[email protected]>
Date:   Sat Sep 21 16:21:59 2024 -0700

    Refractor v2 (#6)

commit 0a466d3
Author: Tri Nguyen <[email protected]>
Date:   Sun Sep 15 19:42:02 2024 -0700

    Refractor Code Base for Implementation (#5)

    Merge from pipeline, refractoring changes

    PR: #5

commit 86a843f
Author: Tri Nguyen <[email protected]>
Date:   Sat Mar 25 17:24:22 2023 -0700

    Update README to viewable version

commit 00a9764
Merge: bc566cb 8eaa5cf
Author: Tri Nguyen <[email protected]>
Date:   Sat Mar 25 16:37:50 2023 -0700

    Merge pull request #2 from UWCubeSat/interface

    Testing Suite Setup
nguy8tri added a commit that referenced this pull request Oct 14, 2024
* Added return to main

* Squashed commit of the following:

commit 86a843f
Author: Tri Nguyen <[email protected]>
Date:   Sat Mar 25 17:24:22 2023 -0700

    Update README to viewable version

commit 00a9764
Merge: bc566cb 8eaa5cf
Author: Tri Nguyen <[email protected]>
Date:   Sat Mar 25 16:37:50 2023 -0700

    Merge pull request #2 from UWCubeSat/interface

    Testing Suite Setup

* Squashed commit of the following:

commit 7b3c7e1
Author: Tri Nguyen <[email protected]>
Date:   Fri Sep 13 10:51:58 2024 -0700

    Refractoring Changes

commit 86a843f
Author: Tri Nguyen <[email protected]>
Date:   Sat Mar 25 17:24:22 2023 -0700

    Update README to viewable version

commit 00a9764
Merge: bc566cb 8eaa5cf
Author: Tri Nguyen <[email protected]>
Date:   Sat Mar 25 16:37:50 2023 -0700

    Merge pull request #2 from UWCubeSat/interface

    Testing Suite Setup

* Merging from refractor

* Pipeline Implementation

* Made initial test and edits to pipeline.*

* Use constants more

* Squashed commit of the following:

commit f370c67
Author: Tri Nguyen <[email protected]>
Date:   Sat Sep 21 16:21:59 2024 -0700

    Refractor v2 (#6)

commit 0a466d3
Author: Tri Nguyen <[email protected]>
Date:   Sun Sep 15 19:42:02 2024 -0700

    Refractor Code Base for Implementation (#5)

    Merge from pipeline, refractoring changes

    PR: #5

commit 86a843f
Author: Tri Nguyen <[email protected]>
Date:   Sat Mar 25 17:24:22 2023 -0700

    Update README to viewable version

commit 00a9764
Merge: bc566cb 8eaa5cf
Author: Tri Nguyen <[email protected]>
Date:   Sat Mar 25 16:37:50 2023 -0700

    Merge pull request #2 from UWCubeSat/interface

    Testing Suite Setup

* Removed catch framework

* Fixed minor issues

* Documentation and Quality Changes

* pending tests

* pipeline tests 100% coverage, all functions work

* Squashed commit of the following:

commit 1d2c89b
Author: Tri Nguyen <[email protected]>
Date:   Sat Oct 5 17:19:22 2024 -0700

    Example Test bugs

commit adece2b
Author: Tri Nguyen <[email protected]>
Date:   Sat Oct 5 17:11:03 2024 -0700

    Stage extension for all stages

* Revert to C++11

* Resolving Changes

---------

Co-authored-by: Tri Nguyen <[email protected]>
nguy8tri added a commit that referenced this pull request Oct 17, 2024
commit 3863509
Author: Hieu Nguyen <[email protected]>
Date:   Mon Oct 14 12:11:23 2024 -0700

    Pipeline Implementation (#7)

    * Added return to main

    * Squashed commit of the following:

    commit 86a843f
    Author: Tri Nguyen <[email protected]>
    Date:   Sat Mar 25 17:24:22 2023 -0700

        Update README to viewable version

    commit 00a9764
    Merge: bc566cb 8eaa5cf
    Author: Tri Nguyen <[email protected]>
    Date:   Sat Mar 25 16:37:50 2023 -0700

        Merge pull request #2 from UWCubeSat/interface

        Testing Suite Setup

    * Squashed commit of the following:

    commit 7b3c7e1
    Author: Tri Nguyen <[email protected]>
    Date:   Fri Sep 13 10:51:58 2024 -0700

        Refractoring Changes

    commit 86a843f
    Author: Tri Nguyen <[email protected]>
    Date:   Sat Mar 25 17:24:22 2023 -0700

        Update README to viewable version

    commit 00a9764
    Merge: bc566cb 8eaa5cf
    Author: Tri Nguyen <[email protected]>
    Date:   Sat Mar 25 16:37:50 2023 -0700

        Merge pull request #2 from UWCubeSat/interface

        Testing Suite Setup

    * Merging from refractor

    * Pipeline Implementation

    * Made initial test and edits to pipeline.*

    * Use constants more

    * Squashed commit of the following:

    commit f370c67
    Author: Tri Nguyen <[email protected]>
    Date:   Sat Sep 21 16:21:59 2024 -0700

        Refractor v2 (#6)

    commit 0a466d3
    Author: Tri Nguyen <[email protected]>
    Date:   Sun Sep 15 19:42:02 2024 -0700

        Refractor Code Base for Implementation (#5)

        Merge from pipeline, refractoring changes

        PR: #5

    commit 86a843f
    Author: Tri Nguyen <[email protected]>
    Date:   Sat Mar 25 17:24:22 2023 -0700

        Update README to viewable version

    commit 00a9764
    Merge: bc566cb 8eaa5cf
    Author: Tri Nguyen <[email protected]>
    Date:   Sat Mar 25 16:37:50 2023 -0700

        Merge pull request #2 from UWCubeSat/interface

        Testing Suite Setup

    * Removed catch framework

    * Fixed minor issues

    * Documentation and Quality Changes

    * pending tests

    * pipeline tests 100% coverage, all functions work

    * Squashed commit of the following:

    commit 1d2c89b
    Author: Tri Nguyen <[email protected]>
    Date:   Sat Oct 5 17:19:22 2024 -0700

        Example Test bugs

    commit adece2b
    Author: Tri Nguyen <[email protected]>
    Date:   Sat Oct 5 17:11:03 2024 -0700

        Stage extension for all stages

    * Revert to C++11

    * Resolving Changes

    ---------

    Co-authored-by: Tri Nguyen <[email protected]>

commit f370c67
Author: Tri Nguyen <[email protected]>
Date:   Sat Sep 21 16:21:59 2024 -0700

    Refractor v2 (#6)

commit 0a466d3
Author: Tri Nguyen <[email protected]>
Date:   Sun Sep 15 19:42:02 2024 -0700

    Refractor Code Base for Implementation (#5)

    Merge from pipeline, refractoring changes

    PR: #5

# Conflicts:
#	src/distance/distance.hpp
#	src/style/style.hpp
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants