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

ENH: Any feature branch should always self-test against itself #6

Merged
merged 4 commits into from
Feb 4, 2025

Conversation

khalford
Copy link
Member

@khalford khalford commented Feb 3, 2025

Description:

Fixing bug in action where the main.py cannot import from src. Removing src from import path fixes this.

Additionally:
Created a PR template
Changed workflows to only run workflows on push if the branch is main


Submitter:

Have you done the following?:

  • Labeled the pull request from the following? major | minor | patch or documentation | workflow
  • Updated the documentation for new action changes
  • Added unit tests for new / untested code?
  • Run the self test against the branch by changing the action branch to this branch
  • Updated the version.txt and docker-compose.yml files?

Reviewer:

Have you checked the following?:

  • Version change is appropriate to the code changes? Semantic versioning documentation here
  • Unit test code coverage is acceptable?
  • Do the CI jobs pass?

@codecov-commenter
Copy link

codecov-commenter commented Feb 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.93%. Comparing base (52f1ac8) to head (84abc70).

Additional details and impacted files
@@           Coverage Diff           @@
##             main       #6   +/-   ##
=======================================
  Coverage   98.93%   98.93%           
=======================================
  Files           6        6           
  Lines         187      187           
=======================================
  Hits          185      185           
  Misses          2        2           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@khalford khalford self-assigned this Feb 3, 2025
@khalford khalford requested review from a team, jose-caballero and RWhiting78 February 3, 2025 15:19
@khalford khalford added the bug Something isn't working label Feb 3, 2025
@khalford
Copy link
Member Author

khalford commented Feb 4, 2025

Integration Test / self-test will fail for this PR. The self test builds the action from the main branch which is currently not working due to a bug. This PR fixes that bug.

These changes are proven to work in stfc/cloud-docker-images#103

@khalford
Copy link
Member Author

khalford commented Feb 4, 2025

Integration Test / self-test will fail for this PR. The self test builds the action from the main branch which is currently not working due to a bug. This PR fixes that bug.

@jose-caballero

Remove src from import path as it is not a package
jose-caballero
jose-caballero previously approved these changes Feb 4, 2025
Copy link

@jose-caballero jose-caballero left a comment

Choose a reason for hiding this comment

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

As far as I can understand these changes, they look OK to me.

Increase patch version as the changes fix a bug but do not introduce
functionality
This should reduce the amount of tests running in the pull request
This should make PRs more informative and help reminder authors/reviewers what needs to be done
@khalford khalford merged commit eec048e into main Feb 4, 2025
4 of 5 checks passed
@khalford khalford deleted the dev branch February 4, 2025 09:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants