docs: Fix GitHub Actions workflow and repository structure

- Renamed .github/README.md to .github/CI_CD_SETUP.md to prevent GitHub from displaying the wrong README - Updated references in the main README.md to point to the new CI/CD documentation file - Followed best practices by keeping poetry.lock in version control for reproducible builds These changes ensure that the correct README is displayed on the repository homepage and that the CI pipeline can successfully install dependencies and run tests on all branches.
opencitations · Feb 27, 2025 · 8369d07 · 8369d07
1 parent 3975f9c
commit 8369d07
Show file tree

Hide file tree

Showing 3 changed files with 307 additions and 316 deletions.
diff --git a/.github/README.md → .github/CI_CD_SETUP.md b/.github/README.md → .github/CI_CD_SETUP.md
diff --git a/README.md b/README.md
@@ -440,4 +440,4 @@ The project is configured with GitHub Actions to automatically run tests on ever
 - Uploads coverage reports as artifacts for all branches
 - Generates a coverage badge for each branch
 
-For more details on the CI/CD setup, see [.github/README.md](.github/README.md).
+For more details on the CI/CD setup, see [CI/CD Setup Documentation](.github/CI_CD_SETUP.md).