Skip to content

feat: validate project links on publish#22

Merged
okjodom merged 1 commit intomainfrom
ok/links-format
Jul 2, 2025
Merged

feat: validate project links on publish#22
okjodom merged 1 commit intomainfrom
ok/links-format

Conversation

@okjodom
Copy link
Copy Markdown
Collaborator

@okjodom okjodom commented Jul 2, 2025

Lightning Network Gallery Update

Description

Brief description of what this PR changes:

  • Other: ___________________

Changes Made

added a validator for project links

New Projects Added:

N/A

Updated Projects:

  • N/A

Data Quality Checklist:

  • All project names are accurate
  • URLs are working and correct
  • Tags are relevant and consistent with existing tags
  • Project descriptions are clear and informative
  • JSON syntax is valid (will be automatically checked)

Testing

  • I have tested the JSON locally
  • Links open correctly
  • Project information is accurate

Additional Notes

  • quality check

For Maintainers:

  • Data quality review completed
  • No duplicate projects
  • Consistent formatting
  • Ready to merge

Copilot AI review requested due to automatic review settings July 2, 2025 13:29
Copy link
Copy Markdown

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 enhances the CI pipeline by adding format validation for project links in lngal_data.json before publishing.

  • Switched JSON validation commands from python to python3
  • Introduced a new workflow step to validate link objects (checking for required fields and URL formatting)
Comments suppressed due to low confidence (3)

.github/workflows/deploy.yml:50

  • Indentation of this step is inconsistent with other steps and will cause the workflow YAML to fail. Align it under the same indentation level as the surrounding steps (e.g., 8 spaces).
      - name: Validate project links

.github/workflows/deploy.yml:51

  • [nitpick] The inline Python script is lengthy and embedded directly in the workflow, which can be hard to maintain and test. Consider extracting it into a separate script (e.g., scripts/validate_links.py) and calling that here.
        run: |

.github/workflows/deploy.yml:52

  • There are no dedicated tests for the new link validation logic. Adding unit tests or a sample JSON in a test suite would help ensure both valid and invalid link scenarios are covered.
          echo "🔍 Validating project links format..."

@okjodom okjodom merged commit 3e0300c into main Jul 2, 2025
2 checks passed
@okjodom okjodom deleted the ok/links-format branch September 3, 2025 09:41
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