Review the notes from our lab to guide you.
Step 1: Log in to your team's GitHub account. Fork repo at https://github.com/scioffi/SWEN-559-DemoLab. Clone the FORKED repo locally to have code on your computer. Make sure the computer you're using has NodeJS, otherwise download the latest from here: https://nodejs.org/en/download/.
Step 2: cd into the SWEN-559-DemoLab directory you just cloned in a terminal window and locally run npm install and then npm start to run the app. You will see errors in the code!
Step 3: Navigate back to GitHub in your browser and perform the rest of the lab.
Step 1: Navigate to GitHub Marketplace (found in the top navigation bar on GitHub). Search and select "Travis CI".
Step 2: Scroll to the bottom pricing/setup and select open source. Click "Install For Free", complete order and continue installation process.
IMPORTANT: On the install screen, select "Only Select Repositories" and pick the SWEN 559 repo you forked. Continue the installation.
Step 3: Once redirected to the Travis CI website, sign in and authorize the application with GitHub.
Step 4: Once redirected, select your repo and you will see it say "No builds for this repository".
Step 5: Navigate back to the repository. Open the file .travis.yml and add the following code to the bottom of the file:
script:
- npm run buildMake sure to configure your lab GitHub email to the local repo as such: once you are cd in the forked directory on your machine, type the following commands:
git config user.email "yourTeamGithubEmail"
git config user.name "SomeNameGoesHere"
Commit and push the changes to a new branch and open a pull request against master on your forked repo. This should initiate a Travis CI build and the updates to the build will populate on the PR. View the PR and click Details next to the build that is running on the GitHub Travis CI integration widget.
Under "Build Started" click the build that is open on your PR. See the trace of the build script running. The build will fail... leave the PR open and you will update it later.
Step 1: Run the application locally on your computer, use npm start which will open the app in the browser. You will see the error on the page and in the terminal.
Step 2: Fix the syntax error (Hint: it's a JS thing, so if you need help raise your hand)
Step 3: Run npm run build locally to verify changes are fixed
Step 4: Push changes to your branch which already has an open PR. This will update the PR and kick off the Travis CI build again and it should pass this time if your changes are correct.
Step 5: Merge your PR! :)
Step 1: Navigate to the GitHub Marketplace and search for CodeCov
Step 2: Install the integration same as you did for Travis CI and be sure to only add it to the forked repo. Login and authenticate it with your GitHub account.
Step 3: Navigate back to the GitHub repo and make the next code change in the browser (or you can do this locally and push to a new branch). Add the following line npm run test-with-reporting to the .travis.yml file so it should now look like this:
script:
- npm install -g jest codecov
- npm run build
- npm run test-with-reportingOpen a new pull request with this change under a new branch (not master). This PR will initiate the Travis CI integration to kick off a new build. Once the build runs, you should also see a CodeCov report on the pull request as well. Take note to the initial code coverage...
Step 4: The Travis build should error out on a test (oh no!) It's your job to fix the code so that the test will pass! Make this code change locally and run the tests by npm test to see it pass. Once this change is all set, make a commit and push it to your open PR with the pending script changes.
Step 5: See the updated Travis build pass and the code coverage should be higher now. Merge your PR and you're all set!
Try taking the lab a step further and find an integration you want to learn more about or want to teach others on the GitHub Marketplace. Configure this integration into the forked project and be prepared to tell the class about that integration!