Skip to content

ci: add device list update workflow and script#171

Open
wakonig wants to merge 1 commit intomainfrom
ci/device_list
Open

ci: add device list update workflow and script#171
wakonig wants to merge 1 commit intomainfrom
ci/device_list

Conversation

@wakonig
Copy link
Member

@wakonig wakonig commented Jan 16, 2026

Adding the old device list update workflow

Copilot AI review requested due to automatic review settings January 16, 2026 19:48
@codecov
Copy link

codecov bot commented Jan 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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 a new automated workflow to update the device list documentation whenever code is pushed to the main branch. It generates a markdown table listing all devices that inherit from the Ophyd Device class.

Changes:

  • Added a new GitHub Actions workflow to automatically generate and commit device list documentation
  • Created a Python script to discover and document all device classes in the repository
  • Minor formatting cleanup in the semantic release workflow (removed blank lines, normalized quote style, removed outdated comments)

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.

File Description
.github/workflows/device-list-update.yml New workflow that runs on main branch pushes to generate and commit device list documentation
.github/scripts/retrieve_device_classes.py Python script that discovers Device classes and generates markdown documentation
.github/workflows/semantic_release.yml Minor formatting cleanup: removed blank lines, normalized Python version quotes, removed outdated comments

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

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.

2 participants