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

Update quality.yml #3112

Closed
wants to merge 1 commit into from
Closed

Update quality.yml #3112

wants to merge 1 commit into from

Conversation

Alphena-EK
Copy link

No description provided.

@rfulwell
Copy link
Contributor

Hi @Alphena-EK ! 👋

Can you provide a high level description of the changes in the PR?

Also, it would help the reviewer if you explain in the PR description some of the decisions you made. For example, why did you specify Linux vs. Mac vs. Windows on certain entries in the workflow matrix. It looks like you're attempting to get "double duty" out of the build matrix by covering OS permutations in addition to different Python versions but I don't want to make assumptions about your intent.

Finally, I already get automated emails from GitHub when Actions fail. Is the custom build failure notification workflow really needed?

@Alphena-EK Alphena-EK closed this Dec 27, 2024
@Alphena-EK
Copy link
Author

  1. High-Level Description of the Changes

The PR introduces updates to the GitHub Actions workflow to improve test coverage and compatibility across different environments. Specifically:

It defines a matrix strategy to test on multiple operating systems (Linux, macOS, and Windows) and Python versions.

Includes a custom notification workflow to alert maintainers about build failures.

  1. Decisions on Workflow Matrix (OS vs. Python Versions)

The workflow matrix was designed to achieve dual objectives:

OS Permutations: Ensure that the project behaves consistently across Linux, macOS, and Windows environments. This is critical for cross-platform compatibility.

Python Versions: Validate compatibility with a range of supported Python versions, ensuring broad usability. The combination in the matrix allows testing of key permutations without redundancy. For example:

Linux typically represents the majority of deployments.

macOS and Windows testing ensures edge-case environments are covered.

I prioritized these permutations based on usage trends and feedback about common development setups. Let me know if there are additional configurations you'd like covered.

  1. Custom Build Failure Notification Workflow

While GitHub’s automated emails notify maintainers of failed Actions, the custom workflow was added for enhanced visibility and flexibility. Key benefits include:

Selective Notifications: It allows tailored notifications to specific teams or individuals based on failure type or workflow.

Integration Options: It supports integration with tools like Slack or Teams, providing real-time updates. However, if this is redundant for your needs, I’m open to removing or refining this workflow

Please let me know if you have any other questions or suggestions for improvement. I'm happy to adjust the PR as needed!

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