Revert GitHub workflow by ultimateownsz · Pull Request #101 · PyCeas/Pyceas

ultimateownsz · 2025-02-27T23:31:57Z

Revert Pull Request Template

Summary

This PR fixes changes made in PR #99 and simplifies the management of CI workflows by using a reusable workflow (lint_and_test.yml) from the .github repository.

Note

Full testing of the reusable workflow requires merging this PR. Testing locally verifies that the .toml configuration works as expected, but integration with the reusable workflow can only be confirmed after merging or updating references to a test branch.

Key Changes:

Introduced the reusable workflow call:
- Refactored this repository’s workflow to leverage the global .github repository.
- Allows the .github repository to manage Python linting (ruff) and type-checking (mypy) logic in one place.
Future-proofed workflows:
- Enables seamless updates for all repositories by making changes in one global location.
- Provides flexibility for adding other reusable workflows (e.g., testing, deployment) in the .github repository.
Project specific configuration

Added a .toml file to define ruff and mypy settings for the project.
- Ruff enforces formatting, fixes import issues, and detects unused variables.
- Mypy type-checks the codebase while ignoring missing type stubs for specific libraries (pygame for example)

Steps for testing the changes

To validate these changes:

Merge this branch into your working branch:
- Use the following command:

git merge <branch-name-of-this-pr>

Resolve any merge conflicts, if applicable

Run the commands listed in the README to test locally:
Push your updated branch to trigger the CI workflow:

When triggered, it will show you if you have done it correctly, if not you can see where it failed.

Verify CI results:

Confirm that the workflow runs as expected and passes.

If the changes work as intended, complete your review and approve this PR.

Reviewer notes

These changes centralize linting and type-checking using a reusable workflow from the .github repository.
Full integration testing requires merging this branch into your working branch, as described in the testing instructions.

Please review and approve the changes to adopt the reusable workflow approach.

Related Issues

This PR fixes issue(s) #99 the license URL in the README was broken, also made some other fixes to the structure of the README.

✅ Checklist:

🛠️ I have tested my code, and it works as expected (e.g., game runs without errors).
📝 I have made sure that the code follows the project's formatting and style guidelines.

@PurpleProg

this will revert the .github workflow that @PurpleProg helped with, only thing that is added now is to have it check on python files, so any markdown or yml configurations will not use this workflow anymore

…ub repository - Updated the workflow to use the reusable workflow `lint_and_test.yml` from the PyCeas/.github repository. - Simplified workflow maintenance by centralizing the logic in the `.github` repository. - Removed duplication of Python version management and dependency installation logic in individual workflows. - Added flexibility for future updates and enhancements to global workflows.

This will fix the readme once again, just some things I forgot since my last PR, it will make the changes more clear and better to read.

testing if the linter now properly works on .py files

This reverts commit 63876fe.

testing out if the workflow works again properly

this will help by reducing to put in some things like ignore imports for mypy. import pygame is a good example for this, since the pip package is called pygame-ce it is still referred as pygame and mypy brakes on this for some reason.

this adds the message in settings.py why some imports are not type checked because of, see previous commit.

line length is 120 correct ruff commands added removed mypy commands no longer needed

when running the commands from the readme it will make it more clear what needs to be changed and where exactly

from different files, mypy didn't like it so no it should be ignored by the toml config

for safety reasons i added # type: ignore to not let mypy typecheck pygame imports

This will help make the instructions for setting up pyceas via a virtual environment for multiple os's

- Enabled .idea/ in the .gitignore to ensure that all PyCharm-specific project files are ignored. - This prevents unnecessary files such as workspace.xml, caches, and other IDE-specific settings from being committed to version control. - Helps maintain a cleaner repository and avoids conflicts with collaborators using different environments or IDEs.

ultimateownsz added 18 commits February 20, 2025 13:38

revert old .github workflow

473f81c

this will revert the .github workflow that @PurpleProg helped with, only thing that is added now is to have it check on python files, so any markdown or yml configurations will not use this workflow anymore

docs: restructure readme a bit and fix a license url

da411e1

This will fix the readme once again, just some things I forgot since my last PR, it will make the changes more clear and better to read.

run ruff & mypy

63876fe

testing if the linter now properly works on .py files

Revert "run ruff & mypy"

e560fc0

This reverts commit 63876fe.

update correct requirements_dev.txt file

7870ac4

run ruff over the new changes

36f994a

testing out if the workflow works again properly

adds a message about ignoring some imports

01fbd58

this adds the message in settings.py why some imports are not type checked because of, see previous commit.

fixing ruff configs

1bd2bf7

forgot missing imports line

9a5f0df

adding double ""

c5b91ed

move toml file to root directory

ae5343a

fix correct toml config

ec42a84

line length is 120 correct ruff commands added removed mypy commands no longer needed

fix ruff errors

59ba4fa

when running the commands from the readme it will make it more clear what needs to be changed and where exactly

Update pyproject.toml

ced4706

fix error in base state when importing states

24d0d87

from different files, mypy didn't like it so no it should be ignored by the toml config

add type ignore

41b6552

for safety reasons i added # type: ignore to not let mypy typecheck pygame imports

ultimateownsz requested a review from Davidek523 March 12, 2025 00:27

Making virtual env instructions more clear

01701e7

This will help make the instructions for setting up pyceas via a virtual environment for multiple os's

ultimateownsz requested a review from PurpleProg March 12, 2025 10:55

ultimateownsz changed the title ~~Revert .GitHub workflow~~ Revert GitHub workflow Mar 15, 2025

ultimateownsz closed this Mar 15, 2025

ultimateownsz deleted the revert-.github-workflow branch March 15, 2025 09:35

ultimateownsz restored the revert-.github-workflow branch March 15, 2025 09:35

ultimateownsz deleted the revert-.github-workflow branch May 29, 2025 20:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Revert GitHub workflow#101

Revert GitHub workflow#101
ultimateownsz wants to merge 20 commits intomainfrom
revert-.github-workflow

ultimateownsz commented Feb 27, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Comments

Conversation

ultimateownsz commented Feb 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Revert Pull Request Template

Summary

Steps for testing the changes

Reviewer notes

Related Issues

✅ Checklist:

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Comments

ultimateownsz commented Feb 27, 2025 •

edited

Loading