Skip to content

Conversation

@aabrown100-git
Copy link
Collaborator

Current situation

Resolves #441

Release Notes

  • Rename .github/README.md to .github/WORKFLOW.md. This allows the root directory README.md to show on the GitHub homepage as intended.
  • Add a link to .github/WORKFLOW.md from tests/README.md.

Documentation

This is documentation

Testing

No testing required, just documentation changes.

Code of Conduct & Contributing Guidelines

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds comprehensive documentation about the GitHub Actions workflows used in the repository. It introduces a new workflow documentation file and links to it from the testing README.

  • Adds detailed documentation of all GitHub Actions workflows (tests, docker builds, documentation, copyright checks)
  • Documents the testing actions for Ubuntu and macOS platforms
  • Links the workflow documentation from the tests README to inform contributors about automated CI/CD processes

Reviewed Changes

Copilot reviewed 1 out of 2 changed files in this pull request and generated no comments.

File Description
tests/README.md Adds a note linking to the new workflow documentation, informing users that integration tests run automatically on PRs
.github/WORKFLOW.md New comprehensive documentation file describing all GitHub Actions workflows, their triggers, purposes, and configurations

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@codecov
Copy link

codecov bot commented Nov 4, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 67.35%. Comparing base (0ae6a5c) to head (5a17e4a).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #468   +/-   ##
=======================================
  Coverage   67.35%   67.35%           
=======================================
  Files         169      169           
  Lines       32620    32620           
  Branches     5718     5718           
=======================================
  Hits        21970    21970           
  Misses      10513    10513           
  Partials      137      137           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@mrp089 mrp089 merged commit 6ed3217 into SimVascular:main Nov 4, 2025
14 checks passed
@aabrown100-git aabrown100-git deleted the fix_homepage_readme branch November 4, 2025 16:23
kko27 pushed a commit to kko27/svMultiPhysics that referenced this pull request Dec 17, 2025
* Rename .github/README.md to .github/WORKFLOW.md

* Add link to WORKFLOW.md in Testing Guide

* Update Testing Guide reference to WORKFLOW.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

.github/README.md shows on repo home page instead of README.md

2 participants