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.

Sign up for GitHub

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

Jump to bottom

feat: add verbose option #41

Merged
merged 1 commit into from
May 24, 2024
Merged

feat: add verbose option #41

merged 1 commit into from
May 24, 2024

Conversation

aj3sh
Copy link
Member

@aj3sh aj3sh commented May 18, 2024

Description

  • Added verbose option on cli.
  • Added verbose option on github actions.
  • Updated doc for verbose and quiet.

Related Issue

Fixes #16

Type of Change

Please mark the appropriate option below to describe the type of change your pull request introduces:

  • Bug fix
  • New feature
  • Enhancement
  • Documentation update
  • Refactor
  • Other (please specify)

Checklist

  • My pull request has a clear title and description.
  • I have used semantic commit messages.
    Examples: "fix: Fixed foobar bug", "feat(accounts): Added foobar feature".
  • I have added/updated the necessary documentation on README.md.
  • I have added appropriate test cases (if applicable) to ensure the changes are functioning correctly.

Additional Notes

Here are some output of verbose:

For a single commit message

starting commitlint
checking commit from hash
fetching commit message from hash a2dfbec
executing: git show --format=%B -s a2dfbec
This is an invalid message
linting commit message:
----------
This is an invalid message
----------
removing comments from the commit message
checking if the commit message is in ignored list
running detailed validators for linting
running validator HeaderLengthValidator
running validator PatternValidator
PatternValidator: validation failed
⧗ Input:
This is an invalid message

✖ Found 1 error(s).
- Commit message does not follow the Conventional Commits format.

For Multiple commit message

$ commitlint --from-hash 840b680 --verbose
starting commitlint
checking commit from hash range
fetching commit messages from hash range, from: 840b680, to: HEAD
fetching commit message from hash 840b680
executing: git show --format=%B -s 840b680
docs: add Conventional commit message info in README
executing: git log --format=%B========commit-delimiter======== --reverse 840b680..HEAD
Merge pull request #35 from aj3sh/conventional-commit-doc

docs: add Conventional commit message info in README========commit-delimiter========
ci: update release-please for release automation

- Added bot for creating Release PR
- Updated version information in __version__.py file
- Added pypi publish steps in the actions
========commit-delimiter========
Merge pull request #36 from aj3sh/release-please

ci: update release-please for release automation========commit-delimiter========
feat(cli): added the quiet option in cli
========commit-delimiter========
Merge pull request #37 from golesuman/feat/quiet-option-in-cli

========commit-delimiter========
test: refactor tests for system exit
========commit-delimiter========
feat: add verbose option

- Added verbose option on cli.
- Added verbose option on github actions.
- Updated doc for verbose and quiet.
========commit-delimiter========
This is an invalid message
========commit-delimiter========
feat: add verbose option

- Added verbose option on cli.
- Added verbose option on github actions.
- Updated doc for verbose and quiet.
========commit-delimiter========
Merge branch 'verbose' into test
========commit-delimiter========

linting commit message:
----------
docs: add Conventional commit message info in README
----------
removing comments from the commit message
checking if the commit message is in ignored list
running detailed validators for linting
running validator HeaderLengthValidator
running validator PatternValidator
lint success
linting commit message:
----------
Merge pull request #35 from aj3sh/conventional-commit-doc

docs: add Conventional commit message info in README
----------
removing comments from the commit message
checking if the commit message is in ignored list
commit message ignored, skipping lint
lint success
linting commit message:
----------
ci: update release-please for release automation

- Added bot for creating Release PR
- Updated version information in __version__.py file
- Added pypi publish steps in the actions
----------
removing comments from the commit message
checking if the commit message is in ignored list
running detailed validators for linting
running validator HeaderLengthValidator
running validator PatternValidator
lint success
linting commit message:
----------
Merge pull request #36 from aj3sh/release-please

ci: update release-please for release automation
----------
removing comments from the commit message
checking if the commit message is in ignored list
commit message ignored, skipping lint
lint success
linting commit message:
----------
feat(cli): added the quiet option in cli
----------
removing comments from the commit message
checking if the commit message is in ignored list
running detailed validators for linting
running validator HeaderLengthValidator
running validator PatternValidator
lint success
linting commit message:
----------
Merge pull request #37 from golesuman/feat/quiet-option-in-cli
----------
removing comments from the commit message
checking if the commit message is in ignored list
commit message ignored, skipping lint
lint success
linting commit message:
----------
test: refactor tests for system exit
----------
removing comments from the commit message
checking if the commit message is in ignored list
running detailed validators for linting
running validator HeaderLengthValidator
running validator PatternValidator
lint success
linting commit message:
----------
feat: add verbose option

- Added verbose option on cli.
- Added verbose option on github actions.
- Updated doc for verbose and quiet.
----------
removing comments from the commit message
checking if the commit message is in ignored list
running detailed validators for linting
running validator HeaderLengthValidator
running validator PatternValidator
lint success
linting commit message:
----------
This is an invalid message
----------
removing comments from the commit message
checking if the commit message is in ignored list
running detailed validators for linting
running validator HeaderLengthValidator
running validator PatternValidator
PatternValidator: validation failed
⧗ Input:
This is an invalid message

✖ Found 1 error(s).
- Commit message does not follow the Conventional Commits format.

linting commit message:
----------
feat: add verbose option

- Added verbose option on cli.
- Added verbose option on github actions.
- Updated doc for verbose and quiet.
----------
removing comments from the commit message
checking if the commit message is in ignored list
running detailed validators for linting
running validator HeaderLengthValidator
running validator PatternValidator
lint success

By submitting this pull request, I confirm that I have read and complied with the contribution guidelines of this project.

@aj3sh aj3sh added the enhancement New feature or request label May 18, 2024
@aj3sh aj3sh requested review from subashcs, sugat009 and golesuman May 18, 2024 05:50
golesuman
golesuman previously approved these changes May 18, 2024
View reviewed changes
@aj3sh
feat: add verbose option
4ec08c1 
- Added verbose option on cli.
- Added verbose option on github actions.
- Updated doc for verbose and quiet.
@aj3sh
Copy link
Member Author

aj3sh commented May 23, 2024

I have renamed output.py module to console.py.

@aj3sh aj3sh merged commit 8503ef5 into opensource-nepal:main May 24, 2024
3 checks passed
@aj3sh aj3sh deleted the verbose branch May 24, 2024 11:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@golesuman golesuman golesuman approved these changes

@sugat009 sugat009 sugat009 approved these changes

@subashcs subashcs Awaiting requested review from subashcs

Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add option for showing verbose
3 participants
@aj3sh @sugat009 @golesuman