Skip to content

Update v1.7.5

Compare
Choose a tag to compare
@AlejandroCN7 AlejandroCN7 released this 14 Feb 16:03
· 337 commits to main since this release

Fix

Fixes #132
Fixes #120
Fixes #136
Fixes #142
Fixes #135
Fixes #141
Fixes #147
Fixes #148
Fixes #154
Fixes #156
Fixes #146

Changelog

  • Setup.cfg has been included in repository root.

  • Setup.py and Setup.cfg include more Sinergym package information such as packages, license, authors, email, description, GitHub URL, project keywords, long description, classifiers...

  • MANIFEST.in is included in order to detect requirements.txt and sinergym/version.txt in PyPi package.

  • Documentation generated about PyPi installation: pip install sinergym[extras].

  • README.md updated in consequence.

  • Added CITATION.bib to repository root.

  • Added CODE_OF_CONDUCT.md to repository root.

  • Added CONTRIBUTING.md to repository root.

  • Added PULL_REQUEST_TEMPLATE.md

  • Added ISSUE_TEMPLATES

  • Modified protection.yml workflow; test changes raise a warning instead of an error.

  • Added if statement for source documentation changes in documentation_check.yml workflow

  • Added same improvement to the documentation job in merge_pr.yml workflow

  • Update GitHub actions section in documentation accordingly.

  • Added a job in create release workflow. Whether there are secrets configured, then PyPi will be updated with the new version.

  • Added documentation for GitHub Actions section in order to include this PyPi automatization.

  • Apply isort standard to Sinergym code (whole project).

  • Included isort in requirements.txt

  • Added isort functionality in format check (create PR workflows) and bot format commit (merge workflow).

  • Unified all pull request workflow in a yml file (create_pr.yml)

  • Added documentation in GitHub Action section.

  • Added isort info in CONTRIBUTING.md

  • Module sinergym has been typed in inputs/outputs using pytype

  • Added .pytype/ and .pytest_cache to gitignore.

  • Added pytype to Contributing.md

  • Added pytype workflow in pull request event.

  • Documentation for pytype workflow.

  • Added contributing reference to documentation.

  • Pull request template update with pytype and isort checklist.

  • Updated tests for simulator changes with pytype.

  • Updated docstring with pytypes specification (Google Standard).

  • Specified google standard for docstring in CONTRIBUTING.md

  • Bots workflows to commit changes are synchronized now.

  • Added enchant C library to Dockerfile in order to enable sphinx-spelling extension.

  • Added sphinxcontrib-spelling and pyenchant to doc and extra tag in setup.py

  • Created spelling_wordlist.txt in order to ignore words relational with Sinergym project.

  • Fixed Spelling errors in documentation (docstring too)

  • (Workflows have been checked in forked repository).

  • Created spelling workflow in create_pr.yml and merge_pr.yml.

  • Updated CONTRIBUTING.md and PR template checklist with new functionality.

  • Updated Sinergym version to v1.7.5