Corso Ingegneria del Software 2023 - Cremona

Project Setup

In order to set up your project, follow these steps

Clone and push the template to your repo

On GitHub user settings, scroll down to Developer settings, then Personal access token.

Create one token to be used in place of password when prompted after git command line operations (remember to store it safely).

Using the git command line client for your OS, type the following commands:

 # clone the repo on your current folder, naming the remote as 'template'
 git clone https://github.com/dragonbanana/ingsoft-2023 --origin template
 # move to the cloned repo
 cd ingsoft-2023/
 # add your repository as 'origin' (default) remote
 git remote add origin https://github.com/YOUR_USERNAME/YOUR_REPO_NAME
 # push the template project to your github repository, setting
 git push --set-upstream origin main
 # alternatively, if you already have some content in your repo (e.g., a README)
 # and YOU WANT TO OVERWRITE IT, force the push
 git push --force --set-upstream origin main

then, you can safely remove the 'template' remote by typing git remote rm template.

Customize your project files

Open the pom.xml file in a text editor and substitute the two occurrences of xxx with your team_name.
Substitute the occurence of xxx with your team_name in Dockerfile.
Open .github/workflows/docker.yaml and replace on line 29 pentabanana/ingsoft-2023:latest with {your_dockerhub_repository}/{team_name}:latest
Import it in IntelliJ
Customize the README.md
In order to check that everything worked fine, try to build with Maven:
- from IntelliJ:
  - right-click on the project
  - select Maven->Reload Project
  - wait for the build to complete and make sure you have a build success
  - right-click on class Main and select Run App.main()
  - right-click on class CalculatorTest and select Run CalculatorTest

Commit and push your changes:

git commit -am "customize project"
git push origin main

[OPTIONAL] Configure Github Actions for Continuous Integration and Delivery

Block your main branch:
- Go to your Github repository.
- Navigate to Settings.
- On the left select Branches.
- Add a Branch Protection Rule by pressing Add rule.
- Insert main as branch name pattern.
- In section Protect matching branches, enable the option Require a pull request before merging.
- Go to the bottom, and press Create.
Add Dockerhub secrets is working:
- Go to your Github repository.
- Navigate to Settings.
- On the left select Secrets and Variables -> Actions.
- Press button New Repository Secrets.
- In the Name textfield insert DOCKERHUB_USERNAME and in the Secret textfield insert your dockerhub_username (for example pentabanana).
- Retrieve your Dockerhub token from Dockerhub:
  - Go to your Dockerhub setting page (My Settings).
  - Navigate to Security.
  - Press New Access Token.
  - Insert a name.
  - It will display an Access Token, copy it. It will be displayed only once.
- Go back to the Secrets and Variables -> Actions page and press button New Repository Secrets.
- In the Name textfield insert DOCKERHUB_TOKEN and in the Secret textfield insert your dockerhub_access_token you copied before.

[OPTIONAL] Git Workflow

Create a branch
Add changes to your file
Create pull request
Assign reviewer to the code
Review the code
Check pipeline errors
Merge pull request

DragonBanana / ingsoft-2023