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

PyPI Publishing Workflow and Docs Improvements #4

Merged
merged 25 commits into from
Dec 17, 2023
Merged

PyPI Publishing Workflow and Docs Improvements #4

merged 25 commits into from
Dec 17, 2023

Conversation

mdapena
Copy link
Owner

@mdapena mdapena commented Dec 16, 2023

Initial Checks

  • The code compiles successfully without any errors or warnings.
  • I have personally tested these changes on my local environment.
  • I have ensured that relevant documentation has been added or updated.
  • I adhere to the project structure and code standards defined in the documentation.
  • My code follows the established coding style guidelines.
  • I have added tests for the new code (if applicable).
  • All existing tests have passed successfully.

Description

This pull request introduces several enhancements and improvements to the latest release of the project. It includes the implementation of new GitHub Actions, bug fixes, and documentation enhancements. The following bullet points highlight the key changes made in this pull request:

  • GitHub Actions: The "publish to PyPI" workflow has been introduced, automating the uploading of package builds whenever new releases are created. This streamlines the process and ensures seamless distribution of the project.
  • Academic Citations: A CITATION.cff file has been added in this pull request to facilitate academic citations.
  • Code of Conduct: A code of conduct has been included in the project, aligning with the guidelines outlined in the Contributor Covenant v2.1.
  • Project Badges: Badges have been added to the main page of the documentation as well as the readme file.
  • git-authors mkdocs material: The mkdocs.yml file has been updated to incorporate the "git-authors" plugin, which displays the names of documentation contributors on their respective pages.
  • Documentation Improvements: In this pull request, issues related to relative links in the documentation have been addressed.

@mdapena mdapena added the github actions Pull requests that update Github actions code label Dec 16, 2023
@mdapena mdapena self-assigned this Dec 16, 2023
@mdapena mdapena added bug Something isn't working enhancement Suggests an improvement or enhancement to an existing feature documentation Improvements or additions to documentation github templates Pull requests that update Github templates labels Dec 17, 2023
@mdapena mdapena changed the title Core PyPI Publishing Workflow and Docs Improvements Dec 17, 2023
@mdapena mdapena merged commit 1a34b2e into master Dec 17, 2023
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation enhancement Suggests an improvement or enhancement to an existing feature github actions Pull requests that update Github actions code github templates Pull requests that update Github templates
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant