EXPERIMENTAL: Add tutorial testing workflows integrated with Sphinx docs #1571
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Created a comprehensive tutorial for Amaranth HDL beginners - Added CLAUDE.md with build commands and code style guidelines - Tutorial progresses from simple to complex examples with explanations 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Replaced the existing tutorial placeholder with a complete tutorial - Created code examples for each section of the tutorial - Tutorial covers basic concepts to advanced topics like FSMs - Includes troubleshooting and glossary sections - Maintained references to existing community tutorials 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Validates all code examples referenced in tutorial.md - Runs each example to verify it works correctly - Checks generated outputs (Verilog files and simulation waveforms) - Creates a test summary of which examples passed/failed - Archives results as workflow artifacts 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Created two new GitHub workflows: 1. Tutorial Comprehension Test: - Uses Claude to analyze the tutorial for consistency and comprehensibility - Checks code examples for correctness - Assesses the tutorial's quality for beginners - Identifies potential improvements 2. Tutorial Execution Test: - Uses Claude to extract executable steps from the tutorial - Automatically runs each code example - Records and analyzes execution results - Provides detailed feedback on example executability - Archives all generated outputs as workflow artifacts 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Modified workflows to use docs/tutorial.rst instead of tutorial.md - Added support for parsing RST format code blocks and includes - Enhanced execution test to use actual code files from docs/_code/ - Removed standalone tutorial.md in favor of Sphinx integration - Updated path triggers to focus on docs directory files 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1571 +/- ##
==========================================
- Coverage 91.32% 91.32% -0.01%
==========================================
Files 44 44
Lines 11389 11388 -1
Branches 2219 2218 -1
==========================================
- Hits 10401 10400 -1
Misses 827 827
Partials 161 161 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
At the moment I'm not interested in any AI-related integrations. |
|
Sure. That’s why it’s in draft and I’ve not asked for a review..
marked as experimental.
…On Mon, 17 Mar 2025 at 00:47, Catherine ***@***.***> wrote:
At the moment I'm not interested in any AI-related integrations.
—
Reply to this email directly, view it on GitHub
<#1571 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAB4O4BUWZJNZPYCVKYOLWT2UYLTLAVCNFSM6AAAAABZEHL4T2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDOMRXG43DONBXGE>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
[image: whitequark]*whitequark* left a comment
(amaranth-lang/amaranth#1571)
<#1571 (comment)>
At the moment I'm not interested in any AI-related integrations.
—
Reply to this email directly, view it on GitHub
<#1571 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAB4O4BUWZJNZPYCVKYOLWT2UYLTLAVCNFSM6AAAAABZEHL4T2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDOMRXG43DONBXGE>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
- Updated actions/checkout from v3 to v4 - Updated actions/setup-node from v3 to v4 - Updated actions/upload-artifact from v3 to v4 These changes should fix the 'Missing download info' errors in workflows. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
robtaylor
changed the title
- Added checks for ANTHROPIC_API_KEY secret availability - Skip Claude-based API calls when key is not available - Added helpful warnings in workflow summaries when tests are skipped - Made artifact uploads conditional on API key availability This allows the workflows to pass when run in forks or environments without the API key configured. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Replaced manual PDM installation with official pdm-project/setup-pdm action - Enabled caching for faster workflow execution - Removed redundant Python setup steps This should help fix the failing workflow checks by ensuring PDM is properly installed and configured. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Added cache-dependency-path to use pyproject.toml instead of pdm.lock - This allows PDM to work even in repositories without pdm.lock files 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Fixed inconsistent underline lengths in section headers - Standardized section formatting across the document - This resolves the documentation build warnings that were causing CI failures 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Added Python scripts to automatically fix RST formatting issues - Fixed title underline lengths to match title text - Added blank lines after bullet lists - Fixed broken documentation link - All warnings resolved in document and document-linkcheck This resolves remaining doc build issues and should enable CI checks to pass. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Created docs/tools directory for documentation utilities - Moved RST formatting scripts from root to docs/tools - Added README.md with usage instructions for the tools 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
|
Moving to testing in robtaylor/amaranth for now to avoid noise. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Experimental draft PR exploring the use of Claude AI for tutorial testing and validation.
Implementation Notes
Test plan
Note: The Claude-based workflows require an ANTHROPIC_API_KEY secret to be set in the repository settings. Without this, they will be skipped but won't fail the PR checks.
🤖 Generated with Claude Code