diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..8ac6b8c --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,6 @@ +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "monthly" diff --git a/.github/steps/-step.txt b/.github/steps/-step.txt new file mode 100644 index 0000000..573541a --- /dev/null +++ b/.github/steps/-step.txt @@ -0,0 +1 @@ +0 diff --git a/.github/steps/0-welcome.md b/.github/steps/0-welcome.md new file mode 100644 index 0000000..9ff13a5 --- /dev/null +++ b/.github/steps/0-welcome.md @@ -0,0 +1 @@ + diff --git a/.github/steps/1-create-a-pr.md b/.github/steps/1-create-a-pr.md new file mode 100644 index 0000000..5ec7377 --- /dev/null +++ b/.github/steps/1-create-a-pr.md @@ -0,0 +1,20 @@ + + +## Step 1: Create a pull request + +_Welcome to "Managing Merge Conflicts"! :wave:_ + +**What is a _merge conflict_?**: A **merge conflict** occurs when changes are made to the same part of the same file on two different branches. You usually find out about conflicts in a pull request so let's start by creating one. + +### :keyboard: Activity: Create a pull request + +1. Open a new browser tab, and work on the steps in your second tab while you read the instructions in this tab. +1. We made a small change to a file in the repository in the `my-resume` branch. +1. [Create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) setting `my-resume` as the head branch and `main` as the base branch. You can enter `Resolving merge conflicts` for the pull request title and body. +1. 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-resolve-a-merge-conflict.md b/.github/steps/2-resolve-a-merge-conflict.md new file mode 100644 index 0000000..bf817bb --- /dev/null +++ b/.github/steps/2-resolve-a-merge-conflict.md @@ -0,0 +1,27 @@ + + +## Step 2: Resolve a merge conflict + +_Good start! Now let's look deeper at a merge conflict! :mag:_ + +This can be intimidating, but have no fear, Git is smart when it comes to merging! Git only needs a human to decide how to [resolve the conflict](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line). Sometimes, the best way to resolve a merge conflict is to add content that's from both branches, or even something that isn't on either! This is why Git needs a human to look at the code and make the proper fixes. + +### :keyboard: Activity: Resolve a merge conflict + +1. Open the pull request that you just created, we created a conflict for you. Have no fear! +1. At the bottom of the page, under "This branch has conflicts that must be resolved", click the **Resolve conflicts** button. +1. Look for the highlighted sections that begins with `<<<<<<< my-resume` and ends with `>>>>>>> main`. These markers are added by Git to show you the content that is in conflict. +1. Remove the changes made on the main branch by deleting all of the content below the `=======` and above `>>>>>>> main`. +1. Next, remove the merge conflict markers by deleting the following lines: + ``` + <<<<<<< my-resume + ======= + >>>>>>> main + ``` +1. With the merge conflict markers removed, click **Mark as resolved**. +1. Finally, click **Commit merge**. +1. 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-create-your-own-conflict.md b/.github/steps/3-create-your-own-conflict.md new file mode 100644 index 0000000..5e03e21 --- /dev/null +++ b/.github/steps/3-create-your-own-conflict.md @@ -0,0 +1,25 @@ + + +## Step 3: Create your own conflict + +_Good job! You've solved a merge conflict! :tada:_ + +Resolving a conflict doesn't automatically merge the pull request in GitHub. Instead, it stores the resolution of the conflict in a merge commit and allows you and your team to keep working. To resolve a conflict, GitHub performs what is known as a _reverse merge_. This means that the changes from the `main` branch were merged into your `my-resume` branch. With a reverse merge, only the `my-resume` branch is updated. This allows you to test the resolved changes on your branch before you merge it into `main`. + +Now, let's get a little evil. (It's for educational purposes!) + +### :keyboard: Activity: Create your own conflict + +We went ahead and added a new file called `references.md` and pushed that change to `main`, without updating your `my-resume` branch. + +1. Browse to the `my-resume` branch. +1. Click the `Add file` dropdown menu and then on `Create new file`. +1. Create a file named `references.md`. +1. Enter some text that conflicts with what we added for `references.md` in the `main` branch. +1. Scroll to the bottom of the page and enter a commit message for your change. +1. Click the **Commit new file** button, making sure the "Commit directly to the `my-resume` branch" option is selected. +1. 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/4-merge-your-pull-request.md b/.github/steps/4-merge-your-pull-request.md new file mode 100644 index 0000000..0ba1af8 --- /dev/null +++ b/.github/steps/4-merge-your-pull-request.md @@ -0,0 +1,19 @@ + + +## Step 4: Merge your pull request + +_Almost there! :heart:_ + +You can now [merge](https://docs.github.com/en/get-started/quickstart/github-glossary#merge) your pull request! + +### :keyboard: Activity: Merge your pull request + +1. First, resolve any remaining conflicts in your pull request. + > Look back at step one if you need help. +1. Click **Merge pull request**. +1. Delete the branch `my-resume` (optional). +1. 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/X-finish.md b/.github/steps/X-finish.md new file mode 100644 index 0000000..2ad3399 --- /dev/null +++ b/.github/steps/X-finish.md @@ -0,0 +1,24 @@ + + +## Finish + +_Congratulations friend, you've completed this course!_ + +celebrate + +Here's a recap of all the tasks you've accomplished in your repository: + +- You learned why merge conflicts happen. +- You resolved a simple merge conflict. +- You created a merge conflict, and resolved it! + +### What's next? + +- Make your own Markdown resume site with GitHub Pages! Learn how in our [GitHub Pages](https://github.com/skills/github-pages) course. +- We'd love to hear what you thought of this course [in our discussion board](https://github.com/orgs/skills/discussions/categories/resolve-merge-conflicts). +- [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-welcome.yml b/.github/workflows/0-welcome.yml new file mode 100644 index 0000000..48c4c1f --- /dev/null +++ b/.github/workflows/0-welcome.yml @@ -0,0 +1,91 @@ +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_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@v4 + with: + fetch-depth: 0 # Let's get all the branches. + + - name: Prepare a branch + run: | + echo "Make sure we are on step 0" + if [ "$(cat .github/steps/-step.txt)" != 0 ] + then + echo "Current step is not 0" + exit 0 + fi + + echo "Make a branch" + BRANCH=my-resume + git checkout -b $BRANCH + + echo "Update resume.md" + sed -i.bak 's/Experience/Job History/' resume.md + + echo "Make a commit" + git config user.name github-actions[bot] + git config user.email github-actions[bot]@users.noreply.github.com + git add resume.md + git commit --message="Update resume.md in my-resume" + + echo "Push" + git push --set-upstream origin $BRANCH + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + # 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-resume diff --git a/.github/workflows/1-create-a-pr.yml b/.github/workflows/1-create-a-pr.yml new file mode 100644 index 0000000..3edfa17 --- /dev/null +++ b/.github/workflows/1-create-a-pr.yml @@ -0,0 +1,93 @@ +name: Step 1, Create a pull request + +# This step triggers after the learner creates a pull request for the my-resume branch +# This workflow updates from step 1 to step 2. + +# This will run every time we open a pull request. +# Reference: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows +on: + workflow_dispatch: + pull_request: + types: [opened] + +# 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_create_pr: + name: On create PR + 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. + # 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 }} + + # 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@v4 + with: + fetch-depth: 0 # Let's get all the branches. + + - name: Prepare a merge conflict + run: | + echo "Make sure we are on step 1" + if [ "$(cat .github/steps/-step.txt)" != 1 ] + then + echo "Current step is not 1" + exit 0 + fi + + echo "Manually update step in my-resume to match step in main branch" + git checkout my-resume + git config user.name github-actions[bot] + git config user.email github-actions[bot]@users.noreply.github.com + sed -i.bak 's/1/2/' .github/steps/-step.txt + git add .github/steps/-step.txt + git commit --message="Update step in my-resume" + echo "Push" + git push origin my-resume + + echo "Create a merge conflict in main" + git checkout main + sed -i.bak 's/Experience/Jobs/' resume.md + git add resume.md + git commit --message="Update resume.md in main" + + echo "Push" + git push origin main + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + # In README.md, switch step 1 for step 2. + - name: Update to step 2 + uses: skills/action-update-step@v2 + with: + token: ${{ secrets.GITHUB_TOKEN }} + from_step: 1 + to_step: 2 + branch_name: my-resume diff --git a/.github/workflows/2-resolve-a-merge-conflict.yml b/.github/workflows/2-resolve-a-merge-conflict.yml new file mode 100644 index 0000000..c1a2619 --- /dev/null +++ b/.github/workflows/2-resolve-a-merge-conflict.yml @@ -0,0 +1,92 @@ +name: Step 2, Resolve a merge conflict + +# This step triggers after the user resolves the merge conflict. +# This workflow updates from step 2 to step 3. + +# This will run every time we push to `my-resume` (this will be a merge commit +# since the user is resolving a merge conflict) +# Reference: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows +on: + workflow_dispatch: + push: + branches: + - my-resume + +# 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_resolve_merge_conflict: + name: On resolve merge conflict + 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 + 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. + 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@v4 + with: + fetch-depth: 0 # Let's get all the branches. + ref: my-resume + + - name: Create and push a new file on main + run: | + echo "Make sure we are on step 2" + if [ "$(cat .github/steps/-step.txt)" != 2 ] + then + echo "Current step is not 2" + exit 0 + fi + + echo "Checkout main" + git checkout main + + echo "Create new file" + printf "# References\n\n* octocat 1 😈" >> references.md + + echo "Commit file" + git config user.name github-actions[bot] + git config user.email github-actions[bot]@users.noreply.github.com + git add references.md + git commit --message="Add references.md" + + echo "Push" + git push + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + # In README.md, switch step 2 for step 3. + - name: Update to step 3 + uses: skills/action-update-step@v2 + with: + token: ${{ secrets.GITHUB_TOKEN }} + from_step: 2 + to_step: 3 + branch_name: my-resume diff --git a/.github/workflows/3-create-your-own-conflict.yml b/.github/workflows/3-create-your-own-conflict.yml new file mode 100644 index 0000000..05e7432 --- /dev/null +++ b/.github/workflows/3-create-your-own-conflict.yml @@ -0,0 +1,67 @@ +name: Step 3, Create your own conflict + +# This step triggers after the user creates `references.md` in the `my-resume` branch. +# This workflow updates from step 3 to step 4. + +# This will run every time we push to the `reference.md` file in the `my-resume` branch. +# Reference: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows +on: + workflow_dispatch: + push: + branches: + - my-resume + paths: + - "references.md" + +# 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_create_references_md: + name: On create references.md + 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. + # 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 }} + + # 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@v4 + with: + fetch-depth: 0 # Let's get all the branches. + ref: my-resume + + # In README.md, switch step 2 for step 3. + - name: Update to step 4 + uses: skills/action-update-step@v2 + with: + token: ${{ secrets.GITHUB_TOKEN }} + from_step: 3 + to_step: 4 + branch_name: my-resume diff --git a/.github/workflows/4-merge-your-pull-request.yml b/.github/workflows/4-merge-your-pull-request.yml new file mode 100644 index 0000000..7c16ef7 --- /dev/null +++ b/.github/workflows/4-merge-your-pull-request.yml @@ -0,0 +1,64 @@ +name: Step 4, Merge your pull request + +# This step triggers after a pull requst is merged to `main`. +# 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 +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_merge: + name: On merge + 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 + 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. + 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@v4 + with: + fetch-depth: 0 # Let's get all the branches. + + # In README.md, switch step 3 for step X. + - name: Update to step X + uses: skills/action-update-step@v2 + with: + token: ${{ secrets.GITHUB_TOKEN }} + from_step: 4 + to_step: X + branch_name: my-resume diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..773bfd6 --- /dev/null +++ b/.gitignore @@ -0,0 +1,37 @@ +# Compiled source # +################### +*.com +*.class +*.dll +*.exe +*.o +*.so + +# Packages # +############ +# it's better to unpack these files and commit the raw source +# git has its own built in compression methods +*.7z +*.dmg +*.gz +*.iso +*.jar +*.rar +*.tar +*.zip + +# Logs and databases # +###################### +*.log +*.sql +*.sqlite + +# OS generated files # +###################### +.DS_Store +.DS_Store? +._* +.Spotlight-V100 +.Trashes +ehthumbs.db +Thumbs.db diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6c5bc3d --- /dev/null +++ b/LICENSE @@ -0,0 +1,7 @@ +Copyright (c) GitHub, Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..9a6ed76 --- /dev/null +++ b/README.md @@ -0,0 +1,74 @@ +
+ + + +# Resolve merge conflicts + +_Learn why conflicts happen and how to resolve them._ + +
+ + + +## Welcome + +Merge conflicts happen when two people make changes to the same file on GitHub—a common occurrence when you’re working with others. While resolving differences might involve some discussion, merge conflicts don’t have to be scary. This course guides you through the steps to finding the best merge conflict solution, so your team can keep building. + +- **Who is this for**: New developers, new GitHub users, users new to Git, students, managers, teams. +- **What you'll learn**: What merge conflicts are, how you resolve merge conflicts, how to reduce merge conflicts. +- **What you'll build**: We'll work with a short Markdown resume file in this course. +- **Prerequisites**: We recommend taking [Introduction to GitHub](https://github.com/skills/introduction-to-github) prior to this course. +- **How long**: This course takes less than 30 minutes to complete. + +In this course, you will: + +1. Create a pull request +2. Resolve a merge conflict +3. Create a merge conflict +4. Merge your pull request + +### 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=resolve-merge-conflicts&owner=%40me&name=skills-resolve-merge-conflicts&description=My+clone+repository&visibility=public) + +1. Right-click **Start course** and open the link in a new tab. +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, 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. + + diff --git a/resume.md b/resume.md new file mode 100644 index 0000000..e60d7dd --- /dev/null +++ b/resume.md @@ -0,0 +1,23 @@ +# GitHub Teacher + +Charting the knowledge of the Internet, just like Galileo charted the stars. + +## Experience + +### GitHub Trainer + +Teach all things Git, give away all the stickers, ensure world peace. + +### Supportocat + +Provide world class support to customers on the GitHub platform + +## Skills + +### Education + +Developed and maintained various conference talks, online training, and in-person trainings covering various topics including Git, GitHub, and Open Source. + +### Leadership + +Managed multiple asynchronous teams in the development, maintenance, and release of various web applications and websites.