diff --git a/.github/script/STEP b/.github/steps/-step.txt similarity index 100% rename from .github/script/STEP rename to .github/steps/-step.txt diff --git a/.github/steps/0-welcome.md b/.github/steps/0-welcome.md new file mode 100644 index 000000000..9ff13a5df --- /dev/null +++ b/.github/steps/0-welcome.md @@ -0,0 +1 @@ + diff --git a/.github/steps/1-create-a-branch.md b/.github/steps/1-create-a-branch.md new file mode 100644 index 000000000..4fe9b4897 --- /dev/null +++ b/.github/steps/1-create-a-branch.md @@ -0,0 +1,45 @@ + + +## Step 1: Create a branch + +_Welcome to "Introduction to GitHub"! :wave:_ + +**What is GitHub?**: GitHub is a collaboration platform that uses _[Git](https://docs.github.com/get-started/quickstart/github-glossary#git)_ for versioning. GitHub is a popular place to share and contribute to [open-source](https://docs.github.com/get-started/quickstart/github-glossary#open-source) software. +
:tv: [Video: What is GitHub?](https://www.youtube.com/watch?v=pBy1zgt0XPc) + +**What is a repository?**: A _[repository](https://docs.github.com/get-started/quickstart/github-glossary#repository)_ is a project containing files and folders. A repository tracks versions of files and folders. For more information, see "[About repositories](https://docs.github.com/en/repositories/creating-and-managing-repositories/about-repositories)" from GitHub Docs. + +**What is a branch?**: A _[branch](https://docs.github.com/en/get-started/quickstart/github-glossary#branch)_ is a parallel version of your repository. By default, your repository has one branch named `main` and it is considered to be the definitive branch. Creating additional branches allows you to copy the `main` branch of your repository and safely make any changes without disrupting the main project. Many people use branches to work on specific features without affecting any other parts of the project. + +Branches allow you to separate your work from the `main` branch. In other words, everyone's work is safe while you contribute. For more information, see "[About branches](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches)". + +**What is a profile README?**: A _[profile README](https://docs.github.com/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme)_ is essentially an "About me" section on your GitHub profile where you can share information about yourself with the community on GitHub.com. GitHub shows your profile README at the top of your profile page. For more information, see "[Managing your profile README](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme)". + +![profile-readme-example](/images/profile-readme-example.png) + +### :keyboard: Activity: Your first branch + +1. Open a new browser tab and navigate to your newly made repository. Then, work on the steps in your second tab while you read the instructions in this tab. +2. Navigate to the **< > Code** tab in the header menu of your repository. + + ![code-tab](/images/code-tab.png) + +3. Click on the **main** branch drop-down. + + ![main-branch-dropdown](/images/main-branch-dropdown.png) + +4. In the field, name your branch `my-first-branch`. In this case, the name must be `my-first-branch` to trigger the course workflow. +5. Click **Create branch: my-first-branch** to create your branch. + + ![create-branch-button](/images/create-branch-button.png) + + The branch will automatically switch to the one you have just created. + The **main** branch drop-down bar will reflect your new branch and display the new branch name. + +6. Wait about 20 seconds then refresh this page (the one you're following instructions from). [GitHub Actions](https://docs.github.com/en/actions) will automatically update to the next step. diff --git a/.github/steps/2-commit-a-file.md b/.github/steps/2-commit-a-file.md new file mode 100644 index 000000000..919102c39 --- /dev/null +++ b/.github/steps/2-commit-a-file.md @@ -0,0 +1,43 @@ + + +## Step 2: Commit a file + +_You created a branch! :tada:_ + +Creating a branch allows you to edit your project without changing the `main` branch. Now that you have a branch, it’s time to create a file and make your first commit! + +**What is a commit?**: A _[commit](https://docs.github.com/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits)_ is a set of changes to the files and folders in your project. A commit exists in a branch. For more information, see "[About commits](https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits)". + +### :keyboard: Activity: Your first commit + +The following steps will guide you through the process of committing a change on GitHub. A commit records changes in renaming, changing content within, creating a new file, and any other changes made to your project. For this exercise, committing a change requires first adding a new file to your new branch. + +> [!NOTE] +> `.md` is a file extension that creates a Markdown file. You can learn more about Markdown by visiting "[Basic writing and formatting syntax](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)" in our docs or by taking the "[Communicating using Markdown](https://github.com/skills/communicate-using-markdown)" Skills course. + +1. On the **< > Code** tab in the header menu of your repository, make sure you're on your new branch `my-first-branch`. + +2. Select the **Add file** drop-down and click **Create new file**. + + ![create new file option](/images/create-new-file.png) + +3. In the **Name your file...** field, enter `PROFILE.md`. + +4. In the **Enter file contents here** area, copy the following content to your file: + + ``` + Welcome to my GitHub profile! + ``` + + ![profile.md file screenshot](/images/my-profile-file.png) + +5. Click **Commit changes...** in the upper right corner above the contents box. For commits, you can enter a short commit message that describes what changes you made. This message helps others know what's included in your commit. GitHub offers a simple default message, but let's change it slightly for practice. First, enter `Add PROFILE.md` in the first text-entry field titled "Commit message". + + ![screenshot of adding a new file with a commit message](/images/commit-full-screen.png) + +6. In this lesson, we'll ignore the other fields and click **Commit changes**. +7. Wait about 20 seconds then refresh this page (the one you're following instructions from). [GitHub Actions](https://docs.github.com/en/actions) will automatically update to the next step. diff --git a/.github/steps/3-open-a-pull-request.md b/.github/steps/3-open-a-pull-request.md new file mode 100644 index 000000000..ed9cba0b6 --- /dev/null +++ b/.github/steps/3-open-a-pull-request.md @@ -0,0 +1,44 @@ + + +## Step 3: Open a pull request + +_Nice work making that commit! :sparkles:_ + +Now that you have made a change to the project and created a commit, it’s time to share your proposed change through a pull request! + +**What is a pull request?**: Collaboration happens on a _[pull request](https://docs.github.com/en/get-started/quickstart/github-glossary#pull-request)_. The pull request shows the changes in your branch to other people and allows people to accept, reject, or suggest additional changes to your branch. In a side by side comparison, this pull request is going to keep the changes you just made on your branch and propose applying them to the `main` project branch. For more information about pull requests, see "[About pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)". + +### :keyboard: Activity: Create a pull request + +You may have noticed after your commit that a message displayed indicating your recent push to your branch and providing a button that says **Compare & pull request**. + +![screenshot of message and button](/images/compare-and-pull-request.png) + +To create a pull request automatically, click **Compare & pull request**, and then skip to step 6 below. If you don't click the button, the instructions below walk you through manually setting up the pull request. + +1. Click on the **Pull requests** tab in the header menu of your repository. +2. Click **New pull request**. +3. In the **base:** dropdown, make sure **main** is selected. +4. Select the **compare:** dropdown, and click `my-first-branch`. + + ![screenshot showing both branch selections](/images/pull-request-branches.png) + +5. Click **Create pull request**. +6. Enter a title for your pull request. By default, the title will automatically be the name of your branch. For this exercise, let's edit the field to say `Add my first file`. +7. The next field helps you provide a description of the changes you made. Here, you can add a description of what you’ve accomplished so far. As a reminder, you have: created a new branch, created a file, and made a commit. + + ![screenshot showing pull request](/images/Pull-request-description.png) + +8. Click **Create pull request**. You will automatically be navigated to your new pull request. +9. Wait about 20 seconds then refresh this page (the one you're following instructions from). [GitHub Actions](https://docs.github.com/en/actions) will automatically update to the next step. + +> [!NOTE] +> You may see evidence of GitHub Actions running on the tab with the pull request opened! The image below shows a line you might see on your pull request after the Action finishes running. +> +> ![screenshot of an example of an actions line](/images/Actions-to-step-4.png) diff --git a/.github/steps/4-merge-your-pull-request.md b/.github/steps/4-merge-your-pull-request.md new file mode 100644 index 000000000..6b26b90a7 --- /dev/null +++ b/.github/steps/4-merge-your-pull-request.md @@ -0,0 +1,31 @@ + + +## Step 4: Merge your pull request + +_Nicely done! :sunglasses:_ + +You successfully created a pull request. You can now merge your pull request. + +**What is a merge?**: A _[merge](https://docs.github.com/en/get-started/quickstart/github-glossary#merge)_ adds the changes in your pull request and branch into the `main` branch. For more information about merges, see "[Merging a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)." + +As noted in the previous step, you may have seen evidence of GitHub Actions running which automatically progresses your instructions to the next step. You'll have to wait for it to finish before you can merge your pull request. It will be ready when the merge pull request button is green. + +![screenshot of green merge pull request button](/images/Green-merge-pull-request.png) + +### :keyboard: Activity: Merge the pull request + +1. Click **Merge pull request**. +2. Click **Confirm merge**. +3. Once your branch has been merged, you don't need it anymore. To delete this branch, click **Delete branch**. + + ![screenshot showing delete branch button](/images/delete-branch.png) + +4. Wait about 20 seconds then refresh this page (the one you're following instructions from). [GitHub Actions](https://docs.github.com/en/actions) will automatically update to the next step. + +> [!NOTE] +> Check out the **Finish** step to see what you can learn next! diff --git a/.github/steps/X-finish.md b/.github/steps/X-finish.md new file mode 100644 index 000000000..8127bb231 --- /dev/null +++ b/.github/steps/X-finish.md @@ -0,0 +1,34 @@ + + +## Finish + +_Congratulations, you've completed this course and joined the world of developers!_ + +celebrate + +Here's a recap of your accomplishments: + +- You learned about GitHub, repositories, branches, commits, and pull requests. +- You created a branch, a commit, and a pull request. +- You merged a pull request. +- You made your first contribution! :tada: + +### What's next? + +If you'd like to make a profile README, use the quickstart instructions below or follow the instructions in the [Managing your profile README](https://docs.github.com/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme) article. + +1. Make a new public repository with a name that matches your GitHub username. +2. Create a file named `README.md` in its root. The "root" means not inside any folder in your repository. +3. Edit the contents of the `README.md` file. +4. If you created a new branch for your file, open and merge a pull request on your branch. +5. Lastly, we'd love to hear what you thought of this course [in our discussion board](https://github.com/orgs/skills/discussions/categories/introduction-to-github). + +Check out these resources to learn more or get involved: + +- Are you a student? Check out the [Student Developer Pack](https://education.github.com/pack). +- [Take another GitHub Skills course](https://github.com/skills). +- [Read the GitHub Getting Started docs](https://docs.github.com/en/get-started). +- To find projects to contribute to, check out [GitHub Explore](https://github.com/explore). diff --git a/.github/workflows/0-start.yml b/.github/workflows/0-start.yml deleted file mode 100644 index 79cb28376..000000000 --- a/.github/workflows/0-start.yml +++ /dev/null @@ -1,67 +0,0 @@ -name: Step 0, Start - -# This step triggers after the learner creates a new repository from the template -# This step sets STEP to 1 -# This step closes
and opens
- -# This will run every time we create push a commit to `main` -# Reference https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows -on: - workflow_dispatch: - push: - branches: - - main - -# Reference https://docs.github.com/en/actions/security-guides/automatic-token-authentication -permissions: - # Need `contents: read` to checkout the repository - # Need `contents: write` to update the step metadata - contents: write - -jobs: - # Get the current step from .github/script/STEP so we can - # limit running the main job when the learner is on the same step. - get_current_step: - name: Check current step number - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v3 - - id: get_step - run: | - echo "current_step=$(cat ./.github/script/STEP)" >> $GITHUB_OUTPUT - outputs: - current_step: ${{ steps.get_step.outputs.current_step }} - - on_start: - name: On start - needs: get_current_step - - # We will only run this action when: - # 1. This repository isn't the template repository - # 2. The STEP is currently 0 - # Reference https://docs.github.com/en/actions/learn-github-actions/contexts - # Reference https://docs.github.com/en/actions/learn-github-actions/expressions - if: >- - ${{ !github.event.repository.is_template - && needs.get_current_step.outputs.current_step == 0 }} - - # We'll run Ubuntu for performance instead of Mac or Windows - runs-on: ubuntu-latest - - steps: - # We'll need to check out the repository so that we can edit the README - - name: Checkout - uses: actions/checkout@v3 - with: - fetch-depth: 0 # Let's get all the branches - - # Update README to close
and open
- # and set STEP to '1' - - name: Update to step 1 - uses: skills/action-update-step@v1 - with: - token: ${{ secrets.GITHUB_TOKEN }} - from_step: 0 - to_step: 1 - branch_name: my-first-branch diff --git a/.github/workflows/0-welcome.yml b/.github/workflows/0-welcome.yml new file mode 100644 index 000000000..1ee77397f --- /dev/null +++ b/.github/workflows/0-welcome.yml @@ -0,0 +1,64 @@ +name: Step 0, Welcome + +# This step triggers after the learner creates a new repository from the template. +# This workflow updates from step 0 to step 1. + +# This will run every time we create push a commit to `main`. +# Reference: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows +on: + workflow_dispatch: + push: + branches: + - main + +# Reference: https://docs.github.com/en/actions/security-guides/automatic-token-authentication +permissions: + # Need `contents: read` to checkout the repository. + # Need `contents: write` to update the step metadata. + contents: write + +jobs: + # Get the current step to only run the main job when the learner is on the same step. + get_current_step: + name: Check current step number + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - id: get_step + run: | + echo "current_step=$(cat ./.github/steps/-step.txt)" >> $GITHUB_OUTPUT + outputs: + current_step: ${{ steps.get_step.outputs.current_step }} + + on_welcome: + name: On welcome + needs: get_current_step + + # We will only run this action when: + # 1. This repository isn't the template repository. + # 2. The step is currently 0. + # Reference: https://docs.github.com/en/actions/learn-github-actions/contexts + # Reference: https://docs.github.com/en/actions/learn-github-actions/expressions + if: >- + ${{ !github.event.repository.is_template + && needs.get_current_step.outputs.current_step == 0 }} + + # We'll run Ubuntu for performance instead of Mac or Windows. + runs-on: ubuntu-latest + + steps: + # We'll need to check out the repository so that we can edit README.md. + - name: Checkout + uses: actions/checkout@v4 + with: + fetch-depth: 0 # Let's get all the branches. + + # In README.md, switch step 0 for step 1. + - name: Update to step 1 + uses: skills/action-update-step@v2 + with: + token: ${{ secrets.GITHUB_TOKEN }} + from_step: 0 + to_step: 1 + branch_name: my-first-branch diff --git a/.github/workflows/1-create-a-branch.yml b/.github/workflows/1-create-a-branch.yml index 1c3796ae4..5dd9cbe69 100644 --- a/.github/workflows/1-create-a-branch.yml +++ b/.github/workflows/1-create-a-branch.yml @@ -1,33 +1,31 @@ name: Step 1, Create a branch -# This step listens for the learner to create branch `my-first-branch` -# This step sets STEP to 2 -# This step closes
and opens
+# This step listens for the learner to create branch `my-first-branch`. +# This workflow updates from step 1 to step 2. -# This will run every time we create a branch or tag -# Reference https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows +# This will run every time we create a branch or tag. +# Reference: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows on: workflow_dispatch: create: -# Reference https://docs.github.com/en/actions/security-guides/automatic-token-authentication +# Reference: https://docs.github.com/en/actions/security-guides/automatic-token-authentication permissions: - # Need `contents: read` to checkout the repository - # Need `contents: write` to update the step metadata + # Need `contents: read` to checkout the repository. + # Need `contents: write` to update the step metadata. contents: write jobs: - # Get the current step from .github/script/STEP so we can - # limit running the main job when the learner is on the same step. + # Get the current step to only run the main job when the learner is on the same step. get_current_step: name: Check current step number runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - id: get_step run: | - echo "current_step=$(cat ./.github/script/STEP)" >> $GITHUB_OUTPUT + echo "current_step=$(cat ./.github/steps/-step.txt)" >> $GITHUB_OUTPUT outputs: current_step: ${{ steps.get_step.outputs.current_step }} @@ -36,32 +34,31 @@ jobs: needs: get_current_step # We will only run this action when: - # 1. This repository isn't the template repository - # 2. The STEP is currently 1 - # 3. The event is a branch - # 4. The branch name is `my-first-branch` - # Reference https://docs.github.com/en/actions/learn-github-actions/contexts - # Reference https://docs.github.com/en/actions/learn-github-actions/expressions + # 1. This repository isn't the template repository. + # 2. The step is currently 1. + # 3. The event is a branch. + # 4. The branch name is `my-first-branch`. + # Reference: https://docs.github.com/en/actions/learn-github-actions/contexts + # Reference: https://docs.github.com/en/actions/learn-github-actions/expressions if: >- ${{ !github.event.repository.is_template && needs.get_current_step.outputs.current_step == 1 && github.ref_type == 'branch' && github.ref_name == 'my-first-branch' }} - # We'll run Ubuntu for performance instead of Mac or Windows + # We'll run Ubuntu for performance instead of Mac or Windows. runs-on: ubuntu-latest steps: - # We'll need to check out the repository so that we can edit the README + # We'll need to check out the repository so that we can edit the README. - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: - fetch-depth: 0 # Let's get all the branches + fetch-depth: 0 # Let's get all the branches. - # Update README to close
and open
- # and set STEP to '2' + # In README.md, switch step 1 for step 2. - name: Update to step 2 - uses: skills/action-update-step@v1 + uses: skills/action-update-step@v2 with: token: ${{ secrets.GITHUB_TOKEN }} from_step: 1 diff --git a/.github/workflows/2-commit-a-file.yml b/.github/workflows/2-commit-a-file.yml index 8a14817e8..bfa74d828 100644 --- a/.github/workflows/2-commit-a-file.yml +++ b/.github/workflows/2-commit-a-file.yml @@ -1,35 +1,33 @@ name: Step 2, Commit a file -# This step listens for the learner to commit a file to branch `my-first-branch` -# This step sets STEP to 3 -# This step closes
and opens
+# This step listens for the learner to commit a file to branch `my-first-branch`. +# This workflow updates from step 2 to step 3. -# This action will run every time there's a push to `my-first-branch` -# Reference https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows +# This action will run every time there's a push to `my-first-branch`. +# Reference: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows on: workflow_dispatch: push: branches: - my-first-branch -# Reference https://docs.github.com/en/actions/security-guides/automatic-token-authentication +# Reference: https://docs.github.com/en/actions/security-guides/automatic-token-authentication permissions: - # Need `contents: read` to checkout the repository - # Need `contents: write` to update the step metadata + # Need `contents: read` to checkout the repository. + # Need `contents: write` to update the step metadata. contents: write jobs: - # Get the current step from .github/script/STEP so we can - # limit running the main job when the learner is on the same step. + # Get the current step to only run the main job when the learner is on the same step. get_current_step: name: Check current step number runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - id: get_step run: | - echo "current_step=$(cat ./.github/script/STEP)" >> $GITHUB_OUTPUT + echo "current_step=$(cat ./.github/steps/-step.txt)" >> $GITHUB_OUTPUT outputs: current_step: ${{ steps.get_step.outputs.current_step }} @@ -38,28 +36,27 @@ jobs: needs: get_current_step # We will only run this action when: - # 1. This repository isn't the template repository - # 2. The STEP is currently 2 - # Reference https://docs.github.com/en/actions/learn-github-actions/contexts - # Reference https://docs.github.com/en/actions/learn-github-actions/expressions + # 1. This repository isn't the template repository. + # 2. The step is currently 2. + # Reference: https://docs.github.com/en/actions/learn-github-actions/contexts + # Reference: https://docs.github.com/en/actions/learn-github-actions/expressions if: >- ${{ !github.event.repository.is_template && needs.get_current_step.outputs.current_step == 2 }} - # We'll run Ubuntu for performance instead of Mac or Windows + # We'll run Ubuntu for performance instead of Mac or Windows. runs-on: ubuntu-latest steps: - # We'll need to check out the repository so that we can edit the README + # We'll need to check out the repository so that we can edit the README. - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: - fetch-depth: 0 # Let's get all the branches + fetch-depth: 0 # Let's get all the branches. - # Update README to close
and open
- # and set STEP to '3' + # In README.md, switch step 2 for step 3. - name: Update to step 3 - uses: skills/action-update-step@v1 + uses: skills/action-update-step@v2 with: token: ${{ secrets.GITHUB_TOKEN }} from_step: 2 diff --git a/.github/workflows/3-open-a-pull-request.yml b/.github/workflows/3-open-a-pull-request.yml index e0799fc1e..23c636c26 100644 --- a/.github/workflows/3-open-a-pull-request.yml +++ b/.github/workflows/3-open-a-pull-request.yml @@ -1,11 +1,10 @@ name: Step 3, Open a pull request -# This step listens for the learner to open a pull request with branch `my-first-branch` -# This step sets STEP to 4 -# This step closes
and opens
+# This step listens for the learner to open a pull request with branch `my-first-branch`. +# This workflow updates from step 3 to step 4. -# This will run every time we create a branch or tag -# Reference https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows +# This will run every time we create a branch or tag. +# Reference: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows on: workflow_dispatch: pull_request: @@ -13,24 +12,23 @@ on: - opened - reopened -# Reference https://docs.github.com/en/actions/security-guides/automatic-token-authentication +# Reference: https://docs.github.com/en/actions/security-guides/automatic-token-authentication permissions: - # Need `contents: read` to checkout the repository - # Need `contents: write` to update the step metadata + # Need `contents: read` to checkout the repository. + # Need `contents: write` to update the step metadata. contents: write jobs: - # Get the current step from .github/script/STEP so we can - # limit running the main job when the learner is on the same step. + # Get the current step to only run the main job when the learner is on the same step. get_current_step: name: Check current step number runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - id: get_step run: | - echo "current_step=$(cat ./.github/script/STEP)" >> $GITHUB_OUTPUT + echo "current_step=$(cat ./.github/steps/-step.txt)" >> $GITHUB_OUTPUT outputs: current_step: ${{ steps.get_step.outputs.current_step }} @@ -39,31 +37,30 @@ jobs: needs: get_current_step # We will only run this action when: - # 1. This repository isn't the template repository - # 2. The STEP is currently 3 - # 3. The head branch name is `my-first-branch` - # Reference https://docs.github.com/en/actions/learn-github-actions/contexts - # Reference https://docs.github.com/en/actions/learn-github-actions/expressions + # 1. This repository isn't the template repository. + # 2. The step is currently 3. + # 3. The head branch name is `my-first-branch`. + # Reference: https://docs.github.com/en/actions/learn-github-actions/contexts + # Reference: https://docs.github.com/en/actions/learn-github-actions/expressions if: >- ${{ !github.event.repository.is_template && needs.get_current_step.outputs.current_step == 3 && github.head_ref == 'my-first-branch' }} - # We'll run Ubuntu for performance instead of Mac or Windows + # We'll run Ubuntu for performance instead of Mac or Windows. runs-on: ubuntu-latest steps: - # We'll need to check out the repository so that we can edit the README + # We'll need to check out the repository so that we can edit the README. - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: - fetch-depth: 0 # Let's get all the branches - ref: my-first-branch # Important, as normally `pull_request` event won't grab other branches + fetch-depth: 0 # Let's get all the branches. + ref: my-first-branch # Important, as normally `pull_request` event won't grab other branches. - # Update README to close
and open
- # and set STEP to '4' + # In README.md, switch step 3 for step 4. - name: Update to step 4 - uses: skills/action-update-step@v1 + uses: skills/action-update-step@v2 with: token: ${{ secrets.GITHUB_TOKEN }} from_step: 3 diff --git a/.github/workflows/4-merge-your-pull-request.yml b/.github/workflows/4-merge-your-pull-request.yml index 4b46a8904..ae2e4bc65 100644 --- a/.github/workflows/4-merge-your-pull-request.yml +++ b/.github/workflows/4-merge-your-pull-request.yml @@ -1,35 +1,33 @@ name: Step 4, Merge your pull request -# This step listens for the learner to merge a pull request with branch `my-first-branch` -# This step sets STEP to x -# This step closes
and opens
+# This step listens for the learner to merge a pull request with branch `my-first-branch`. +# This workflow updates from step 4 to step X. -# This will run every time we create push a commit to `main` -# Reference https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows +# This will run every time we create push a commit to `main`. +# Reference: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows on: workflow_dispatch: push: branches: - main -# Reference https://docs.github.com/en/actions/security-guides/automatic-token-authentication +# Reference: https://docs.github.com/en/actions/security-guides/automatic-token-authentication permissions: - # Need `contents: read` to checkout the repository - # Need `contents: write` to update the step metadata + # Need `contents: read` to checkout the repository. + # Need `contents: write` to update the step metadata. contents: write jobs: - # Get the current step from .github/script/STEP so we can - # limit running the main job when the learner is on the same step. + # Get the current step to only run the main job when the learner is on the same step. get_current_step: name: Check current step number runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - id: get_step run: | - echo "current_step=$(cat ./.github/script/STEP)" >> $GITHUB_OUTPUT + echo "current_step=$(cat ./.github/steps/-step.txt)" >> $GITHUB_OUTPUT outputs: current_step: ${{ steps.get_step.outputs.current_step }} @@ -38,28 +36,27 @@ jobs: needs: get_current_step # We will only run this action when: - # 1. This repository isn't the template repository - # 2. The STEP is currently 4 - # Reference https://docs.github.com/en/actions/learn-github-actions/contexts - # Reference https://docs.github.com/en/actions/learn-github-actions/expressions + # 1. This repository isn't the template repository. + # 2. The step is currently 4. + # Reference: https://docs.github.com/en/actions/learn-github-actions/contexts + # Reference: https://docs.github.com/en/actions/learn-github-actions/expressions if: >- ${{ !github.event.repository.is_template && needs.get_current_step.outputs.current_step == 4 }} - # We'll run Ubuntu for performance instead of Mac or Windows + # We'll run Ubuntu for performance instead of Mac or Windows. runs-on: ubuntu-latest steps: - # We'll need to check out the repository so that we can edit the README + # We'll need to check out the repository so that we can edit the README. - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: - fetch-depth: 0 # Let's get all the branches + fetch-depth: 0 # Let's get all the branches. - # Update README to close
and open
- # and set STEP to X + # In README.md, switch step 4 for step X. - name: Update to step X - uses: skills/action-update-step@v1 + uses: skills/action-update-step@v2 with: token: ${{ secrets.GITHUB_TOKEN }} from_step: 4 diff --git a/README.md b/README.md index 2d03c3947..79ea84fca 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,25 @@ - # Introduction to GitHub _Get started using GitHub in less than an hour._ - -
-

Welcome

 +## Welcome People use GitHub to build some of the most advanced technologies in the world. Whether you’re visualizing data or building a new game, there’s a whole community and set of tools on GitHub that can help you do it even better. GitHub Skills’ “Introduction to GitHub” course guides you through everything you need to start contributing in less than an hour. @@ -27,249 +27,38 @@ People use GitHub to build some of the most advanced technologies in the world. - **What you'll learn**: We'll introduce repositories, branches, commits, and pull requests. - **What you'll build**: We'll make a short Markdown file you can use as your [profile README](https://docs.github.com/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme). - **Prerequisites**: None. This course is a great introduction for your first day on GitHub. -- **How long**: This course is four steps long and takes less than one hour to complete. - -**Course tips:** - -* Glossary terms will be _emphasised_ and linked to their definition. +- **How long**: This course takes less than one hour to complete. + +In this course, you will: + +1. Create a branch +2. Commit a file +3. Open a pull request +4. Merge your pull request + +### How to start this course + + -## How to start this course +[![start-course](https://user-images.githubusercontent.com/1221423/235727646-4a590299-ffe5-480d-8cd5-8194ea184546.svg)](https://github.com/new?template_owner=skills&template_name=introduction-to-github&owner=%40me&name=skills-introduction-to-github&description=My+clone+repository&visibility=public) 1. Right-click **Start course** and open the link in a new tab. - - [![start-course](https://user-images.githubusercontent.com/1221423/218596841-0645fe1a-4aaf-4f51-9ab3-8aa2d3fdd487.svg)](https://github.com/skills/introduction-to-github/generate) - -2. In the new tab, follow the prompts to create a new repository. - +2. In the new tab, most of the prompts will automatically fill in for you. - For owner, choose your personal account or an organization to host the repository. - - We recommend creating a public repository—private repositories will [use Actions minutes](https://docs.github.com/en/billing/managing-billing-for-github-actions/about-billing-for-github-actions). - - Name the repository something easy for you to recognize and remember. - - ![Create a new repository](/images/create-new-repository.png) - -3. After your new repository is created, wait about 20 seconds, then refresh your new repository page. Follow the step-by-step instructions in the new repository's README. [GitHub Actions](https://docs.github.com/en/actions) will automatically close this welcome and open the first step. - -
- - - -
-

Step 1: Create a branch

 - -_Welcome to "Introduction to GitHub"! :wave:_ - -**What is GitHub?**: GitHub is a collaboration platform that uses _[Git](https://docs.github.com/get-started/quickstart/github-glossary#git)_ for versioning. GitHub is a popular place to share and contribute to [open-source](https://docs.github.com/get-started/quickstart/github-glossary#open-source) software. -
:tv: [Video: What is GitHub?](https://www.youtube.com/watch?v=pBy1zgt0XPc) - -**What is a repository?**: A _[repository](https://docs.github.com/get-started/quickstart/github-glossary#repository)_ is a project containing files and folders. A repository tracks versions of files and folders. For more information, see "[About repositories](https://docs.github.com/en/repositories/creating-and-managing-repositories/about-repositories)" from GitHub Docs. - -**What is a branch?**: A _[branch](https://docs.github.com/en/get-started/quickstart/github-glossary#branch)_ is a parallel version of your repository. By default, your repository has one branch named `main` and it is considered to be the definitive branch. Creating additional branches allows you to copy the `main` branch of your repository and safely make any changes without disrupting the main project. Many people use branches to work on specific features without affecting any other parts of the project. - -Branches allow you to separate your work from the `main` branch. In other words, everyone's work is safe while you contribute. For more information, see "[About branches](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches)". - -**What is a profile README?**: A _[profile README](https://docs.github.com/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme)_ is essentially an "About me" section on your GitHub profile where you can share information about yourself with the community on GitHub.com. GitHub shows your profile README at the top of your profile page. For more information, see "[Managing your profile README](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme)". - -![profile-readme-example](/images/profile-readme-example.png) - -### :keyboard: Activity: Your first branch - -1. Open a new browser tab and navigate to your newly made repository repository. Then, work on the steps in your second tab while you read the instructions in this tab. -2. Navigate to the **< > Code** tab in the header menu of your repository. - - ![code-tab](/images/code-tab.png) - -3. Click on the **main** branch drop-down. - - ![main-branch-dropdown](/images/main-branch-dropdown.png) - -4. In the field, enter a name for your branch: `my-first-branch`. -5. Click **Create branch: my-first-branch** to create your branch. - - ![create-branch-button](/images/create-branch-button.png) - - The branch will automatically switch to the one you have just created. - The **main** branch drop-down bar will reflect your new branch and display the new branch name. - -6. Move on to Step 2! - - **Note**: If you made a public repository, and want to confirm you correctly set up your first branch, wait about 20 seconds then refresh this page (the one you're following instructions from). [GitHub Actions](https://docs.github.com/en/actions) will automatically close this step and open the next one. - -
- - - -
-

Step 2: Commit a file

 - -_You created a branch! :tada:_ - -Creating a branch allows you to edit your project without changing the `main` branch. Now that you have a branch, it’s time to create a file and make your first commit! - -**What is a commit?**: A _[commit](https://docs.github.com/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits)_ is a set of changes to the files and folders in your project. A commit exists in a branch. For more information, see "[About commits](https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits)". - -### :keyboard: Activity: Your first commit - -The following steps will guide you through the process of committing a change on GitHub. A commit records changes in renaming, changing content within, creating a new file, and any other changes made to your project. For this exercise, committing a change requires first adding a new file to your new branch. - -1. On the **< > Code** tab in the header menu of your repository, make sure you're on your new branch `my-first-branch`. - -2. Select the **Add file** drop-down and click **Create new file**. - - ![create new file option](/images/create-new-file.png) - -3. In the **Name your file...** field, enter `PROFILE.md`. - - **Note:** `.md` is a file extension that creates a Markdown file. You can learn more about Markdown by visiting "[Basic writing and formatting syntax](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)" in our docs or by taking the "[Communicating using Markdown](https://github.com/skills/communicate-using-markdown)" Skills course. - -4. In the **Edit new file** area, copy the following content to your file: - - ``` - Welcome to my GitHub profile! - ``` - - profile.md file screenshot - -5. For commits, you can enter a short commit message that describes what changes you made. This message helps others know what's included in your commit. GitHub offers a simple default message, but let's change it slightly for practice. First, enter `Add PROFILE.md` in the first text-entry field below **Commit new file** at the bottom of the page. Then, if you want to confirm what your screen should look like, expand the dropdown below. - -
- Expand to see the screenshot. - screenshot of adding a new file with a commit message -
- -6. In this lesson, we'll ignore the other fields and click **Commit new file**. -7. Move on to Step 3! - - **Note**: Like before, you can wait about 20 seconds, then refresh this page (the one you're following instructions from) and [GitHub Actions](https://docs.github.com/en/actions) will automatically close this step and open the next one. + - We recommend creating a public repository, as private repositories will [use Actions minutes](https://docs.github.com/en/billing/managing-billing-for-github-actions/about-billing-for-github-actions). + - Scroll down and click the **Create repository** button at the bottom of the form. +3. After your new repository is created, wait about 20 seconds, then refresh the page. Follow the step-by-step instructions in the new repository's README. -
- - - -
-

Step 3: Open a pull request

 - -_Nice work making that commit! :sparkles:_ - -Now that you have made a change to the project and created a commit, it’s time to share your proposed change through a pull request! - -**What is a pull request?**: Collaboration happens on a _[pull request](https://docs.github.com/en/get-started/quickstart/github-glossary#pull-request)_. The pull request shows the changes in your branch to other people and allows people to accept, reject, or suggest additional changes to your branch. In a side by side comparison, this pull request is going to keep the changes you just made on your branch and propose applying them to the `main` project branch. For more information about pull requests, see "[About pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" or watch the video linked below. - -### :keyboard: Activity: Create a pull request - -You may have noticed after your commit that a message displayed indicating your recent push to your branch and providing a button that says **Compare & pull request**. - -![screenshot of message and button](/images/compare-and-pull-request.png) - -To create a pull request automatically, click **Compare & pull request**, and then skip to step 6 below. If you don't click the button, the instructions below walk you through manually setting up the pull request. - -1. Click on the **Pull requests** tab in the header menu of your repository. -2. Click **New pull request**. -3. In the **base:** dropdown, make sure **main** is selected. -4. Select the **compare:** dropdown, and click `my-first-branch`. - - screenshot showing both branch selections - -5. Click **Create pull request**. -6. Enter a title for your pull request. By default, the title will automatically be the name of your branch. For this exercise, let's edit the field to say `Add my first file`. -7. The next field helps you provide a description of the changes you made. Here, you can add a description of what you’ve accomplished so far. As a reminder, you have: created a new branch, created a file, and made a commit. - - screenshot showing pull request - -8. Click **Create pull request**. You will automatically be navigated to your new pull request. -9. Move on to Step 4! - - **Note**: Like before, you can wait about 20 seconds, then refresh this page (the one you're following instructions from) and [GitHub Actions](https://docs.github.com/en/actions) will automatically close this step and open the next one. As a perk, you may see evidence of GitHub Actions running on the tab with the pull request opened! The image below shows a line you might see on your pull request after the Action finishes running. - - screenshot of an example of an actions line - -
- - - -
-

Step 4: Merge your pull request

 - -_Nicely done! :sunglasses:_ - -You successfully created a pull request. You can now merge your pull request. - -**What is a merge?**: A _[merge](https://docs.github.com/en/get-started/quickstart/github-glossary#merge)_ adds the changes in your pull request and branch into the `main` branch. For more information about merges, see "[Merging a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)" or watch the video linked below. - -As noted in the previous step, you may have seen evidence of GitHub Actions running which automatically progresses your instructions to the next step. You'll have to wait for it to finish before you can merge your pull request. It will be ready when the merge pull request button is green. - -![screenshot of green merge pull request button](/images/Green-merge-pull-request.png) - -### :keyboard: Activity: Merge the pull request - -1. Click **Merge pull request**. -2. Click **Confirm merge**. -3. Once your branch has been merged, you don't need it anymore. To delete this branch, click **Delete branch**. - - screenshot showing delete branch button - -4. Check out the **Finish** step to see what you can learn next! - - **Note**: Like before, you can wait about 20 seconds, then refresh this page (the one you're following instructions from) and [GitHub Actions](https://docs.github.com/en/actions) will automatically close this step and open the next one. - -
- - - -
-

Finish

 - -_Congratulations, you've completed this course and joined the world of developers!_ - -celebrate - -Here's a recap of your accomplishments: - -- You learned about GitHub, repositories, branches, commits, and pull requests. -- You created a branch, a commit, and a pull request. -- You merged a pull request. -- You made your first contribution! :tada: - -### What's next? - -If you'd like to make a profile README, use the quickstart instructions below or follow the instructions in the [Managing your profile README](https://docs.github.com/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme) article. - -1. Make a new public repository with a name that matches your GitHub username. -2. Create a file named `README.md` in its root. The "root" means not inside any folder in your repository. -3. Edit the contents of the `README.md` file. -4. If you created a new branch for your file, open and merge a pull request on your branch. -5. Lastly, we'd love to hear what you thought of this course [in our discussion board](https://github.com/skills/.github/discussions). - -Check out these resources to learn more or get involved: -- Are you a student? Check out the [Student Developer Pack](https://education.github.com/pack). -- [Take another GitHub Skills course](https://github.com/skills). -- [Read the GitHub Getting Started docs](https://docs.github.com/en/get-started). -- To find projects to contribute to, check out [GitHub Explore](https://github.com/explore). - -
+