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

fix: script options auto update still can't find package #108

Merged
merged 1 commit into from
Aug 24, 2022

Conversation

maxrake
Copy link
Contributor

@maxrake maxrake commented Aug 23, 2022

The last release showed that the script options documentation auto-
update feature is still broken. Instead of creating an updated SVG
file(s) for the script options, a stack trace was produced as output
instead, with the following error:

ModuleNotFoundError: No module named 'phylum'

A fix was attempted with #107 but could not be fully verified until the
release was made. The belief now is that the python-semantic-release
package does not provide enough control over running commands with the
pre_commit_command option in the config file.

This change attempts to run the command in the release workflow, as it's
own step, before the Python semantic-release step. Everything needed
to run the rich-codex command exists in the workflow environment at
the point the step is run. The code for the python-semantic-release
package was examined and it appears to properly handle
additional/changed files with the include_additional_files config
option.

It would have been nice to have everything specified in the config, but
this approach should work. The next bugfix release will tell the tale...

Links (updated from #107):

The last release showed that the script options documentation auto-
update feature is still broken. Instead of creating an updated SVG
file(s) for the script options, a stack trace was produced as output
instead, with the following error:

`ModuleNotFoundError: No module named 'phylum'`

A fix was attempted with #107 but could not be fully verified until the
release was made. The belief now is that the `python-semantic-release`
package does not provide enough control over running commands with the
`pre_commit_command` option in the config file.

This change attempts to run the command in the release workflow, as it's
own step, *before* the Python semantic-release step. Everything needed
to run the `rich-codex` command exists in the workflow environment at
the point the step is run. The code for the `python-semantic-release`
package was examined and it appears to properly handle
additional/changed files with the `include_additional_files` config
option. It would have been nice to have everything specified in the
config, but this approach should work.
@maxrake maxrake self-assigned this Aug 23, 2022
@maxrake maxrake requested a review from a team as a code owner August 23, 2022 23:04
@maxrake maxrake requested a review from cd-work August 23, 2022 23:04
pyproject.toml Show resolved Hide resolved
@maxrake maxrake requested a review from cd-work August 24, 2022 13:06
@maxrake maxrake merged commit 967c1c0 into main Aug 24, 2022
@maxrake maxrake deleted the fix_auto_docs branch August 24, 2022 13:12
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.

2 participants