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

Add dockerhub release logic and improve main readme #550

Merged
merged 14 commits into from
Jan 18, 2024

Conversation

RedLeader962
Copy link
Collaborator

@RedLeader962 RedLeader962 commented Jan 9, 2024

Description

Summary:

Add the necessary logic to build and push libpointmatcher release docker image to dockerhub.
Also made some improvment to the main readme:

  • add instruction to use the libpointmatcher release docker image
  • add instruction to use the new libpointmatcher installers scripts
  • move the summary near the libpointmatcher banner
  • move the contributing section to a separate file so that the readme remain easy to consult

Also fixed the new build failure related to pyton binding compilation via github action

Changes and type of changes (quick overview):

  • feat: add dockerhub release logic [NMO-469]
  • build: update NBS submodule to latest
  • build: add release crawler script and .env file
  • docs: move contributing instructions to the doc/contributing directory [NMO-442]
    • move contributing instructions to a contributing_instructions.md file
    • move commit_msg_reference.md to doc/contributing directory
    • change remaining ethz-asl domain reference to norlab-ulaval
    • main README.MD
      • move the summary up, under the top banner
      • add missing installer script instructions
      • add docker image usage instructions
  • fix: boost download issue >> Move from jfrog artifactory to archives.boost.io
  • fix: bump package.xml version to version 1.4.0 [issue package.xml version was not bumped to latest version 1.4.0 #549]

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 contributing_instructions.md 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 indicated the related issue's id with # <issue-id> if changes are of type fix
  • I have included a high-level list of changes and their corresponding types
    (See commit_msg_reference.md for details)

…ry` [NMO-442]

- move contributing instructions to a contributing_instructions.md file
- move commit_msg_reference.md to `doc/contributing directory`
- change remaining ethz-asl domain reference to norlab-ulaval
- main `README.MD`
   - move the summary up, under the top banner
   - add missing installer script instructions
   - add docker image usage instructions
Copy link
Collaborator

@boxanm boxanm left a comment

Choose a reason for hiding this comment

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

Good job Luc! Would be great to add a short guide on how to use the docker image to perform a simple pmicp to align two point clouds.
Would you mind addressing this issue as well in this PR? #549

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@RedLeader962
Copy link
Collaborator Author

Would be great to add a short guide on how to use the docker image to perform a simple pmicp to align two point clouds.

@boxanm Yes I'm planning to do that this summer. The libpointmatcher dockerhub will have full instruction and will be setup to promote and raise the profile of the codebase. I'll reach out to you when I'll work on that to get your input on a good example/use case design.

@RedLeader962
Copy link
Collaborator Author

RedLeader962 commented Jan 9, 2024

Also made some improvment to the main readme:

  • add instruction to use the libpointmatcher release docker image
  • add instruction to use the new libpointmatcher installers scripts
  • move the summary near the libpointmatcher banner
  • move the contributing section to a separate file so that the readme remain easy to consult

@pomerlef I would like your approval for the changes that I made to the main README.md.

Note: The rest of the PR are changes related to release on dockerhub and some build related fix

Copy link
Collaborator

@simonpierredeschenes simonpierredeschenes left a comment

Choose a reason for hiding this comment

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

Everything looks fine, good job!

Copy link

sonarcloud bot commented Jan 10, 2024

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

.github/pull_request_template.md Outdated Show resolved Hide resolved
build_system/README.md Outdated Show resolved Hide resolved
@RedLeader962 RedLeader962 merged commit 65320bc into develop Jan 18, 2024
6 checks passed
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.

3 participants