From fbd24ea5e2a46dcee9ebd3a456c57dee397d789c Mon Sep 17 00:00:00 2001 From: Stavros Siamantas Date: Sat, 17 Aug 2024 15:02:48 +0300 Subject: [PATCH] Add content to Git/GitHub Roadmap (all topics covered) (#6626) --- .../git-filter-branch@BKVA6Q7DXemAYjyQOA0nh.md | 10 +++++++++- .../pull-requests@s3MzDYFPMASqiS8UnvWzW.md | 12 ++++++++---- .../pull-requests@x6eILrLCQrVpz4j8uOuy6.md | 10 +++++++++- ...repository-management@lw4zHuhtxIO4kDvbyiVfq.md | 15 ++++++++++++++- .../rewriting-history@sOoC-XxEoIvwKct00oKlX.md | 15 ++++++++++++++- .../content/roadmaps@sxvT2hGko2PDRBoBrCGWD.md | 9 ++++++++- .../saved-replies@dQS1V0zZxeKhHhUo3STBK.md | 12 +++++++++++- .../scheduled-worfklows@uS1H9KoKGNONvETCuFBbz.md | 9 ++++++++- .../secrets-and-env-vars@aflP7oWsQzAr4YPo2LLiQ.md | 13 ++++++++++++- .../setting-up-profile@GS3f1FKFVKT0-GJQrgCm8.md | 13 ++++++++++++- .../staged-changes@mzjtCdpke1ayHcEuS-YUS.md | 7 ++++++- .../content/staging-area@h71Tx3nkfUrnhaqcHlDkQ.md | 12 +++++++++++- .../storing-artifacts@alysXC4b1hGi9ZdQ5-40y.md | 11 ++++++++++- .../content/submodules@fjAFNjNNbPOzme9Uk_fDV.md | 7 ++++++- .../content/tagging@iFJBF-EEnLjQVsFSXjo_i.md | 11 ++++++++++- ...s-within-organization@wydgCxR5VnieBpRolXt8i.md | 13 ++++++++++++- .../undoing-changes@0Yi4cryT2v2SGBjouOas3.md | 7 ++++++- 17 files changed, 166 insertions(+), 20 deletions(-) diff --git a/src/data/roadmaps/git-github/content/git-filter-branch@BKVA6Q7DXemAYjyQOA0nh.md b/src/data/roadmaps/git-github/content/git-filter-branch@BKVA6Q7DXemAYjyQOA0nh.md index 1f22478ba..d061f1a98 100644 --- a/src/data/roadmaps/git-github/content/git-filter-branch@BKVA6Q7DXemAYjyQOA0nh.md +++ b/src/data/roadmaps/git-github/content/git-filter-branch@BKVA6Q7DXemAYjyQOA0nh.md @@ -1 +1,9 @@ -# git filter-branch \ No newline at end of file +# git filter-branch + +You can use `git filter-branch` to rewrite Git revision history by applying custom filters on each revision. + +- Filter types: You can modify trees (e.g., removing a file or running a Perl script) or information about each commit. +- Preserving original data: The command preserves all original commit times, merge information, and other details unless specified otherwise. +- Rewriting specific branches: Only the positive refs mentioned in the command line are rewritten; if no filters are specified, commits are recommitted without changes. + +- [@official@git filter-branch](https://git-scm.com/docs/git-filter-branch) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/pull-requests@s3MzDYFPMASqiS8UnvWzW.md b/src/data/roadmaps/git-github/content/pull-requests@s3MzDYFPMASqiS8UnvWzW.md index 34c89c744..eb87347ab 100644 --- a/src/data/roadmaps/git-github/content/pull-requests@s3MzDYFPMASqiS8UnvWzW.md +++ b/src/data/roadmaps/git-github/content/pull-requests@s3MzDYFPMASqiS8UnvWzW.md @@ -1,9 +1,13 @@ # Pull Requests -A pull request is a proposal to merge a set of changes from one branch into another. In a pull request, collaborators can review and discuss the proposed set of changes before they integrate the changes into the main codebase. Pull requests display the differences, or diffs, between the content in the source branch and the content in the target branch. +You can use GitHub CLI to manage pull requests with the following commands: + +- `gh pr create`: Create a new pull request. +- `gh pr merge`: Merge a pull request into the target branch. +- `gh pr list`: List all pull requests for a repository. +- `gh pr view`: View details of a specific pull request. Visit the following resources to learn more: -- [@official@Creating a pull request](https://docs.github.com/articles/creating-a-pull-request) -- [@article@Pull Requests](https://www.atlassian.com/git/tutorials/making-a-pull-request#:~:text=In%20their%20simplest%20form%2C%20pull,request%20via%20their%20Bitbucket%20account.) -- [@video@GitHub Pull Request in 100 Seconds ](https://youtu.be/8lGpZkjnkt4?si=qbCQ8Uvzn9GN2koL) \ No newline at end of file +- [@official@gh pr](https://cli.github.com/manual/gh_pr) +- [@video@Use GitHub CLI For Command Line Pull Request Management](https://www.youtube.com/watch?v=Ku9_0Mftiic) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/pull-requests@x6eILrLCQrVpz4j8uOuy6.md b/src/data/roadmaps/git-github/content/pull-requests@x6eILrLCQrVpz4j8uOuy6.md index a0d01e5f6..34c89c744 100644 --- a/src/data/roadmaps/git-github/content/pull-requests@x6eILrLCQrVpz4j8uOuy6.md +++ b/src/data/roadmaps/git-github/content/pull-requests@x6eILrLCQrVpz4j8uOuy6.md @@ -1 +1,9 @@ -# Pull Requests \ No newline at end of file +# Pull Requests + +A pull request is a proposal to merge a set of changes from one branch into another. In a pull request, collaborators can review and discuss the proposed set of changes before they integrate the changes into the main codebase. Pull requests display the differences, or diffs, between the content in the source branch and the content in the target branch. + +Visit the following resources to learn more: + +- [@official@Creating a pull request](https://docs.github.com/articles/creating-a-pull-request) +- [@article@Pull Requests](https://www.atlassian.com/git/tutorials/making-a-pull-request#:~:text=In%20their%20simplest%20form%2C%20pull,request%20via%20their%20Bitbucket%20account.) +- [@video@GitHub Pull Request in 100 Seconds ](https://youtu.be/8lGpZkjnkt4?si=qbCQ8Uvzn9GN2koL) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/repository-management@lw4zHuhtxIO4kDvbyiVfq.md b/src/data/roadmaps/git-github/content/repository-management@lw4zHuhtxIO4kDvbyiVfq.md index 93249c51f..4ff6dc5ed 100644 --- a/src/data/roadmaps/git-github/content/repository-management@lw4zHuhtxIO4kDvbyiVfq.md +++ b/src/data/roadmaps/git-github/content/repository-management@lw4zHuhtxIO4kDvbyiVfq.md @@ -1 +1,14 @@ -# Repository management \ No newline at end of file +# Repository management + +Using GitHub CLI for repository management allows you to streamline tasks and work more efficiently. ou can use GitHub CLI to manage repositories with the following commands: + +- `gh repo create`: Create a new repository. +- `gh repo delete`: Delete an existing repository. +- `gh repo visibility`: Change the repository's visibility (public or private). +- `gh repo topic`: Manage topic labels for a repository. + +Visit the following resources to learn more: + +- [@official@gh repo](https://cli.github.com/manual/gh_repo) +- [@article@Efficient GitHub Operations: Simplifying Repository Management using Github CLI](https://dev.to/yutee_okon/efficient-github-operations-simplifying-repository-management-using-github-cli-190l) +- [@video@GitHub CLI (gh) - How to manage repositories more efficiently](https://www.youtube.com/watch?v=BII6ZY2Rnlc) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/rewriting-history@sOoC-XxEoIvwKct00oKlX.md b/src/data/roadmaps/git-github/content/rewriting-history@sOoC-XxEoIvwKct00oKlX.md index 3c255e79f..961ab450e 100644 --- a/src/data/roadmaps/git-github/content/rewriting-history@sOoC-XxEoIvwKct00oKlX.md +++ b/src/data/roadmaps/git-github/content/rewriting-history@sOoC-XxEoIvwKct00oKlX.md @@ -1 +1,14 @@ -# Rewriting History \ No newline at end of file +# Rewriting History + +In certain situations, you might need to modify or remove commits from your Git repository's history. This can be achieved using various methods: + +- `git commit --amend`: Allows you to edit the most recent commit. +- `git rebase`: Replaces one branch with another, preserving the commit history. +- `git filter-branch`: Removes specific commits from a branch without altering the original branch. +- `git push --force`: Updates the remote repository while respecting existing pull requests. + +Rewriting history in Git is typically necessary when: + +- Fixing mistakes: Correcting errors or typos in commit messages. +- Removing sensitive data: Deleting confidential information from commits, like API keys or database credentials. +- Simplifying complex histories: Reorganizing branches to improve clarity and reduce complexity. \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/roadmaps@sxvT2hGko2PDRBoBrCGWD.md b/src/data/roadmaps/git-github/content/roadmaps@sxvT2hGko2PDRBoBrCGWD.md index ec36e36a2..7eff0dcfd 100644 --- a/src/data/roadmaps/git-github/content/roadmaps@sxvT2hGko2PDRBoBrCGWD.md +++ b/src/data/roadmaps/git-github/content/roadmaps@sxvT2hGko2PDRBoBrCGWD.md @@ -1 +1,8 @@ -# Roadmaps \ No newline at end of file +# Roadmaps + +GitHub roadmaps are a feature that helps you visualize and organize plans for your projects, allowing you to create a high-level view of milestones and goals, and collaborate on planning and tracking progress with team members. + +Visit the following resources to learn more: + +- [@official@Customizing the roadmap layout](https://docs.github.com/en/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-roadmap-layout) +- [@video@Learn how to use Project Roadmaps - GitHub Checkout](https://www.youtube.com/watch?v=D80u__nYYWw) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/saved-replies@dQS1V0zZxeKhHhUo3STBK.md b/src/data/roadmaps/git-github/content/saved-replies@dQS1V0zZxeKhHhUo3STBK.md index b281d238a..fdd4bad75 100644 --- a/src/data/roadmaps/git-github/content/saved-replies@dQS1V0zZxeKhHhUo3STBK.md +++ b/src/data/roadmaps/git-github/content/saved-replies@dQS1V0zZxeKhHhUo3STBK.md @@ -1 +1,11 @@ -# Saved Replies \ No newline at end of file +# Saved Replies + +GitHub allows you to save frequently used comments and reuse them when discussing issues or pull requests. + +- Saved replies: You can create pre-written comments that can be easily added to conversations. +- Customization: Saved replies can be edited to fit specific situations, making it easy to tailor your responses. + +Visit the following resources to learn more: + +- [@official@Using saved replies](https://docs.github.com/en/get-started/writing-on-github/working-with-saved-replies/using-saved-replies) +- [@article@Walkthrough: Using Github’s “Saved Replies” to make life consistent and easy](https://prowe214.medium.com/walkthrough-using-githubs-saved-replies-to-make-life-consistent-and-easy-80f23efe6a0) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/scheduled-worfklows@uS1H9KoKGNONvETCuFBbz.md b/src/data/roadmaps/git-github/content/scheduled-worfklows@uS1H9KoKGNONvETCuFBbz.md index 0c8c895c3..d0610fbe8 100644 --- a/src/data/roadmaps/git-github/content/scheduled-worfklows@uS1H9KoKGNONvETCuFBbz.md +++ b/src/data/roadmaps/git-github/content/scheduled-worfklows@uS1H9KoKGNONvETCuFBbz.md @@ -1 +1,8 @@ -# Scheduled Worfklows \ No newline at end of file +# Scheduled Worfklows + +GitHub Actions allows you to schedule workflows to run at specific times or intervals. You can set up workflows to automatically run at predetermined times, such as daily or weekly. + +Visit the following resources to learn more: + +- [@official@Events that trigger workflows - Schedule](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#schedule) +- [@video@GitHub Actions - How to Schedule workflows in GitHub](https://www.youtube.com/watch?v=StipNrK__Gk) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/secrets-and-env-vars@aflP7oWsQzAr4YPo2LLiQ.md b/src/data/roadmaps/git-github/content/secrets-and-env-vars@aflP7oWsQzAr4YPo2LLiQ.md index 438874956..c53f2f894 100644 --- a/src/data/roadmaps/git-github/content/secrets-and-env-vars@aflP7oWsQzAr4YPo2LLiQ.md +++ b/src/data/roadmaps/git-github/content/secrets-and-env-vars@aflP7oWsQzAr4YPo2LLiQ.md @@ -1 +1,12 @@ -# Secrets and Env Vars \ No newline at end of file +# Secrets and Env Vars + +GitHub provides features to securely store and manage sensitive data, such as secrets and environment variables. + +- Secrets: These are sensitive values that should not be committed to a repository, like API keys or database credentials. +- Environment Variables: They can be used to set values for your workflow or application, making it easier to manage dependencies. + +Visit the following resources to learn more: + +- [@official@Using secrets in GitHub Actions](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions) +- [@official@Store information in variables](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables) +- [@video@Secrets and Environment Variables in your GitHub Action](https://www.youtube.com/watch?v=dPLPSaFqJmY) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/setting-up-profile@GS3f1FKFVKT0-GJQrgCm8.md b/src/data/roadmaps/git-github/content/setting-up-profile@GS3f1FKFVKT0-GJQrgCm8.md index dd238f899..d21bdf51b 100644 --- a/src/data/roadmaps/git-github/content/setting-up-profile@GS3f1FKFVKT0-GJQrgCm8.md +++ b/src/data/roadmaps/git-github/content/setting-up-profile@GS3f1FKFVKT0-GJQrgCm8.md @@ -1 +1,12 @@ -# Setting up Profile \ No newline at end of file +# Setting up Profile + +On GitHub, creating a profile is an essential step in showcasing yourself as a developer or contributor. + +- Sharing information: Your profile page allows others to find out more about you, including your interests and skills. +- Showcasing projects: You can display your notable projects and contributions, giving a glimpse into your work experience. +- Expressing identity: The profile also serves as an opportunity for personal expression, allowing you to convey your unique personality and style within the GitHub community. + +Visit the following resources to learn more: + +- [@official@Setting up your profile](https://docs.github.com/en/get-started/start-your-journey/setting-up-your-profile) +- [@video@GitHub Profile Readme](https://www.youtube.com/watch?v=KhGWbt1dAKQ) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/staged-changes@mzjtCdpke1ayHcEuS-YUS.md b/src/data/roadmaps/git-github/content/staged-changes@mzjtCdpke1ayHcEuS-YUS.md index 5ead195b0..efa078b30 100644 --- a/src/data/roadmaps/git-github/content/staged-changes@mzjtCdpke1ayHcEuS-YUS.md +++ b/src/data/roadmaps/git-github/content/staged-changes@mzjtCdpke1ayHcEuS-YUS.md @@ -1,3 +1,8 @@ # Staged Changes -To view the changes you've staged with `git add`, but not yet committed, use `git diff --cached`. This command compares the staged files against their original versions in the repository. It's a quick way to review what you're about to commit before finalizing it. \ No newline at end of file +To view the changes you've staged with `git add`, but not yet committed, use `git diff --cached`. This command compares the staged files against their original versions in the repository. It's a quick way to review what you're about to commit before finalizing it. + +Visit the following resources to learn more: + +- [@article@What does Staged Changes mean in Git?](https://dillionmegida.com/p/staged-changes-in-git/) +- [@video@What are Staged Changes in Git?](https://www.youtube.com/watch?v=HyeNfWZBut8) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/staging-area@h71Tx3nkfUrnhaqcHlDkQ.md b/src/data/roadmaps/git-github/content/staging-area@h71Tx3nkfUrnhaqcHlDkQ.md index 2b277ff4d..621bb5551 100644 --- a/src/data/roadmaps/git-github/content/staging-area@h71Tx3nkfUrnhaqcHlDkQ.md +++ b/src/data/roadmaps/git-github/content/staging-area@h71Tx3nkfUrnhaqcHlDkQ.md @@ -1 +1,11 @@ -# Staging Area \ No newline at end of file +# Staging Area + +In Git, a staging area serves as an intermediate step between your local repository changes and the actual commit. + +- Temporary storage: The staging area holds changes that are intended to be part of the next commit. +- Previewing changes: It allows you to preview your changes before committing them. + +Visit the following resources to learn more: + +- [@official@Getting Started - What is Git? - Staging Area](https://git-scm.com/book/en/v2/Getting-Started-What-is-Git%3F#:~:text=The%20staging%20area%20is%20a,area%E2%80%9D%20works%20just%20as%20well.) +- [@video@What are Staged Changes in Git?](https://www.youtube.com/watch?v=HyeNfWZBut8) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/storing-artifacts@alysXC4b1hGi9ZdQ5-40y.md b/src/data/roadmaps/git-github/content/storing-artifacts@alysXC4b1hGi9ZdQ5-40y.md index a4a6dd5bd..a8383dc6b 100644 --- a/src/data/roadmaps/git-github/content/storing-artifacts@alysXC4b1hGi9ZdQ5-40y.md +++ b/src/data/roadmaps/git-github/content/storing-artifacts@alysXC4b1hGi9ZdQ5-40y.md @@ -1 +1,10 @@ -# Storing Artifacts \ No newline at end of file +# Storing Artifacts + +GitHub provides a feature for storing artifacts, which allows you to upload build outputs or other files as part of your workflow. + +- Artifacts: These are files generated by a job, such as compiled binaries, test reports, or logs. They can be used to validate the results of a build or deployment. +- Referenceable storage: Artifacts are stored in a referenceable way, making it easy to access and use them in future builds. + +Visit the following resources to learn more: + +- [@official@Storing and sharing data from a workflow](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/storing-and-sharing-data-from-a-workflow) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/submodules@fjAFNjNNbPOzme9Uk_fDV.md b/src/data/roadmaps/git-github/content/submodules@fjAFNjNNbPOzme9Uk_fDV.md index cdb5f01c6..b6d8f5d51 100644 --- a/src/data/roadmaps/git-github/content/submodules@fjAFNjNNbPOzme9Uk_fDV.md +++ b/src/data/roadmaps/git-github/content/submodules@fjAFNjNNbPOzme9Uk_fDV.md @@ -1 +1,6 @@ -# Submodules \ No newline at end of file +# Submodules + +In Git, submodules allow you to include another repository within a project. This feature enables the management of external dependencies as part of the main project. + +- Including external repositories: Submodules can be used to include other Git repositories within your project. +- Managing dependencies: They provide a way to manage and track changes in external dependencies. \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/tagging@iFJBF-EEnLjQVsFSXjo_i.md b/src/data/roadmaps/git-github/content/tagging@iFJBF-EEnLjQVsFSXjo_i.md index 1f3d9c9be..e4361bf65 100644 --- a/src/data/roadmaps/git-github/content/tagging@iFJBF-EEnLjQVsFSXjo_i.md +++ b/src/data/roadmaps/git-github/content/tagging@iFJBF-EEnLjQVsFSXjo_i.md @@ -1 +1,10 @@ -# Tagging \ No newline at end of file +# Tagging + +In Git, tags are used to identify specific points in a repository's history as being important. This feature allows developers to mark release points or milestones. + +- Marking release points: Tags are typically used to mark release versions (e.g., v1.0, v2.0) of a project. +- Types of tags: There are different types of tags, including lightweight and annotated tags. + +Visit the following resources to learn more: + +- [@official@Git Basics - Tagging](https://git-scm.com/book/en/v2/Git-Basics-Tagging) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/teams-within-organization@wydgCxR5VnieBpRolXt8i.md b/src/data/roadmaps/git-github/content/teams-within-organization@wydgCxR5VnieBpRolXt8i.md index 8f4200e28..5bcce457e 100644 --- a/src/data/roadmaps/git-github/content/teams-within-organization@wydgCxR5VnieBpRolXt8i.md +++ b/src/data/roadmaps/git-github/content/teams-within-organization@wydgCxR5VnieBpRolXt8i.md @@ -1 +1,12 @@ -# Teams within Organization \ No newline at end of file +# Teams within Organization + +GitHub Organizations allow you to create teams within your organization, which helps in organizing members based on their roles and responsibilities. + +- Grouping: Team members can be grouped together according to the company or group's structure. +- Access permissions: Access permissions can be cascaded from one team member to another. +- Mentions: Team mentions allow for easy referencing of specific teams in repository discussions. + +Visit the following resources to learn more: + +- [@offiicial@Organizing members into teams](https://docs.github.com/en/organizations/organizing-members-into-teams) +- [@article@Best practices for organizations and teams using GitHub Enterprise Cloud](https://github.blog/enterprise-software/devops/best-practices-for-organizations-and-teams-using-github-enterprise-cloud/) \ No newline at end of file diff --git a/src/data/roadmaps/git-github/content/undoing-changes@0Yi4cryT2v2SGBjouOas3.md b/src/data/roadmaps/git-github/content/undoing-changes@0Yi4cryT2v2SGBjouOas3.md index 2af22b33c..93ba8ed51 100644 --- a/src/data/roadmaps/git-github/content/undoing-changes@0Yi4cryT2v2SGBjouOas3.md +++ b/src/data/roadmaps/git-github/content/undoing-changes@0Yi4cryT2v2SGBjouOas3.md @@ -1 +1,6 @@ -# Undoing Changes \ No newline at end of file +# Undoing Changes + +If mistakes or unwanted changes have been committed to your Git repository, there are ways to correct them. Two common methods for reverting changes include: + +- Git Reset: Resets the branch to a previous commit. +- Git Revert: Creates a new commit that reverts specified changes. \ No newline at end of file