Skip to content

Added Week-4 Tasks#373

Merged
LondheShubham153 merged 3 commits intoTrainWithShubham:masterfrom
Amitabh-DevOps:week4
Feb 12, 2025
Merged

Added Week-4 Tasks#373
LondheShubham153 merged 3 commits intoTrainWithShubham:masterfrom
Amitabh-DevOps:week4

Conversation

@Amitabh-DevOps
Copy link
Contributor

@Amitabh-DevOps Amitabh-DevOps commented Feb 11, 2025

Summary by CodeRabbit

  • New Features

    • Introduced a comprehensive Week 4 challenge on Git and GitHub. Users can now practice essential commands such as forking, cloning, repository initialization, remote configuration with security best practices, branching, merging, and even explore advanced SSH authentication.
  • Documentation

    • Removed the primary project overview document, so installation instructions and usage guidelines previously available in a single consolidated resource are no longer present.

@coderabbitai
Copy link

coderabbitai bot commented Feb 11, 2025

Walkthrough

This update introduces a new Week 4 challenge guide focused on Git and GitHub basics. The guide details a series of tasks including forking and cloning a repository, initializing and configuring a local Git repository with Personal Access Tokens (PAT), branch management, committing changes, and optional conflict resolution with bonus SSH authentication instructions. Additionally, the project's primary README file has been removed, affecting the overall documentation access.

Changes

File(s) Change Summary
2025/git/01_Git_and_Github_Basics/README.md Added a comprehensive Week 4 challenge covering forking, cloning, repo initialization, remote configuration with PAT, branch operations, merge conflict resolution, and bonus SSH authentication.
2025/git/README.md Removed the file, eliminating the project's top-level documentation resource.

Sequence Diagram(s)

sequenceDiagram
    participant User as User
    participant GH as GitHub
    participant LR as Local Repository

    User->>GH: Fork repository
    User->>GH: Clone repository
    User->>LR: Initialize repository & create intro file
    User->>LR: Configure remote (PAT/SSH)
    User->>LR: Create branch & commit changes
    User->>GH: Push changes
    GH->>User: Provide merge/conflict review
Loading

Poem

I'm Bunny the coder, hopping with delight,
In a world of branches and commits so light.
I fork, clone, and push with glee,
PAT keys and SSH, set me free!
A skip, a hop, in Git's grand maze,
I'm a CodeRabbit celebrating these coding days!


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (2)
2025/git/01_Git_and_Github_Basics/README.md (2)

3-3: Add missing comma for better readability.

Add a comma after "In this task" for proper sentence structure.

-Welcome to the Week 4 Challenge! In this task you will practice the essential Git and GitHub commands and concepts taught by Shubham Bhaiya.
+Welcome to the Week 4 Challenge! In this task, you will practice the essential Git and GitHub commands and concepts taught by Shubham Bhaiya.
🧰 Tools
🪛 LanguageTool

[typographical] ~3-~3: It appears that a comma is missing.
Context: ...elcome to the Week 4 Challenge! In this task you will practice the essential Git and...

(DURING_THAT_TIME_COMMA)


180-182: Specify language for code block.

Add language specification to the fenced code block for better formatting.

-```
+```text
 Week 4 Challenge - DevOps Batch 9: Git & GitHub Advanced Challenge
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

180-180: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7350ed4 and e984c0d.

📒 Files selected for processing (2)
  • 2025/git/01_Git_and_Github_Basics/README.md (1 hunks)
  • 2025/git/README.md (0 hunks)
💤 Files with no reviewable changes (1)
  • 2025/git/README.md
🧰 Additional context used
🪛 LanguageTool
2025/git/01_Git_and_Github_Basics/README.md

[typographical] ~3-~3: It appears that a comma is missing.
Context: ...elcome to the Week 4 Challenge! In this task you will practice the essential Git and...

(DURING_THAT_TIME_COMMA)


[uncategorized] ~179-~179: Possible missing comma found.
Context: ...o the main repository. - Use a clear title such as: ``` Week 4 Challenge...

(AI_HYDRA_LEO_MISSING_COMMA)

🪛 markdownlint-cli2 (0.17.2)
2025/git/01_Git_and_Github_Basics/README.md

180-180: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

🔇 Additional comments (5)
2025/git/01_Git_and_Github_Basics/README.md (5)

5-8: Well-structured overview of Git concepts!

The overview effectively covers essential Git operations and commands.


27-29: Verify the directory path exists.

The hardcoded path 2025/git/01_Git_and_Github_Basics might not exist if the repository structure changes. Consider:

  1. Adding a note to verify the path
  2. Using relative paths
-     cd 2025/git/01_Git_and_Github_Basics
+     # Navigate to the challenge directory (path may vary based on repository structure)
+     cd path/to/challenge/directory

91-131: Well-structured Git operations guide!

The progression from basic commands to advanced concepts like merge conflicts is excellent. The optional challenge provides good learning opportunities.


134-143: Excellent documentation requirements!

The documentation task effectively combines practical experience with theoretical understanding of branching strategies.


146-169: Comprehensive SSH setup guide!

The bonus task provides clear instructions and follows security best practices for SSH authentication.

Comment on lines +64 to +77
1. **Configure Remote URL with Your PAT:**
To avoid entering your Personal Access Token (PAT) every time you push or pull, update your remote URL to include your credentials.

**⚠️ Note:** Embedding your PAT in the URL is only for this exercise. It is not recommended for production use.

Replace `<your-username>`, `<your-PAT>`, and `<repository-name>` with your actual GitHub username, your PAT, and the repository name respectively:

```bash
git remote add origin https://<your-username>:<your-PAT>@github.com/<your-username>/90DaysOfDevOps.git
```
If a remote named `origin` already exists, update it with:
```bash
git remote set-url origin https://<your-username>:<your-PAT>@github.com/<your-username>/90DaysOfDevOps.git
```
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Enhance security warning for PAT usage.

While there's a warning about PAT in URLs, consider strengthening the security guidance:

  1. Recommend using credential helpers instead
  2. Emphasize PAT security best practices

Add these security notes:

   **⚠️ Note:** Embedding your PAT in the URL is only for this exercise. It is not recommended for production use.  
+  
+  For better security:
+  - Use Git credential helpers to store credentials securely
+  - Never commit or share your PAT
+  - Set appropriate PAT permissions and expiration
+  - Consider using SSH authentication (covered in bonus task)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
1. **Configure Remote URL with Your PAT:**
To avoid entering your Personal Access Token (PAT) every time you push or pull, update your remote URL to include your credentials.
**⚠️ Note:** Embedding your PAT in the URL is only for this exercise. It is not recommended for production use.
Replace `<your-username>`, `<your-PAT>`, and `<repository-name>` with your actual GitHub username, your PAT, and the repository name respectively:
```bash
git remote add origin https://<your-username>:<your-PAT>@github.com/<your-username>/90DaysOfDevOps.git
```
If a remote named `origin` already exists, update it with:
```bash
git remote set-url origin https://<your-username>:<your-PAT>@github.com/<your-username>/90DaysOfDevOps.git
```
1. **Configure Remote URL with Your PAT:**
To avoid entering your Personal Access Token (PAT) every time you push or pull, update your remote URL to include your credentials.
**⚠️ Note:** Embedding your PAT in the URL is only for this exercise. It is not recommended for production use.
For better security:
- Use Git credential helpers to store credentials securely
- Never commit or share your PAT
- Set appropriate PAT permissions and expiration
- Consider using SSH authentication (covered in bonus task)
Replace `<your-username>`, `<your-PAT>`, and `<repository-name>` with your actual GitHub username, your PAT, and the repository name respectively:

@LondheShubham153 LondheShubham153 merged commit cd7d107 into TrainWithShubham:master Feb 12, 2025
1 check passed
@coderabbitai coderabbitai bot mentioned this pull request May 31, 2025
@coderabbitai coderabbitai bot mentioned this pull request Aug 14, 2025
@coderabbitai coderabbitai bot mentioned this pull request Oct 13, 2025
This was referenced Oct 20, 2025
@coderabbitai coderabbitai bot mentioned this pull request Nov 19, 2025
@coderabbitai coderabbitai bot mentioned this pull request Dec 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants