ci: Setup GitHub Actions, project documentation, and codebase formatting#6
Closed
NAME-ASHWANIYADAV wants to merge 5 commits into
Closed
Conversation
Update .gitignore to add an exception for the .github folder. This is required so that the GitHub Actions CI workflows and templates can be committed and tracked by Git, as they were previously excluded by the global '.*' rule. Signed-off-by: ashwani yadav <22ashwaniyadav@gmail.com>
Enhance the repository documentation to support open source contributions. This includes adding a comprehensive CONTRIBUTING.md, a SECURITY.md policy, issue templates for bugs and features, a pull request template, and updating the README to link to these new resources. Signed-off-by: ashwani yadav <22ashwaniyadav@gmail.com>
Introduce a CI pipeline to automatically build, lint, format, and test the plugin on every pull request and push to the main branch. Includes concurrency control, pinned actions, artifact uploads, and Dependabot configuration to keep dependencies updated. Signed-off-by: ashwani yadav <22ashwaniyadav@gmail.com>
Introduce robust unit tests for the StateChip component and the buildAllocationBody utility using Vitest. This ensures that GameServer lifecycle state colors map correctly and allocation payload generation handles all form edge cases properly. Signed-off-by: ashwani yadav <22ashwaniyadav@gmail.com>
Run 'npm run format' across the entire codebase to enforce consistent code styling. This resolves all Prettier formatting violations and ensures the code complies with the project's formatting standards for CI. Signed-off-by: ashwani yadav <22ashwaniyadav@gmail.com>
NAME-ASHWANIYADAV
force-pushed
the
ci/format-and-github-actions
branch
2 times, most recently
from
7d9f078 to
9585ddd
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Type of change
What this PR does
This PR establishes the foundation for project health, CI/CD, and open-source contributions.
Specifically, it introduces:
CONTRIBUTING.mdwith guidelines for branching and conventional commits, aSECURITY.mdpolicy, and an updatedREADME.md.npm run format(Prettier) across the entire codebase to enforce consistent styling. Updated.gitignoreto properly track the.githubdirectory.StateChipcomponent andbuildAllocationBodyutility to ensure reliability of GameServer state mapping and allocation payload generation.npmandgithub-actionsdependency updates.Related issues
Supersedes and closes #3 (Enhance project documentation and CI setup)
Screenshots / recordings
N/A - No user-facing UI changes, only CI/CD and tooling.
Test plan
Automated checks
npm cinpm run buildnpm run tscnpm run lintnpm run format -- --checknpm run test(28 tests passing)Manual verification
.githubfiles are tracked properly.RBAC considerations
No RBAC changes required.
Notes for reviewers
This PR includes the groundwork started in #3 but expands upon it with codebase formatting, Vitest unit tests, and CI concurrency control.