CSC 217 Lab 12 Deployment
When you deploy your software, you release it to your customer. For CSC 217, that means your work is ready for evaluation by the teaching staff. We will evaluate your work against the Lab 11 rubric. As you compare your submission against the rubric and make your final push to GitHub, you should complete these final checks:
- You have met the requirements and design for the Lab 11
PackScheduler
project. - You have a green ball on your lab section’s Jenkins (No test failures and no static analysis notifications).
- All student unit tests pass with a green bar (0 errors).
- At least 80% statement coverage on non-UI classes. We now have a check for coverage of > 80% for each class. If you don’t have coverage of > 80% line coverage for every non-UI class, you will have a yellow ball and the teaching staff tests will not run.
- All teaching staff JUnit tests pass with a green bar (0 errors).
- There are no FindBugs notifications.
- There are no PMD notifications.
- There are no CheckStyle notifications.
- All design files are in the appropriate locations and pushed to GitHub.
- All code is commented with meaningful comments.
- Javadoc webpages are generated with the latest comments.
- That you meet all rubric items for the assignment.
Make sure that you push all code and other required artifacts to GitHub by the assignment deadline. Check your Jenkins results on your lab’s Jenkins server Lab assignments will not be accepted late!
Generate Javadoc
Commenting your code is important! Comments describe what the code is supposed to do. At a minimum, you should comment your classes, fields, and methods. All methods should be Javadoc-ed, including methods that were automatically generated by Eclipse. When working with CSC 216 projects, you should delete any automatically generated non-Javadoc documentation and replace it with Javadoc appropriate for the overridden method.
Java provides the Javadoc tool to generate a set of web pages that display the comments for your code.
Reminder: Generating Javadoc
To generate Javadoc, you need to configure and run the Javadoc tool, fix Javadoc errors and warnings, and check the generated Javadoc pages. Make sure you push your changes to GitHub!
Lab Checks
There are several checks that will occur during your build to ensure that you’re following software engineering best practices:
- Library checks: You have been working with the
SortedList
class that is part of the CSC 217Collections library. Additionally, you’ve created customArrayList
andLinkedAbstractList
implementations. You must remove all of your references tojava.util.ArrayList
andjava.util.LinkedList
from your project - including the Javadoc. If you receive a red ball and a message in the console output about usingjava.util.ArrayList
orjava.util.LinkedList
, search your project for the string and regenerate your Javadoc! - Coverage checks: You must have 80% coverage for each non-GUI and non-test class in
PackScheduler
. A tool will check that you have passed the 80% threshold before running any of the teaching tests.
Push to GitHub
Push your PackScheduler
project to GitHub
- Add the unstaged changes to the index.
- Commit and push changes. Remember to use a meaningful commit message describing how you have changed the code.
Reminder: Staging and Pushing to GitHub
GitHub Resources:
Check Jenkins
Check your project on Jenkins to ensure that you are making progress.
Reminder: Interpreting Jenkins
Check the following items on Jenkins for your last build and use the results to estimate your grade: