Skip to content

fix(cli): add error message of how to gather full error output#1116

Merged
codejedi365 merged 1 commit intopython-semantic-release:masterfrom
codejedi365:fix/add-user-msg-4-verbosity
Dec 9, 2024
Merged

fix(cli): add error message of how to gather full error output#1116
codejedi365 merged 1 commit intopython-semantic-release:masterfrom
codejedi365:fix/add-user-msg-4-verbosity

Conversation

@codejedi365
Copy link
Copy Markdown
Contributor

@codejedi365 codejedi365 commented Dec 9, 2024

Purpose

  • Adds a helpful debug message when fatal errors occur

Rationale

Ever since I added the exception catch and display of an error message I felt that people might not know what to do instead without me telling them to when they report the issue. This helps elevate that.

How did you test?

Manually validated the message returns correctly via the steps to verify. I did not think it was necessary to automate this piece as we don't mess with the __main__.py very much.

How to Verify

  1. Check out this PR
  2. Modify src/semantic_release/cli/commands/main.py and add raise Exception at the bottom of the file.
  3. Execute semantic-release changelog and you will see the error and a recommendation
  4. Execute semantic-release -vv changelog and you will see the stacktrace and error without any recommendation.

@codejedi365 codejedi365 merged commit ba85532 into python-semantic-release:master Dec 9, 2024
@codejedi365 codejedi365 deleted the fix/add-user-msg-4-verbosity branch December 9, 2024 01:22
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.

1 participant