Skip to content

Fix YAML syntax error in codeql.yml and clean up README#16

Merged
parkcheolhong merged 4 commits intomainfrom
copilot/add-feature-review-process
Oct 10, 2025
Merged

Fix YAML syntax error in codeql.yml and clean up README#16
parkcheolhong merged 4 commits intomainfrom
copilot/add-feature-review-process

Conversation

Copy link
Contributor

Copilot AI commented Oct 8, 2025

Overview

This PR addresses critical issues found during code review validation, fixing a YAML parsing error that would prevent the CodeQL workflow from running and cleaning up outdated documentation text.

Issues Fixed

1. YAML Syntax Error in .github/workflows/codeql.yml

Problem: A malformed duplicate with: block starting at line 101 caused YAML parsing errors:

# Before (invalid YAML)
- name: Cache
  uses: actions/cache@v4.3.0
  with:
    path: ~/.cache 
    key: ${{ runner.os }}-codeql-cache-${{ github.sha }}
with:  # ❌ Duplicate/misplaced 'with:' block
    key: ${{ steps.restore-cache.outputs.cache-primary-key }} 
    restore-keys: # optional
    # ... many commented-out optional parameters

Solution: Removed the duplicate with: block and properly configured the cache action with appropriate restore-keys:

# After (valid YAML)
- name: Cache
  uses: actions/cache@v4.3.0
  with:
    path: ~/.cache 
    key: ${{ runner.os }}-codeql-cache-${{ github.sha }}
    restore-keys: |
      ${{ runner.os }}-codeql-cache-

This fix ensures the CodeQL workflow can execute without YAML parsing failures.

2. Outdated Text in README.md

Problem: The README still contained generic GitHub Desktop tutorial text:

Write your name on line 6, save it, and then head back to GitHub Desktop.

Solution: Removed the outdated tutorial text, allowing the README to properly reflect RepoPilot MVP functionality as recommended in the code review.

Validation

All validation tests pass successfully:

  • ✅ All 3 YAML workflow files validated
  • ✅ All 3 JSON policy files validated
  • ✅ All 3 shell scripts pass bash syntax check
  • ✅ All 3 shell scripts pass shellcheck with no warnings

Related Documentation

These changes implement recommendations from the Code Review Summary, specifically addressing the "Update README.md" optional improvement and fixing a previously undetected YAML syntax error.

Original prompt

검토


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Co-authored-by: parkcheolhong <111139476+parkcheolhong@users.noreply.github.com>
Copilot AI changed the title [WIP] Add review process for improved code quality Fix YAML syntax error in codeql.yml and clean up README Oct 8, 2025
Copilot AI requested a review from parkcheolhong October 8, 2025 18:18
Copy link
Owner

@parkcheolhong parkcheolhong left a comment

Choose a reason for hiding this comment

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

수고했습니다.

@parkcheolhong parkcheolhong marked this pull request as ready for review October 8, 2025 18:29
Copilot AI review requested due to automatic review settings October 8, 2025 18:29
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 fixes a critical YAML syntax error in the CodeQL workflow that would prevent it from running and removes outdated tutorial text from the README.

  • Fixed duplicate with: block causing YAML parsing failure in CodeQL workflow
  • Properly configured cache action with appropriate restore-keys parameter
  • Removed outdated GitHub Desktop tutorial text from README

Reviewed Changes

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

File Description
.github/workflows/codeql.yml Fixed YAML syntax by removing duplicate with: block and configuring proper cache restore keys
README.md Removed outdated tutorial text to clean up documentation

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

# Run the post step to save the cache even if another step before fails
save-always: # optional, default is false
restore-keys: |
${{ runner.os }}-codeql-cache-
Copy link
Owner

Choose a reason for hiding this comment

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

key: ${{ runner.os }}-codeql-cache-${{ github.sha }}

Copy link
Owner

Choose a reason for hiding this comment

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

키 값을 이곳에서 적용하면 된다고 한 것 같은데? 키값을 다시 적용함

@parkcheolhong parkcheolhong merged commit 8764147 into main Oct 10, 2025
5 of 7 checks passed
@parkcheolhong parkcheolhong deleted the copilot/add-feature-review-process branch October 10, 2025 02:28
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.

3 participants