ci: add pull request validation workflow - #43
Merged
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
EndlessTrax
added
documentation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a pull-request validation workflow for this VS Code snippets extension and documents the same validation steps for contributors.
Changes:
- Introduces a PR CI workflow that runs
npm ci, validates snippet catalogs via JSON parsing, and packages the extension withnpx vsce packageon Node.js 20. - Documents the CI/local validation commands in both the README and
.github/copilot-instructions.md.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Documents the PR CI validation steps and how to run them locally. |
| .github/workflows/ci.yml | Adds PR workflow executing install, JSON validation, and VSIX packaging on Node.js 20. |
| .github/copilot-instructions.md | Aligns Copilot instructions with the new CI/local validation workflow and clarifies PR checks. |
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
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.
This pull request adds a continuous integration (CI) workflow to validate pull requests and updates documentation to clarify the validation steps for contributors. The main changes include introducing a GitHub Actions workflow for PRs, documenting the validation steps in the README, and updating contributor instructions to reflect the new process.
Continuous Integration and Validation:
.github/workflows/ci.ymlto run on every pull request, which installs dependencies, validates that all snippet catalogs are parseable JSON, and packages the extension using Node.js 20.README.mdto describe the CI process and list the validation steps that run on every PR.Documentation Updates:
.github/copilot-instructions.mdto clarify that the PR workflow mirrors local validation commands and to document the new PR checks and validation steps. [1] [2]