Skip to content
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

fix: add code validation to workflows #18

Merged
merged 23 commits into from
Sep 16, 2024
Merged

Conversation

caseyw
Copy link
Collaborator

@caseyw caseyw commented Sep 11, 2024

This pull request introduces several significant changes to the CI/CD workflows and the package.json configuration, along with some documentation updates. The most important changes include adding a new code validation workflow, updating dependencies and configurations in package.json, and modifying the README to reflect new installation instructions and image URLs so they will render on npm.

CI/CD Workflow Improvements:

  • New Code Validation Workflow: Added a new code_validation.yml workflow to handle linting, formatting, type checking, and unit tests. This workflow is now a prerequisite for the build and release jobs. (.github/workflows/build.yml, .github/workflows/release.yml) [1] [2]
  • Updated Actions: Upgraded actions/checkout to version 4 and actions/setup-node to version 4, and updated the build job to use .nvmrc for the Node.js version and cache Yarn dependencies. (.github/workflows/build.yml)
  • Pull Request Workflow: Added a new workflow for pull requests that uses the code_validation.yml job.

Package Configuration Updates:

  • Package Metadata and Scripts: Updated package.json to include a description, keywords, repository information, and new scripts for Prettier and TypeScript checks. Also, changed the package name to @liatrio/backstage-dora-plugin. (package.json) [1] [2] [3] [4]

Documentation Updates:

  • Installation Instructions: Updated the README to reflect new installation instructions and changed image URLs to use the raw content from the GitHub repository. (README.md) [1] [2] [3] [4] [5] [6]

Miscellaneous:

  • Node Version: Added .nvmrc file specifying Node.js version 18.20.4. (.nvmrc)
  • Prettier Ignore: Added CHANGELOG.md to .prettierignore. (.prettierignore)

@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

tjvkroll
tjvkroll previously approved these changes Sep 12, 2024
@caseyw caseyw merged commit 252edba into main Sep 16, 2024
6 checks passed
@caseyw caseyw deleted the updating-package-for-npm branch September 16, 2024 16:22
Wolftousen pushed a commit that referenced this pull request Sep 16, 2024
## [1.0.3](v1.0.2...v1.0.3) (2024-09-16)

### Bug Fixes

* add code validation to workflows ([#18](#18)) ([252edba](252edba))
@Wolftousen
Copy link
Collaborator

🎉 This PR is included in version 1.0.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants