diff --git a/README.md b/README.md index 888479e2982f063fa1b7f37d1d6027add517f007..6350c31ede3660eae5089cfd17f3e1ea45f8b928 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,29 @@ -# CI/CD Debugging Exercises +# CI/CD Debugging Adventures 🧙♂️✨ -Welcome!This repository contains 5 CI/CD pipeline exercises, each with intentional mistakes or misconfigurations for you to debug.Your goal: Identify and fix all issues so that each pipeline runs successfully. +Greetings, aspiring wizard! You've stumbled upon a magical repository filled with 5 CI/CD pipeline exercises, each containing enchanted misconfigurations and mischievous bugs. Your quest: to identify and vanquish these issues, ensuring that each pipeline runs smoothly and your magic flows unhindered. -## How to use this repository +## How to embark on your journey -1. Fork the repo. You will need to run pipelines under your own GitLab project. -2. Clone your Fork -3. Start Debugging! +1. **Fork the Repository**: Channel your inner wizard and fork this repo to your own GitLab project. +2. **Clone Your Fork**: Summon the repository to your local machine. +3. **Begin Debugging**: Let the debugging magic begin! 🧙♀️ +Delve into the `.gitlab-ci.yml` file and explore the enchanted folders for each exercise. Start with **Exercise 1** and progress through to **Exercise 5**. Each task will challenge you with various magical dilemmas—syntax errors, misdirected paths, missing incantations, and faulty logic. -Check the `.gitlab-ci.yml` file and each exercise folder. Start with Exercise 1 and work your way through Exercise 5. -Each exercise may contain multiple issues (syntax errors, wrong paths, missing keywords, job logic issues, etc.). +## Requirements for your mystical journey +* A **GitLab account** with permission to run pipelines. +* Basic knowledge of **CI/CD**, **Git**, and **YAML syntax** (even wizards need the basics!). +* (Optional) **Docker** installed locally if you wish to test your spells before casting them in the cloud. -## Prerequisites +## The Exercises You'll Conquer -* A GitLab account with permissions to run pipelines -* Basic knowledge of: CI/CD, Git and YAML syntax -* (Optional) Docker installed locally if you want to experiment before pushing changes +1. **Linting** 🧹 – Banish misformated spells (code) and make them shine. +2. **Testing** 🔮 – Ensure your spells (tests) are cast correctly with perfect coverage. +3. **Building** ⚡ – Craft and containerize your magic into usable forms. +4. **Secrets** 🗝️ – Guard your most powerful incantations (secrets) securely. +5. **Docs** 📜 – Document your magical creations for others to understand and admire. - -## Exercises Overview - -1. Linting -2. Testing -3. Building -4. Secrets -5. Docs +May your debugging prowess guide you through this adventure! 🧙♂️✨ *** - - -## License -For open source projects, say how it is licensed. diff --git a/case-3-build/README.md b/case-3-build/README.md index c90030e480d86ca375a7e67d567405057b38f438..a15c4de82cbc43aad15a52daba9de206d24bceb7 100644 --- a/case-3-build/README.md +++ b/case-3-build/README.md @@ -5,7 +5,7 @@ In this task, you need to fix the issues in the CI/CD pipeline, Python script, a If you're able to pull and run the Docker container locally, extra kudos to you! 🎉 ## Important Notes: -- **Don’t forget** to uncomment the corresponding case section in the `.gitlab-ci.yml` file. +- Don’t forget to uncomment the corresponding case section in the `.gitlab-ci.yml` file. - Verify that the correct stages are specified in the configuration files. Good luck, wizard! 🧙♂️✨