From 68b4da9abb40e4f8e12f541bd5189c00a15faf2f Mon Sep 17 00:00:00 2001 From: bymyself Date: Sun, 1 Jun 2025 22:10:20 -0700 Subject: [PATCH 1/3] [test] Add TEST RFC to verify enhanced discussion workflow This RFC will test the new discussion creation and sync capabilities --- .../9999-TEST-enhanced-discussion-workflow.md | 84 +++++++++++++++++++ 1 file changed, 84 insertions(+) create mode 100644 rfcs/9999-TEST-enhanced-discussion-workflow.md diff --git a/rfcs/9999-TEST-enhanced-discussion-workflow.md b/rfcs/9999-TEST-enhanced-discussion-workflow.md new file mode 100644 index 0000000..9587449 --- /dev/null +++ b/rfcs/9999-TEST-enhanced-discussion-workflow.md @@ -0,0 +1,84 @@ +# RFC: TEST - Enhanced Discussion Workflow Integration + +- Start Date: 2025-01-06 +- Target Major Version: (1.x) +- Reference Issues: N/A - Testing enhanced workflow +- Implementation PR: (leave this empty) + +## Summary + +This is a **TEST RFC** to verify the enhanced discussion integration workflow. It should automatically create a rich discussion with full proposal content and demonstrate the sync capabilities when the RFC is updated. + +## Basic example + +```javascript +// Test content to verify workflow functionality +console.log("Testing enhanced RFC discussion workflow"); + +function testWorkflow() { + return { + autoDiscussionCreation: true, + fullContentEmbedding: true, + autoSync: true, + forkCompatibility: true + }; +} +``` + +## Motivation + +We need to test that: + +1. **Rich Discussion Creation**: Discussions include full RFC content, author info, and useful links +2. **Automatic Sync**: When RFCs are updated via PR commits, discussion content updates automatically +3. **Better Formatting**: Discussions use proper markdown with sections and metadata +4. **Fork Compatibility**: Works with `pull_request_target` for fork contributions + +This test will validate all these features work as expected. + +## Detailed design + +### Enhanced Discussion Features + +The workflow improvements include: + +- **Author Attribution**: Displays RFC author prominently +- **Status Indicators**: Shows current RFC status with emoji indicators +- **Quick Links Section**: Provides easy access to PR, changes, and rendered proposal +- **Embedded Content**: Full RFC content is embedded and stays current +- **Metadata Display**: Shows last updated timestamp and commit information +- **Sync Capabilities**: Automatically updates when PR content changes + +### Technical Implementation Details + +1. **Creation Workflow**: Enhanced `rfc-discussion.yml` extracts RFC content from PR +2. **Sync Workflow**: New `sync-rfc-discussion.yml` monitors for PR updates +3. **GraphQL Integration**: Uses GitHub's discussion API for content updates +4. **Content Extraction**: Fetches RFC content from PR branch using GitHub API +5. **Template Generation**: Builds discussion body with structured sections + +## Drawbacks + +- More complex workflow configuration +- Additional GitHub API calls for content fetching and updates +- Potential for larger discussion bodies with embedded content + +## Alternatives + +- Keep simple discussion format with minimal content +- Use manual discussion updates instead of automation +- Rely on PR comments rather than dedicated discussions + +## Adoption strategy + +This is a workflow enhancement that improves the RFC process without affecting existing RFCs or requiring changes from RFC authors. The enhanced discussions provide better visibility and engagement. + +## Unresolved questions + +- Should we add diff information in sync updates? +- How should we handle very large RFC files? +- Should we include additional metadata like file size or word count? + +--- + +**Note**: This is a TEST RFC - it will be deleted after verifying the workflow functions correctly. \ No newline at end of file From b0200680885b6938cb61fb6d6f9cd9cce670ad64 Mon Sep 17 00:00:00 2001 From: bymyself Date: Sun, 1 Jun 2025 22:52:57 -0700 Subject: [PATCH 2/3] [test] Update test RFC to verify discussion sync workflow Added update indicators and new section to test automatic discussion content synchronization --- rfcs/9999-TEST-enhanced-discussion-workflow.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/rfcs/9999-TEST-enhanced-discussion-workflow.md b/rfcs/9999-TEST-enhanced-discussion-workflow.md index 9587449..7d847c7 100644 --- a/rfcs/9999-TEST-enhanced-discussion-workflow.md +++ b/rfcs/9999-TEST-enhanced-discussion-workflow.md @@ -9,6 +9,8 @@ This is a **TEST RFC** to verify the enhanced discussion integration workflow. It should automatically create a rich discussion with full proposal content and demonstrate the sync capabilities when the RFC is updated. +**🔄 UPDATED**: This content has been modified to test the automatic discussion sync feature! + ## Basic example ```javascript @@ -36,6 +38,10 @@ We need to test that: This test will validate all these features work as expected. +### ✅ Testing Update Sync + +This section was added to verify that when we push changes to the RFC file, the GitHub discussion automatically updates to reflect the new content. The sync workflow should detect this change and update the discussion body with the modified RFC content. + ## Detailed design ### Enhanced Discussion Features From 7b0edef94f30168ad72269ec602a9284a7a0f9f9 Mon Sep 17 00:00:00 2001 From: bymyself Date: Mon, 2 Jun 2025 00:44:10 -0700 Subject: [PATCH 3/3] [test] Round 3: Testing sync workflow after syntax fix Added content with special characters to verify the JavaScript syntax error fix works correctly. Should handle brackets, apostrophes, and other special chars safely. --- rfcs/9999-TEST-enhanced-discussion-workflow.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/rfcs/9999-TEST-enhanced-discussion-workflow.md b/rfcs/9999-TEST-enhanced-discussion-workflow.md index 7d847c7..c98d8f0 100644 --- a/rfcs/9999-TEST-enhanced-discussion-workflow.md +++ b/rfcs/9999-TEST-enhanced-discussion-workflow.md @@ -11,6 +11,8 @@ This is a **TEST RFC** to verify the enhanced discussion integration workflow. I **🔄 UPDATED**: This content has been modified to test the automatic discussion sync feature! +**✅ SYNTAX FIX APPLIED**: Testing the workflow fix that prevents JavaScript syntax errors from special characters. + ## Basic example ```javascript @@ -42,6 +44,8 @@ This test will validate all these features work as expected. This section was added to verify that when we push changes to the RFC file, the GitHub discussion automatically updates to reflect the new content. The sync workflow should detect this change and update the discussion body with the modified RFC content. +**🔧 Round 3 Testing**: This is the third test commit after applying the JavaScript syntax error fix. The workflow should now handle special characters like brackets `[test]`, apostrophes `GitHub's`, and any other content safely. + ## Detailed design ### Enhanced Discussion Features