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

fix: Build system improvements and fixes #546

Conversation

RedLeader962
Copy link
Collaborator

@RedLeader962 RedLeader962 commented Dec 18, 2023

Description

Summary:

Add various github tools such as code owner for protected branch and pull-request template.
Improve/fix build-system and refactor out to NBS logic that is generalisable.
Improve the libpointmatcher-build-system documentation.

Changes and type of changes:

Doc

  • docs typo and submodule version bump
  • doc: update hyperlink to release branch and clean comment
  • docs: improve README.md, fix typo, mod changelog version to 1.4.0.
  • docs: README.md update. Added dev related instructions
  • docs: README.md improvement to the Contributing section
  • docs: add build system shield.io and update git submodule instructions
  • docs: added readme related to libpointmatcher-build-system and updated pull_request_template.md
    references
  • docs: readme contributing instructions + versions and updated PR template

Refactoring

  • refactor: strip SITREP related logic in dotenv files, docker compose files and dockerfiles
  • refactor: execute NBS docker install and buildx create related logic instead of re-implementing
    them. Add bats test
  • refactor: fix LPM build system root path resolution. Added .env.libpointmatcher at root to
    resolve path, top dir name and set prompt acronym for N2ST
  • refactor: bump LPM version number in C++ header to 1.4.0
  • refactor: Rename and update run configurations

Build system

  • build: submodule version bump
  • build: bump NBS submodule version
  • build: update submodule to latest
  • build: update submodule version to latest

Bug fix

  • fix: refactor tests related to tests_docker_interactive/, update run configuration setup,
    restructure directories
  • fix: solve the problem with lpm_crawl_dependencies_build_matrix.bash not passing argument
    properly to sub-shell
  • fix: make run_bats_core_test_in_n2st.bash script able to automatically set the default tests
    directory from within an interactive session

Other

  • style: clean CODEOWNERS file
  • chore: added a PR template and a commit msg references file
  • chore: update IDE run configuration
  • feat: added lpm script to execute nbs crawler script
  • test: add tests for lpm_crawl_libpointmatcher_build_matrix.bleeding.bash; refactor tests/
    dir; add helper fct;
  • chore: add github code owner entries and add instructions
  • Merge pull request feat: Move libpointmatcher build-system logic to norlab-build-system submodule (clean-up and polish) #545 from norlab-ulaval/dev-refactor-libpointmatcher-build-system-logic-to-norlab-build-system-submodule-NMO-398

Checklist:

Code related

  • I have made corresponding changes to the documentation (i.e.: function, class, script header,
    README.md)
  • I have commented hard-to-understand code
  • I have added tests that prove my fix is effective or that my feature works
  • All tests pass locally with my changes (Check README.md #Contributing for local testing procedure using libpointmatcher-build-system)

PR creation related

  • My pull request base ref branch is set to the develop branch (the build-system won't be triggered otherwise)
  • My pull request branch is up-to-date with the develop branch (the build-system will reject it otherwise)

PR description related

  • I have included a quick summary of the changes
  • I have included a high-level list of changes and their corresponding type
  • I have indicated the related issue's id with # <issue-id> if changes are of type fix

Note for repository admins

Release PR related

  • Only repository admins have the privilege to push/merge on the default branch (ie: master) and the release branch.
  • Keep PR in draft mode until all the release reviewers are ready to push the release.
  • Once a PR from release -> master branch is created (not in draft mode),
    • it triggers the build-system test
    • (in-progress) and it triggers the semantic release automation

RedLeader962 and others added 22 commits December 12, 2023 10:19
…y set the default tests directory from within an interactive session
…intmatcher at root to resolve path, top dir name and set prompt acronym for N2ST
…ementation-and-refactor-out-to-NBS-generic-install-logic-NMO-436
…bash`; `refactor tests/` dir; add helper fct;
…ementation-and-refactor-out-to-NBS-generic-install-logic-NMO-436
@RedLeader962
Copy link
Collaborator Author

RedLeader962 commented Dec 18, 2023

@boxanm @simonpierredeschenes @aguenette Sorry guys for the review request. Because of the version bump in PointMatcher.h,the protected branch setting triggered an automatic review request notification because you're listed as code owner. I.e.: 1.3.11.4.0 and 1030110400

//! version of the Pointmatcher library as string
#define POINTMATCHER_VERSION "1.4.0"
//! version of the Pointmatcher library as an int
#define POINTMATCHER_VERSION_INT 10400

@RedLeader962 RedLeader962 self-assigned this Dec 18, 2023
@RedLeader962 RedLeader962 reopened this Dec 18, 2023
@RedLeader962 RedLeader962 merged commit 6ae246e into develop Dec 18, 2023
4 of 5 checks passed
@RedLeader962 RedLeader962 mentioned this pull request Dec 18, 2023
@RedLeader962 RedLeader962 changed the title Build system improvements and fixes fix: Build system improvements and fixes Dec 22, 2023
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