Skip to content

Improve Testing, Documentation, and CI/CD for GLIMPSE2 DevelopmentSome #267

Open
Truongphi20 wants to merge 81 commits intoodelaneau:masterfrom
Truongphi20:main
Open

Improve Testing, Documentation, and CI/CD for GLIMPSE2 DevelopmentSome #267
Truongphi20 wants to merge 81 commits intoodelaneau:masterfrom
Truongphi20:main

Conversation

@Truongphi20
Copy link
Copy Markdown

@Truongphi20 Truongphi20 commented Aug 19, 2025

I’m submitting this PR to contribute some improvements that I thought could be helpful for GLIMPSE2. The changes focus on testing, documentation, and development workflow, aiming to make the project easier to use and maintain.

Updates

Summarize

This PR introduces improvements across the development workflow, testing, and documentation:

  • Development environment

    • Added a devcontainer to ensure consistent preproduction setup during development.
  • Testing

    • Implemented unit tests for major modules (chunk, split_ref, phase, ligate, concordance) using CMake.
    • Created dedicated CMake targets for running test suites.
  • Documentation

    • Integrated Doxygen to generate developer documentation (preview here).
    • Polished and reformatted docstrings and comments.
  • CI/CD (GitHub Actions)

    • Configured workflows to build and test automatically.
    • Added steps to build and push Docker images to GHCR.
    • Deployment of Doxygen docs to GitHub Pages.
  • Codebase improvements

@srubinacci
Copy link
Copy Markdown
Collaborator

Hi, this is great, but it might be require careful cheching for us to accept those. Can you send me an email, so we can perhaps coordinate on this?

(Please use my helsinki.fi email address).

Thanks!

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