V2 #56
Merged
V2 #56
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit introduces a new Sphinx documentation setup for the WrenchCL project. A configuration file, make file, an index, and a batch file were created to ensure efficient documentation process. The project's documentation now supports autodoc, viewcode, and napoleon extensions for better readability.
This commit fine-tunes multiple sections of our GitHub Actions workflow. Some redundant comments were removed for better readability while image versions for actions were updated to the latest. A critical permission block was added to resolve workflow dispatch issues. Additionally, the workflow now includes steps for generating Sphinx documentation and deploying it to GitHub Pages.
A new workflow file has been added to the .github directory that automatically generates Sphinx documentation. This workflow is triggered manually and deploys the built documentation to GitHub Pages. Moreover, it operates in the latest Ubuntu environment with Python 3.11.
The pytest command in the GitHub actions workflow has been updated to include the coverage report in XML format. An additional parameter is also added to the Codecov action to specify the location of the coverage report file.
The pytest command has been updated to correctly target the WrenchCL application for coverage report. The steps for uploading the coverage report to Codecov within the GitHub workflow were improved to remove redundant configurations and include verbose logging for better troubleshooting.
The commit modified the command to execute pytest, explicitly setting it to run on the /tests directory. Also, it relocated the test modules from resources/tests/ to the tests/ directory, improving the project structure and organization.
The commit modified the command to execute pytest, explicitly setting it to run on the /tests directory. Also, it relocated the test modules from resources/tests/ to the tests/ directory, improving the project structure and organization.
The pytest command in the GitHub workflow has been simplified. The target test directory "./tests" has been placed after the "--cov=WrenchCL" argument for clarity. Additionally, the verbose mode previously used with the Codecov action is turned off to minimize output verbosity.
The commit simplifies the pytest command in the GitHub workflows configuration file, making the target test directory more explicit. Additionally, the Codecov
The commit updates the file path used in the command for generating Sphinx documentation. Specifically, it changes the file from `config.py` to `conf.py` to match the correct file for configuring the Sphinx documentation generation.
The commit updates the file path used in the command for generating Sphinx documentation. Specifically, it changes the file from `config.py` to `conf.py` to match the correct file for configuring the Sphinx documentation generation.
The html_static_path in Sphinx configuration has been updated for clarity. Additionally, sphinx-rtd-theme has been included in the GitHub actions workflow. These changes ensure the Sphinx documentation generation is set correctly and theme dependency is properly handled in CI workflow.
This commit adds a .nojekyll file to the Sphinx build in the GitHub workflows for both publishing to PyPi and conducting Sphinx tests. It also updates the deployment step to exclude .nojekyll during cleanup, ensuring the file remains in the deployed gh-pages branch.
The code related to Sphinx documentation generation and deployment to GitHub Pages has been moved from the 'publish-to-pypi' workflow to a separate workflow named 'generate-docs'. This separation makes each workflow specific to a single responsibility, simplifies the 'publish-to-pypi' workflow, and provides greater flexibility in controlling when and how documentation is built and deployed.
The code related to Sphinx documentation generation and deployment to GitHub Pages has been moved from the 'publish-to-pypi' workflow to a separate workflow named 'generate-docs'. This separation makes each workflow specific to a single responsibility, simplifies the 'publish-to-pypi' workflow, and provides greater flexibility in controlling when and how documentation is built and deployed.
A new parameter named DD_CIVISIBILITY_ITR_ENABLED has been added into the `.github/workflows/publish-to-pypi.yml` workflow file. Its default value has been set as false. This configuration change affects the visibility settings of the CI/CD process.
This commit removes the .github/workflows/sphinx-test.yml file. The workflow was previously used to test Sphinx documentation generation and deployment but it is no longer required. This leads to a cleaner, leaner codebase and less unnecessary CI/CD activities.
The environment variable `DD_CIVISIBILITY_ITR_ENABLED` was removed from the GitHub Actions workflow for publishing to PyPi. This variable wasn't being used in the process, improving the readability and maintainability of the workflow configuration.
A pytestmark has been added to the tests in `tests/test_imports.py` and `tests/test_tools.py`. This decorator flags these tests as unskippable, providing context (datadog_itr_unskippable) as a reason. This will ensure these critical tests are always executed regardless of any conditions.
In the files 'test_imports.py' and 'test_tools.py' a function was added to shutdown the logging system when the program exits. This is done using the 'atexit' module. This change ensures that all logs are properly written and resources are cleaned up.
The update ensures that all Git tags are fetched before trying to get the latest version tag in the GitHub Actions workflow for generating documentation. It also updates the fall back version to 'v0.0.0' if no tag is found and exports the latest tag to an environment variable for further usage.
The updated workflow now separates the tasks into two steps: generating .rst files using sphinx-apidoc and building the documentation using sphinx-build. This way, the configuration for the release version has been incorporated directly into the sphinx-build command instead of modifying conf.py.
Kydoimos97
temporarily deployed
to
pypi-deployment
GitHub Actions
Inactive
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.