Skip to content

Add first version of code, docs and tests #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

gabmontes
Copy link
Contributor

This PR adds the first version of everything in the repo. See the docs for more info. Not copying-pasting here!

@gabmontes gabmontes self-assigned this May 8, 2025
@gabmontes gabmontes marked this pull request as ready for review May 8, 2025 16:38
@gndelia gndelia requested a review from Copilot May 8, 2025 18:03
Copy link

@Copilot 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 introduces the initial version of the project, including the code, documentation, tests, and configuration files necessary for sorting GitHub Actions YAML files.

  • Adds various YAML fixture files for workflows and composite actions (both unsorted and sorted).
  • Implements the core sorting functionality in JavaScript (src/index.js) based on a configuration defined in keys.json.
  • Provides comprehensive configuration and CI/CD setup across multiple files (e.g. package.json, GitHub workflows, ESLint, Husky).

Reviewed Changes

Copilot reviewed 24 out of 24 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
test/fixtures/workflow.yml Unsorted workflow file fixture
test/fixtures/workflow-sorted.yml Sorted workflow file fixture
test/fixtures/other.yml A YAML file with an unusual structure that may not be valid
test/fixtures/action.yml Unsorted composite action file with key order differing from guide
test/fixtures/action-sorted.yml Sorted composite action file fixture
src/keys.json Configuration for sorting rules
src/index.js Sorting algorithm implementation using the YAML package
package.json Project metadata and dependency configuration
README.md Documentation on project purpose and usage
Other configuration files Supporting CI/CD and dev tooling settings
Comments suppressed due to low confidence (1)

test/fixtures/other.yml:3

  • The structure in this file does not conform to a valid GitHub Actions workflow format. Please verify if this file is intended as an invalid fixture or update it to follow proper YAML structure.
- github:

@gabmontes gabmontes requested a review from gndelia May 8, 2025 18:07
ArturDolzan
ArturDolzan previously approved these changes May 9, 2025
@gabmontes gabmontes requested a review from gndelia May 9, 2025 19:36
rafappelt
rafappelt previously approved these changes May 22, 2025
@gabmontes gabmontes enabled auto-merge (rebase) May 23, 2025 15:52
@gabmontes gabmontes dismissed stale reviews from rafappelt and ArturDolzan via 3dda338 May 28, 2025 13:24
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.

4 participants