diff --git a/config.yml b/config.yml index 1c52d22..03d8cc8 100644 --- a/config.yml +++ b/config.yml @@ -40,12 +40,17 @@ steps: action_id: issue - type: closeIssue issue: Welcome + - type: octokit + method: repos.getPages + owner: '%payload.repository.owner.login%' + repo: '%payload.repository.name%' + action_id: pagesUrl - type: respond issue: Welcome with: 02_closed-issue.md data: url: '%actions.issue.data.html_url%' - pages: 'https://%payload.repository.owner.login%.github.io/%payload.repository.name%' + pages: '%actions.pagesUrl.data.html_url%' - title: Find the vulnerable dependency description: Find the vulnerable dependency, and comment with the suggested update version. @@ -54,8 +59,6 @@ steps: actions: - type: respond with: 03_found-vulnerability.md - data: - url: 'https://github.com/%payload.repository.owner.login%/%payload.repository.name%/pull/1' - type: closeIssue issue: Find repository vulnerabilities @@ -98,8 +101,6 @@ steps: - type: updateBranchProtection - type: respond with: 04a_good-merge.md - data: - url: 'https://github.com/%payload.repository.owner.login%/%payload.repository.name%/pull/3' - title: Add to the `.gitignore` file description: The `.gitignore` file is ready to be edited in an open pull request. Add the `.env` file to the `.gitignore` file. @@ -136,11 +137,16 @@ steps: number: '%payload.repository.pull_request.number%' - type: respond with: 05_early-close.md + - type: octokit + method: repos.getPages + owner: '%payload.repository.owner.login%' + repo: '%payload.repository.name%' + action_id: pagesUrl - type: createIssue title: Congratulations! body: 06b_final-issue.md data: - url: 'https://%user.username%.github.io/%payload.repository.name%' + url: '%actions.pagesUrl.data.html_url%' action_id: finalIssue - type: respond with: 06a_nice-merge.md diff --git a/responses/01a_class-introduction-issue.md b/responses/01a_class-introduction-issue.md index eeb0b84..34f7e00 100644 --- a/responses/01a_class-introduction-issue.md +++ b/responses/01a_class-introduction-issue.md @@ -25,7 +25,7 @@ This project is centered around a memory game that will be deployed with GitHub ### :keyboard: Activity: Enable vulnerability alerts & GitHub Pages -1. Click the **Settings** tab in your repository. +1. Click the [**Settings**]({{ repoUrl }}/settings) tab in your repository. 1. Scroll down until you see **Data services**. 1. Under **Data services**, click the check boxes to enable all the data services. 1. Scroll down to **GitHub Pages**. Select `master` as a **Source**, and click **Save**. @@ -35,18 +35,16 @@ This project is centered around a memory game that will be deployed with GitHub ### :keyboard: Activity: Enable GitHub Pages -1. Click the **Settings** tab in your repository. +1. Click the [**Settings**]({{ repoUrl }}/settings) tab in your repository. 1. Scroll down to **GitHub Pages**. Select `master` as a **Source**, and click **Save**. {% endif %} - - For a printable version of the steps in this course, check out the [Quick Reference Guide]({{ host }}/public/{{ course.slug }}.pdf). > Turning on GitHub Pages creates a deployment of your repository. I may take up to a minute to respond as I await the deployment.
-

Return to this issue for my next comment

+

Return to this issue for my next comment.

> _Sometimes I respond too fast for the page to update! If you perform an expected action and don't see a response from me, wait a few seconds. Then refresh the page for your next steps._ diff --git a/responses/02_closed-issue.md b/responses/02_closed-issue.md index e4b9c26..75c4b2d 100644 --- a/responses/02_closed-issue.md +++ b/responses/02_closed-issue.md @@ -1,4 +1,4 @@ Great work. Make sure to complete the first few steps in your settings. Then, you should be able to see your published [memory game on GitHub Pages]({{ pages }}).
-

I've opened another issue with the next steps

+

I've opened another issue with the next steps.

diff --git a/responses/02_find-vulnerabilities.md b/responses/02_find-vulnerabilities.md index 377839d..411f60e 100644 --- a/responses/02_find-vulnerabilities.md +++ b/responses/02_find-vulnerabilities.md @@ -28,13 +28,16 @@ Use GitHub's security alerts to identify a vulnerable NPM dependency. ### :keyboard: Activity: Identify the suggested version update -1. Click the **Insights** tab in your repository -1. On the left hand navigation bar, click **Dependency graph** -1. Scroll down until you see a yellow bar highlighting the dependency named `debug`, and click on the right hand side of the yellow `debug` section -1. Take note of the suggested version -1. Comment in this issue with the suggested update version +1. Click the **Insights** tab in your repository. +2. On the left hand navigation bar, click **Dependency graph**. +3. Scroll down until you see a yellow bar highlighting the dependency named `debug`, and click on the right hand side of the yellow `debug` section. +4. Take note of the suggested version. +5. Comment in this issue with the suggested update version. + + +> _**GitHub Enterprise Server only:** This is all possible on GitHub Enterprise through GitHub Connect. It may take up to an hour to refresh the alerts and make them visible. After waiting a reasonable amount of time, if you are still not seeing the yellow bar in the Dependency Graph, you may want to contact your administrator. In the mean time, to move along with the course, we'll give you a hint - the recommended upgraded version is `2.6.9`._ For a printable version of the steps in this course, check out the [Quick Reference Guide]({{ host }}/public/{{ course.slug }}.pdf).
-

Return to this issue for my next comment

+

Return to this issue for my next comment.

diff --git a/responses/03_found-vulnerability.md b/responses/03_found-vulnerability.md index 05f8bcb..819b8c2 100644 --- a/responses/03_found-vulnerability.md +++ b/responses/03_found-vulnerability.md @@ -1,4 +1,4 @@ Nice work!
-

I've opened a pull request with your next steps

+

I've opened a pull request with your next steps.

diff --git a/responses/03_good-pr.md b/responses/03_good-pr.md index c7af2a7..c74089c 100644 --- a/responses/03_good-pr.md +++ b/responses/03_good-pr.md @@ -5,4 +5,4 @@ Great job, @{{ user.username }}, your pull request looks good. Thank you for fix _Note: You might notice that this repository has a `package.json` file, but no `package-lock.json` file. We are doing all parts of this activity on GitHub.com. If you work with other repositories, you might notice some differences. Regardless of what dependency files you use, the main concepts of this course still apply._ ### :keyboard: Activity: Merge -1. Merge this pull request +1. Merge this pull request. diff --git a/responses/03_update-dependency.md b/responses/03_update-dependency.md index 973cf7a..d0a595a 100644 --- a/responses/03_update-dependency.md +++ b/responses/03_update-dependency.md @@ -10,7 +10,7 @@ Now that you know the recommended version, it's time to edit the `package.json` ### :keyboard: Activity: Update the `package.json` file -1. Within this pull request, go to **Files changed** -1. Click the pencil in the right upper corner to edit the `package.json` file -1. Fix the vulnerability by updating to the latest version of the dependency that you took note of earlier -1. Scroll down, and commit your change +1. Within this pull request, go to **Files changed**. +1. Click the ellipsis (`...`) in the right upper corner and click **Edit file** to edit the `package.json` file. +1. Fix the vulnerability by updating to the latest version of the dependency that you took note of earlier. +1. Scroll down, and commit your change. diff --git a/responses/04a_good-merge.md b/responses/04a_good-merge.md index ca74762..5e8a5dd 100644 --- a/responses/04a_good-merge.md +++ b/responses/04a_good-merge.md @@ -1,4 +1,4 @@ Nice job merging @{{ user.username }}. Go ahead and delete the branch.
-

Let's learn about .gitignore files in the next pull request

+

Let's learn about .gitignore files in the next pull request.

diff --git a/responses/04b_add-gitignore.md b/responses/04b_add-gitignore.md index c14db67..6d337f6 100644 --- a/responses/04b_add-gitignore.md +++ b/responses/04b_add-gitignore.md @@ -14,16 +14,16 @@ In this pull request, I'm adding a `.gitignore` file. Files ending with `.env` c ### :keyboard: Activity: Updating the .gitignore file -1. Within this pull request, go to **Files changed** -1. Click the pencil in the right upper corner to edit the `.gitignore` file -1. Edit the file by adding `.env` to line 1 -1. Scroll down, and commit your change +1. Within this pull request, go to **Files changed**. +1. Click the ellipsis (`...`) in the right upper corner and click **Edit file** to edit the `.gitignore` file. +1. Edit the file by adding `.env` to line 1. +1. Scroll down, and commit your change. > _Note: Even after adding a file to the `.gitignore`, the previous commits that have edited that file still exist. If you accidentally committed sensitive data, first change any tokens or passwords. Then, contact GitHub Support for help correcting your history._ For a printable version of the steps in this course, check out the [Quick Reference Guide]({{ host }}/public/{{ course.slug }}.pdf).
-

Return to this pull request for my next comment

+

Return to this pull request for my next comment.

> _Sometimes I respond too fast for the page to update! If you perform an expected action and don't see a response from me, wait a few seconds. Then refresh the page for your next steps._ diff --git a/responses/05_good-ignore.md b/responses/05_good-ignore.md index 5a66278..80bd4e6 100644 --- a/responses/05_good-ignore.md +++ b/responses/05_good-ignore.md @@ -3,4 +3,4 @@ This looks great @{{ user.username }}, thanks for adding a `.env` file to the `.gitignore`. Feel free to add any other file or potential sensitive data to the `.gitignore` file. ### :keyboard: Activity: Merge -1. Merge this pull request +1. Merge this pull request. diff --git a/responses/06a_nice-merge.md b/responses/06a_nice-merge.md index 32daa67..86b9743 100644 --- a/responses/06a_nice-merge.md +++ b/responses/06a_nice-merge.md @@ -1,4 +1,4 @@ Congratulations, you've done it @{{ user.username }}! Go ahead and delete the branch.
-

Find your final issue here now

+

Find your final issue here now.

diff --git a/responses/06b_final-issue.md b/responses/06b_final-issue.md index 13ecd42..1e28aeb 100644 --- a/responses/06b_final-issue.md +++ b/responses/06b_final-issue.md @@ -29,4 +29,4 @@ Want to learn more options to secure your repository? Check out the [documentati Want to keep learning? Feel free to [check out our other courses]({{ host }}/courses).
-

I won't respond to this issue, go ahead and close it when finished

+

I won't respond to this issue, go ahead and close it when finished.

diff --git a/responses/e_accidental-close.md b/responses/e_accidental-close.md index 4ef81b0..ffb7ddd 100644 --- a/responses/e_accidental-close.md +++ b/responses/e_accidental-close.md @@ -1,3 +1,3 @@ It looks like you have accidentally closed this pull request. To complete this activity, please use the instructions provided to close this pull request. -If you would like help troubleshooting, create a post on the [GitHub Community]({{ communityBoard }}) board. You might also want to search for your issue to see if other people have resolved it in the past. +If you would like help troubleshooting, create a post on the [GitHub Community]({{ communityBoard }}) board. You might also want to search for your issue to see if others have resolved it in the past. diff --git a/server-installation-notes.md b/server-installation-notes.md index 36a9834..5f378bd 100644 --- a/server-installation-notes.md +++ b/server-installation-notes.md @@ -14,4 +14,5 @@ The following are dependencies of the course. The course may continue to work wi | Dependency | Required? | Reason | Alternative | |---------------------------------------------------------------------------------------------------------------------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | GHES must be able to reach githubusercontent.com | Yes | Images used throughout the course are served from this domain. Learners will find broken images required to take the course without this access. | Manually download the images referenced in the `responses/` folder, upload them to an accessible domain, and replace the images in the `responses/` folder. | -| Learner must be able to reach github.com and outside web | No | Links are provided to resources that live on the outside web. | Without access to resources on the outside web, learners will reach blocked resources. You can change the links to these resources in the `responses/` folder, and in the template repository. | \ No newline at end of file +| Learner must be able to reach github.com and outside web | No | Links are provided to resources that live on the outside web. | Without access to resources on the outside web, learners will reach blocked resources. You can change the links to these resources in the `responses/` folder, and in the template repository. | +| [GitHub Pages](https://help.github.com/en/enterprise/admin/installation/configuring-github-pages-on-your-appliance) | No | Used to let the learner work on a realistic, published web page. | Remove the first step in `config.yml`, and adjust responses in the `responses/` folder to remove any mentions of GitHub Pages. | \ No newline at end of file