fix(github): Fix format code step in publish sources action. #286
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
…ion for linting tools is changed. The docformatter is now run before isort and black. The change aims to ensure consistent documentation formatting across the codebase before other linting tools are executed. This is necessary for maintaining the code cleanliness and readability.
added 18 commits
November 28, 2023 15:14
Removed conditional check for `production_release` in publishing sources. This is done to allow publishing of generated sources even in non-production releases for earlier validation and testing.
Modified the `docformatter` command used in the Github Workflow action - generator-publish-sources.yaml by adding `--config pyproject.toml` flag to it. This change is made to include the configuration specified in pyproject.toml while formatting the release code, ensuring code consistency across the project.
Removed the `--black` flag from the `docformatter` command in the generator-publish-sources.yaml Github Workflow. This ensures the Python code formatter adheres more strictly to the configuration as specified in our project's pyproject.toml file, enhancing code consistency.
Added the `--black` flag to the `docformatter` command in the generator-publish-sources.yaml Github Workflow. This applies code auto-formatting according to Black's conventions, further enhancing code standardization across the project.
The command in the 'Format Code' step of our Github workflow has been updated to call the docformatter package as a python module. This change rectifies an issue where the docformatter couldn't be found when invoked via the sudo command, ensuring smooth execution of our code formatting in the future.
This reverts commit 1ef275f.
This reverts commit 7ec6992.
This reverts commit c5093e9.
This reverts commit f38b01e.
This reverts commit 3bc26c9.
This reverts commit cff4824.
This reverts commit 76bdc1a.
This reverts commit f155052.
…f execution for linting tools is changed." This reverts commit 1fcfc8b.
The docformatter was removed from the generator-publish-sources.yaml due to its redundancy. The formatting had been already carried out using 'isort' and 'black', rendering the 'docformatter' unnecessary. This streamlines code formatting in the project.
OmarAlJarrah
deleted the
OmarAlJarrah/fix-publish-sources-action-format-code-step
branch
OmarAlJarrah
restored the
OmarAlJarrah/fix-publish-sources-action-format-code-step
branch
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.
📝 Description
In the workflow for publishing generator sources, the order of execution for linting tools is changed.
The docformatter is now run before isort and black. The change aims to ensure consistent documentation formatting across the codebase before other linting tools are executed. This is necessary for maintaining the code cleanliness and readability.
🔗 Related Issues