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

refactor(docs): Improve examples in README and CLI #64

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

sergiotejon
Copy link
Contributor

CLI Example:

Increment the version of the project according to the conventional commits specification.

Usage:
  gommitizen bump [flags]

Examples:
# To bump the version of a project, run:
gommitizen bump
# This will bump the version of all projects in the current directory.
# If you want to bump the version of a specific project, run:
gommitizen bump -d <directory>
# This will bump the version of the project in the given directory.
# If you want to bump the version of projects and generate a changelog, run:
gommitizen bump -c
# This will bump the version of the projects and generate a changelog with the changes made since the last version.
# If you want to bump the version of project to a major version, run:
gommitizen bump -i major


Flags:
  -c, --changelog          generate the changelog for the newest version
  -h, --help               help for bump
  -i, --increment string   manually specify the desired increment {MAYOR, MINOR, PATCH}

Global Flags:
      --debug              Enable debug
  -d, --directory string   Select a directory to run the command

README example:

Examples of usage:

# To bump the version of a project, run:
gommitizen bump
# This will bump the version of all projects in the current directory.

# If you want to bump the version of a specific project, run:
gommitizen bump -d <directory>
# This will bump the version of the project in the given directory.

# If you want to bump the version of projects and generate a changelog, run:
gommitizen bump -c
# This will bump the version of the projects and generate a changelog with the changes made since the last version.

# If you want to bump the version of project to a major version, run:
gommitizen bump -i major

@sergiotejon sergiotejon requested a review from a team November 18, 2024 09:05
@sergiotejon sergiotejon self-assigned this Nov 18, 2024
@sergiotejon sergiotejon requested review from jaimeph, Muriano and dieloren and removed request for a team November 18, 2024 09:05
@sergiotejon sergiotejon linked an issue Nov 18, 2024 that may be closed by this pull request
@sergiotejon
Copy link
Contributor Author

Acabo de ver un cagada de un perfecto castellano:

  -i, --increment string   manually specify the desired increment {---> MAYOR <----, MINOR, PATCH}

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.

Fix examples in README.md and CLI help
1 participant