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 CI, pre-commit, prerelease and dependabot #27

Merged
merged 7 commits into from
Nov 22, 2022

Conversation

vatanaksoytezer
Copy link
Collaborator

This PR adds:

  • Industrial CI that will run every PR and push to ensure robustness
  • pre-commit to check cmake and file formatting as well as spelling.
  • pre-release to run an isolated build before releases
  • dependabot to keep up to date with Github Action changes. (@lauralindzey you may need to add dependabot to apl-ocean-engineering to get this working actually)

Suggest reviewing commit by commit:

  • Add CI, pre-commit, prerelease and dependabot
  • pre-commit changes: all these changes are automated, except for the changes in Contrbuting.md.

@@ -0,0 +1,8 @@
version: 2
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm not familiar with dependabot at all -- can you tell me how to test this (you mention needing to make sure to add it to the repo?) either in the conversation for the PR or as an addendum to Contributing.md?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Dependabot is a bot that automatically opens PR to this repository when an action in CI has an updated version (pushes to its own branch in repo, thus needs write access).

Copy link
Collaborator

@lauralindzey lauralindzey Nov 18, 2022

Choose a reason for hiding this comment

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

when an action in CI has an updated version

This is the bit I don't understand -- I'm used to using Github's CI tools to check if a branch passes tests before merging a PR.

What workflow are you automating here that would result in PRs?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

It updates versions of CI tools automatically as in https://github.com/vatanaksoytezer/hydrographic_msgs/blob/vatan/ci/.github/workflows/ci.yaml#L39. Example PR from moveit: moveit/moveit2#1713

@@ -0,0 +1,57 @@
# This config uses industrial_ci (https://github.com/ros-industrial/industrial_ci.git).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Similarly, I'm not familiar with industrial_ci. Is there a way to check that it's working before I merge? Or do I have to merge for Github to automatically run it?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Hmm, you might need to enable Github Actions through organization. It works in my fork, see vatanaksoytezer#2.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Also please use squash merge when merging PRs, it would squash all the commits into a single commit thus we don't actually need to care about commits. History will be pretty clean this way. You can find this option on the little down button near the merge pull request button.

Copy link
Collaborator

Choose a reason for hiding this comment

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

OK, I'll check CI status here after merging; actions should be enabled.

And I'll squash the commits for this one =)

@lauralindzey lauralindzey merged commit 949bdff into apl-ocean-engineering:main Nov 22, 2022
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.

None yet

2 participants