From 26a66e8f457b03a3f018448af2c0d7957827a4b6 Mon Sep 17 00:00:00 2001
From: damithc Go to the main website [http://se-education.org/guides] Go to the main website [http://se-education.org/guides] This is a sub-project of the se-education.org.
Suggestions, questions, and bug reports can be posted in our issue tracker. Alternatively, contact project mentor Damith C. Rajapakse.
- This work is released under the MIT OSS license. PRs to improve/add content are welcome. This website uses MarkBind documentation tool. This document has some guidance on how to use it when updating contents. Follow the Markdown style guide in your PR. The Guides for SE student projects »
Guides for SE student projects »
Guides for SE student projects »
About Us
Contact
License
Contributing
Acknowledgements
favicon.ico
is based on an icon made by Dave Gandy from www.flaticon.com
This work is released under the MIT OSS license.
PRs to improve/add content are welcome.
This website uses MarkBind documentation tool. This document has some guidance on how to use it when updating contents.
Follow the Markdown style guide in your PR.
The favicon.ico
is based on an icon made by Dave Gandy from www.flaticon.com
We recommend using java.util.logging
package for logging.
Logging Levels
SEVERE
: A critical problem detected which may cause the termination of the application.WARNING
: Can continue, but with caution.INFO
: Information showing the noteworthy actions by the App.FINE
: Details that is not usually noteworthy but may be useful in debugging e.g. print the actual list instead of just its size.We recommend using java.util.logging
package for logging.
Logging Levels
SEVERE
: A critical problem detected which may cause the termination of the application.WARNING
: Can continue, but with caution.INFO
: Information showing the noteworthy actions by the App.FINE
: Details that is not usually noteworthy but may be useful in debugging e.g. print the actual list instead of just its size.AddressBook-Level3 (AB3) is a brownfield project template used by SE courses. Given below are some tutorials to help students understand how to navigate and modify the existing AB3 codebase.
Person
class.Authors:
AddressBook-Level3 (AB3) is a brownfield project template used by SE courses. Given below are some tutorials to help students understand how to navigate and modify the existing AB3 codebase.
Person
class.Authors:
Codecov is an online service for generating test coverage reports.
Scenario: You have forked a project that already had support for using Codecov in the GitHub Actions CI pipeline. Now you want to set up your fork to work with Codecov as well.
Given below are the steps for achieving the above, recommended to be done by someone who has admin access to the GitHub organization that contains the fork.
org/fork
is listed in the home page. If not, use the re-syncing
link to sync Codecov data with GitHub (and refresh the page afterward). Try again if it doesn't work the first time, as syncing might take some time.Add GitHub organization
link at the bottom of the dropdown list. Doing so will allow you to install the Codecov integration on your GitHub organization, which is same as the next step.All repositories
option instead).https://app.codecov.io/gh/{YOUR_ORG}
(e.g., https://app.codecov.io/gh/my-team-org
).Setup repo>
option for your fork, and follow the instructions for GitHub Actions. You will need to set up the CODECOV_TOKEN
secret as instructed but there is no need to update the workflow YAML file (as the repo you forked already has a YAML file containing the given code).https://app.codecov.io/gh/{YOUR_ORG}/{YOUR_FORK}/settings/badge
(e.g., https://app.codecov.io/gh/se-edu/addressbook-level3/settings/badge
) and update the appropriate page in your fork.You can control if CI still passes even if Codecov task fails using the line
fail_ci_if_error: true
or fail_ci_if_error: false
in .github/workflows/gradle.yml
, under the section related to Codecov.
Codecov is an online service for generating test coverage reports.
Scenario: You have forked a project that already had support for using Codecov in the GitHub Actions CI pipeline. Now you want to set up your fork to work with Codecov as well.
Given below are the steps for achieving the above, recommended to be done by someone who has admin access to the GitHub organization that contains the fork.
Only select repositories
and choose your repo (you can also use the All repositories
option instead). After that, click the .org/fork
is listed in the home page. If not, use the re-syncing
link to sync Codecov data with GitHub (and refresh the page afterward).https://app.codecov.io/gh/{YOUR_ORG}
(e.g., https://app.codecov.io/gh/my-team-org
).Step 1: Generate and upload coverage reports in your CI
, as it is already set up in your repo.CODECOV_TOKEN
secret as instructed but there.https://app.codecov.io/gh/{YOUR_ORG}/{YOUR_FORK}/settings/badge
(e.g., https://app.codecov.io/gh/se-edu/addressbook-level3/settings/badge
) and update the appropriate page in your fork.You can control if CI still passes even if Codecov task fails using the line
fail_ci_if_error: true
or fail_ci_if_error: false
in .github/workflows/gradle.yml
, under the section related to Codecov.
GitHub Actions is CI/CD tool integrated into GitHub.
In the simplest case, setting up is a matter of adding a .yml
file into the [root]\.github\workflows
folder (example).
GitHub Actions will run the workflow (as per the .yml
file) every time certain project events are triggered (e.g., when a PR is updated, or the master
branch is updated).
GitHub Actions is CI/CD tool integrated into GitHub.
In the simplest case, setting up is a matter of adding a .yml
file into the [root]\.github\workflows
folder (example).
GitHub Actions will run the workflow (as per the .yml
file) every time certain project events are triggered (e.g., when a PR is updated, or the master
branch is updated).