Added CI/CD topic outline with guided practice and examples - #2676
Conversation
Added success and failure pipeline screenshots for guided practice.
Added guided practice steps with GitHub Actions workflow navigation and included success/failure screenshots.
daaimah123
left a comment
daaimah123
left a comment
There was a problem hiding this comment.
🚀 @Ketandora Thank you for eagerly addressing this issue, please kindly respond to my comments in the request for changes threads below, as per our contributor guidelines and indicate how they have been addressed in your newly pushed up code in response to the request for changes.
When addressing requests for changes it is best practice to do so in a visible and tangible way. You can do this by:
- Acknowledging each request for change (i.e. feedback was marked with an emoji reaction to show its accepted).
- Provide a written response to the request for changes in one of the following ways:
- summary comment addressing each individual request for change stating how and where (the commit hash referenced) you made the change
- reply to each comments generated via GitHub in your generated request for change
- share an alternative thought with explanation of why you do not wish to implement the request for change or ask any clarifying questions
- Once actively stating how you've addressed a request for change alongside referencing the hash in which the change was made, mark the comment as "resolved".
I especially want to call out this best practice because it will be extremely important when you work on a development team and have multiple request for changes from several reviewers. It helps everyone in the code review understand what has been iterated on, what remains outstanding, and even gives opportunity to provide any missing context to one another. Please ensure that you do this going forward when contributing in this repo. 🙏🏾
👉🏾 I will continue your PR review once I have seen that these things are completed.
There was a problem hiding this comment.
Remove this image and new folder completely. Create a new directory in electives called ci-cd where you can add the images and ci-cd.md file
There was a problem hiding this comment.
Remove this image and new folder completely. Create a new directory in electives called ci-cd where you can add the images and ci-cd.md file
There was a problem hiding this comment.
Move this file to your new ci-cd folder completely alongside the respective images. You will need to make sure to update their reference lines within this file.
| Before getting into CI/CD, we need to have a basic understanding of how software development works. Nothing too advanced but a few foundational concepts make it much easier to understand how CI/CD fits. | ||
|
|
||
| First, you should have a basic idea of programming and how applications are built. Like, you don’t need to be an expert developer, but at least understand that developers write code to create applications such as websites or mobile apps. This gives you context for what exactly is being tested and deployed in CI/CD. | ||
|
|
||
| Next, understanding Git and GitHub is very important. CI/CD pipelines usually start when code is pushed to a repository. So you should know simple things like what a repository is, what committing and pushing code means, and how developers collaborate using version control. | ||
| For example, when a developer pushes code to GitHub, that action can automatically trigger a CI/CD pipeline. | ||
|
|
||
| You should also have a basic understanding of testing. You don’t need to know all types of testing in detail, but you should understand why testing is important. Code can have bugs, and testing helps catch those issues before the code reaches users. In CI/CD, testing is a critical step, and if tests fail, the pipeline usually stops. | ||
|
|
||
| Another helpful concept is a high-level understanding of the Software Development Life Cycle (SDLC). This includes knowing that software goes through stages like planning, development, testing, and deployment. CI/CD mainly fits into the testing and deployment stages, helping automate those parts of the process. | ||
|
|
||
| Also, having a basic familiarity with the command line (terminal) is useful. Many CI/CD tools run scripts and commands in the background, so knowing simple commands can help you understand what’s happening behind the scenes. | ||
|
|
||
| Overall, these prerequisites are important because they help you understand how code moves from development to deployment in an automated way. CI/CD is not a separate concept it builds on these basics and connects them into a smooth and automated workflow. |
There was a problem hiding this comment.
Remove these paragraphs and provide descriptive links to previous curriculum lessons (see here for an example).
| -Code conflicts | ||
| -Unexpected bugs | ||
| -Broken features | ||
| -A lot of manual checking |
There was a problem hiding this comment.
| -Code conflicts | |
| -Unexpected bugs | |
| -Broken features | |
| -A lot of manual checking | |
| - Code conflicts | |
| - Unexpected bugs | |
| - Broken features | |
| - A lot of manual checking |
Since this is markdown formatting, please ensure that all dash-marks have a space in between them, especially when seeking to utilize unordered bullets. Without this space, they will remain to appear as - rather than bulleted list symbols
There are many sections within this topic outline that will also need this same update. Please ensure that they are subsequently updated as well.
| Now go back to the **Actions tab** and open the latest run again. | ||
|
|
||
| When the file name is changed, the pipeline fails at the file check step: | ||
|  |
There was a problem hiding this comment.
you will need to update this reference when you create your new folder and add the assets and markdown file to it
|
|
||
| To check whether the concepts of CI/CD are clearly understood, learners should be able to answer questions that go beyond simple definitions and reflect real understanding. | ||
|
|
||
| ### Basic Understanding |
There was a problem hiding this comment.
| ### Basic Understanding | |
| ### Reflective questions |
Implemented requested folder restructuring, updated file references, removed deprecated assets, and corrected all requested markdown revisions.
|
Implemented all requested revisions in the latest commits, including:
Thank you for the detailed feedback. Please re-review the updated PR and let me know if any additional changes are needed to better align with project expectations. |
|
Hi @Ketandora thanks so much for the changes in the future, you should reply to each respective comment with a request for change with a comment (and commit hash reference) stating how the request for change was done. Rather than doing this, you provided a single comment, leaving the request for change comments unaddressed in communication. Please remember to do this in the future. Great job with the contributions! |
|
Hi @daaimah123, I noticed that the collaborator invitation has expired on my end. Could you please resend it when you get a chance? Thank you! |
|
@Ketandora here is the invitation link again. |
|
@daaimah123 Thank you! |
ionfwsrijan
added
priority
ionfwsrijan
removed
good first issue
ionfwsrijan
removed
gssoc:approved
3 participants
Fixes #2593
Description
This PR adds a structured CI/CD topic under the electives section.
It includes:
Changes Made
Type of Change
Acceptance Criteria
How to Test