Skip to content

Commit

Permalink
Format markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
webpro committed Dec 8, 2023
1 parent c44b396 commit 179b734
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
12 changes: 6 additions & 6 deletions docs/git.md
Expand Up @@ -2,12 +2,12 @@

The Git plugin in release-it, by default, does the following:

1. [Prerequisite checks][1]
2. \[Files may be updated by other plugins and/or user commands/hooks]
3. `git add . --update`
4. `git commit -m "[git.commitMessage]"`
5. `git tag --annotate --message="[git.tagAnnotation]" [git.tagName]`
6. `git push [git.pushArgs] [git.pushRepo]`
1. [Prerequisite checks][1]
2. \[Files may be updated by other plugins and/or user commands/hooks]
3. `git add . --update`
4. `git commit -m "[git.commitMessage]"`
5. `git tag --annotate --message="[git.tagAnnotation]" [git.tagName]`
6. `git push [git.pushArgs] [git.pushRepo]`

When not in CI mode, release-it will ask for confirmation before each of the commit, tag, and push steps.

Expand Down
8 changes: 4 additions & 4 deletions docs/github-releases.md
Expand Up @@ -11,8 +11,8 @@ See the screenshot on the right for an overview of what release-it automates.

To add [GitHub releases][3] in your release-it flow, there are two options:

1. Automated. This requires a personal access token.
2. Manual. The GitHub web interface will be opened with pre-populated fields.
1. Automated. This requires a personal access token.
2. Manual. The GitHub web interface will be opened with pre-populated fields.

## Automated

Expand Down Expand Up @@ -168,8 +168,8 @@ release-it --no-increment --no-git --github.release --github.update --github.ass

## Comments

To submit a comment to each merged pull requests and closed issue that is part of the release, set `github.comments.submit` to
`true`. Here are the default settings:
To submit a comment to each merged pull requests and closed issue that is part of the release, set
`github.comments.submit` to `true`. Here are the default settings:

```json
{
Expand Down

0 comments on commit 179b734

Please sign in to comment.