¶ Repository and Project Creation
Repository creation are now under team leader responsibilities.
Other members won’t be allowed to create or fork repository into the organization.
Repository permission must be granted using the teams.
¶ Repository creation procress
- Repository should be created using template repository (see down here)
- Repository should be added to Team Sonia Team
- Repository access should be given to the proper team using their team repository access panel Github Team Setup
- Repository branch develop should be created from master branch
- Branch protection should be added to master and develop branch
¶ Repository creation using project template
Since we are now using and improved development process template for issues and PR have been added alongside other multiple templatable stuff.
To simplify repo creation we have created template repositories :
NOTE: While using the ROS package Template please create the repo in github before then clone it into your
ros_sonia_ws/src/ directory then you can init your package using the catkin_create_pkg your-package-name command
For more information on creating packages with ROS go to : ROS Creating Package
Recently architectural decision was made, we have deciced to migrate our ROS node in container using docker.
Addition information on this can be found here Dockerized ROS node
¶ Repository branches setup
Upon new repository creation, you must create a develop branch from the master branch
After the creation of the develop branch, permission must be setted on both the masterand developbranch.
NOTE: Unmentionned settings are using github value
- Require pull request reviews before merging : Must be checked
- Required approving reviews must be set to 1
- Dismiss stale pull request approvals when new commits are pushed : Must be checked
- Require status checks to pass before merging : Must be checked
- You will need to select the proper status check that are given by our workflow action on github actions
- Require branches to be up to date before merging: Must be checked
- Include administrators: Must be checked (Only on
master)
We modified the repository branch set up to allow commit to
developfor an administrator that way they will be able to increment version value inpackage.xmlto allow multiple feature merging at once
¶ Project creation
Upon repository creation and setup completion a project should be created in a new repository
To create a repository project go into the repository on github.com
Then got into the project tab and press the new project button.
Upon pressing the button fill in project name e.g Demo Sonia and select Automated kanban with reviews.
Then press the create project button
¶ Project Discord integration
Slack integration can be done following steps in the following page Github Discord Integration
¶ Project CI/CD Pipeline Integration
Github actions workflow templates are available in ros-package-repo-template
All newly created packages using this repo template will have template for CI/CD integration
For more information on how to complete CI/CD integration for a repository see CI/CD Integration Process