From 4b1ae2f67c8adb7ff5fee28592590df68be24d5d Mon Sep 17 00:00:00 2001 From: wep23441 <elizabeth.mamtsits@stfc.ac.uk> Date: Thu, 27 Mar 2025 12:01:45 +0100 Subject: [PATCH] new readmes more --- case-1-lint/README.md | 15 +++++++++------ case-2-test/README.md | 13 ++++++++----- case-3-build/README.md | 15 ++++++++++----- 3 files changed, 27 insertions(+), 16 deletions(-) diff --git a/case-1-lint/README.md b/case-1-lint/README.md index 3cc3b43..9afee14 100644 --- a/case-1-lint/README.md +++ b/case-1-lint/README.md @@ -1,8 +1,11 @@ -### Task Case 1 Lint: -Fix the issues in the CI/CD pipeline and Python script by editing the files -within the `case-1-lint/` and and the corresponding CI jobs in `ci-configs/case-1-lint/` folders. Ensure the pipeline -runs successfully and the Python code adheres to linting and formatting standards. +# Task Case 1 Lint -## Dont forget to uncomment the corresponding case section in the `.gitlab-ci.yml`, as well as correct stages specified! +In this task, you are required to fix the issues in the CI/CD pipeline and the Python script. You will need to edit the files in the `case-1-lint/` directory and the corresponding CI jobs in the `ci-configs/case-1-lint/` directory. Ensure that the pipeline runs successfully and that the Python code adheres to linting and formatting standards. -Try to run the code locally beofore and after, chekc that it is working even in the not linted version. \ No newline at end of file +## Important Notes: +- **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. + +Additionally, make sure to test the code both **before** and **after** applying the linting fixes to ensure everything is working, even in the non-linted version. + +Good luck, wizard! 🧙♂️✨ diff --git a/case-2-test/README.md b/case-2-test/README.md index 8a7e0b0..80d1d96 100644 --- a/case-2-test/README.md +++ b/case-2-test/README.md @@ -1,6 +1,9 @@ -### Task Case 2 Test: -Fix the issues in the CI/CD pipeline and Python script by editing the files -within the `case-2-test/` and the corresponding CI jobs in `ci-configs/case-2-test/` folders. Ensure the pipeline -runs successfully and the Python code adheres to linting and formatting standards. +# Task Case 2 Test -## Dont forget to uncomment the corresponding case section in the `.gitlab-ci.yml`, as well as correct stages specified! \ No newline at end of file +In this task, you need to fix the issues in the CI/CD pipeline and the Python script. Edit the files in the `case-2-test/` directory and the corresponding CI jobs in the `ci-configs/case-2-test/` directory. Ensure the pipeline runs successfully and that the tests are executed with good coverage. + +## Important Notes: +- **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! 🧙♂️✨ diff --git a/case-3-build/README.md b/case-3-build/README.md index f5853bf..c90030e 100644 --- a/case-3-build/README.md +++ b/case-3-build/README.md @@ -1,6 +1,11 @@ -### Task Case 3 Build: -Fix the issues in the CI/CD pipeline and Python script by editing the files -within the `case-3-build/` and the corresponding CI jobs in `ci-configs/case-3-build/` folders, as well as the `Dockerfile` in the root of the repo. Ensure the pipeline -runs successfully and the Python code adheres to linting and formatting standards. +# Task Case 3 Build -## Dont forget to uncomment the corresponding case section in the `.gitlab-ci.yml`, as well as correct stages specified! \ No newline at end of file +In this task, you need to fix the issues in the CI/CD pipeline, Python script, and `Dockerfile`. Edit the files in the `case-3-build/` directory and the corresponding CI jobs in the `ci-configs/case-3-build/` directory. Additionally, update the `Dockerfile` located in the root of the repository. Ensure the pipeline runs successfully, and that you can see the `Dockerfile` in the GitLab container registry. + +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. +- Verify that the correct stages are specified in the configuration files. + +Good luck, wizard! 🧙♂️✨ -- GitLab