Skip to content

Implement changes for SDLC - CI pipeline and PR template #5

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

Merged
merged 5 commits into from
Dec 12, 2024
Merged

Conversation

AlexioDanje
Copy link
Collaborator

  • Add Vitest coverage configuration with initial thresholds
  • Setup Code Climate test reporter integration
  • Configure coverage directory handling in CI workflow
  • Ensure proper test coverage reporting both locally and in CI

Testing:

  • Verified local coverage generation
  • Confirmed CI pipeline uploads reports to Code Climate

- Update vitest.config.js with coverage settings and JSX transformation
- Configure CI workflow to create coverage directories
- Set initial coverage thresholds to 0 for gradual improvement
- Add Code Climate test reporter integration

The changes ensure proper test coverage reporting both locally and in CI,
with Code Climate integration for tracking coverage metrics.
@AlexioDanje AlexioDanje requested a review from timler December 12, 2024 05:10
@timler
Copy link
Collaborator

timler commented Dec 12, 2024

Snyk checks have failed. 1 issues have been found so far.

Icon Severity Issues
Critical 0
High 0
Medium 1
Low 0

security/snyk check is complete. 1 issues have been found. (View Details)

Copy link
Collaborator

@timler timler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good - minor comments.

NODE_VERSION: '16'

jobs:
continuous-integration:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should align our workflows - please change this to "test" to match the job on npm "test:coverage", and then change the name of the file to continuous-integration.yml

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @timler I have updated my PR

steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I forgot to add this for my pipeline, so will do that!

adanje added 2 commits December 12, 2024 12:05
- Rename workflow file to continuous-integration.yml
- Update job name to test to match npm script (test:coverage)
- Add pull request template for standardization
- Update the folder structrure for the pull request template
- '**.md'
- 'docs/**'
- '.gitignore'
- 'LICENSE'
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is what I added - AFAIK you don't need separate definition for pull_request because it's covered under push

on:
  push:
    paths-ignore:
      - '**.md'
      - '**.txt'
      - '**.json'
      - '**.yml'
      - '**.properties'
      - '**.xml'
      - '**.sql'
      - '**.csv'
      - '**.zip'
      - 'docs/**'
      - '.gitignore'

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It makes sense, let me resolve that

adanje and others added 2 commits December 12, 2024 13:39
- Update paths-ignore to ensure critical files trigger builds
- Maintain focus on push events, the pull request trigger is redundant
Moved the PR template from the folder into the main .github folder so
the template is applied by default and doesn't need a query parameter
@timler timler changed the title ci: Configure CI pipeline to handle coverage reporting Implement changes for SDLC - CI pipeline and PR template Dec 12, 2024
@timler timler merged commit a418939 into dev Dec 12, 2024
1 check failed
@timler timler deleted the ci-setup branch December 12, 2024 12:48
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