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 CI to follow gymnasium's implementation #418

Merged

Conversation

pseudo-rnd-thoughts
Copy link
Member

@pseudo-rnd-thoughts pseudo-rnd-thoughts commented Jun 29, 2023

As part of the process of updating metaworld, this PR updates the CI (testing and pre-commit) to follow gymnasium's implementation.

In particular, the dockerfile, testing implementation and pre-commit config were updated

@reginald-mclean I'm a bit surprised that the testing takes 40+ minutes to run.
We should do an investigation to understand why it takes so long, I would expect 5 - 10 minutes max.

hooks:
- id: mixed-line-ending
Copy link
Member

Choose a reason for hiding this comment

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

Is this not used in gymnasium? Seems useful, have had issues with line endings before. Also I feel like we should use the same pre commit config across farama projects similar to farama notifications and the furo documentation stuff. Might go and add these things to pettingzoo. For consistency’s sake.

Copy link
Member Author

Choose a reason for hiding this comment

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

I believe that this is done in the end-of-file-fixer within pre-commit-hooks

--tag metaworld-docker .
- name: Run tests
run: docker run metaworld-docker pytest tests/*
# - name: Run doctests
Copy link
Member

Choose a reason for hiding this comment

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

What does this do exactly? Should we have doc tests for other projects?

Copy link
Member

Choose a reason for hiding this comment

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

Did some googling looks useful, though i don’t think many other farama projects do that style of docs with code examples

Copy link
Member Author

Choose a reason for hiding this comment

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

This was a copy from Gymnasium where we run this.
I recommend it for having docstrings that are correct and will raise an error if the code changes etc

@pseudo-rnd-thoughts
Copy link
Member Author

@reginald-mclean Are you happy for me to merge this?

@pseudo-rnd-thoughts pseudo-rnd-thoughts merged commit 3e38597 into Farama-Foundation:master Jul 6, 2023
5 checks passed
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.

None yet

2 participants