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

Readme #249

Merged
merged 2 commits into from
Feb 7, 2024
Merged

Readme #249

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5dd9922
docs(README): Bump version of action to `v5`
TriPSs Jan 11, 2024
ac4d06e
docs(README): Bump checkout action version
TriPSs Jan 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ permissions:
contents: write

- name: Conventional Changelog Action
uses: TriPSs/conventional-changelog-action@v3
uses: TriPSs/conventional-changelog-action@v5
with:
github-token: ${{ secrets.github_token }}
```
Expand All @@ -135,7 +135,7 @@ Overwrite everything

```yaml
- name: Conventional Changelog Action
uses: TriPSs/conventional-changelog-action@v3
uses: TriPSs/conventional-changelog-action@v5
with:
github-token: ${{ secrets.github_token }}
git-message: 'chore(release): {version}'
Expand All @@ -157,7 +157,7 @@ No file changelog

```yaml
- name: Conventional Changelog Action
uses: TriPSs/conventional-changelog-action@v3
uses: TriPSs/conventional-changelog-action@v5
with:
github-token: ${{ secrets.github_token }}
output-file: "false"
Expand All @@ -167,7 +167,7 @@ Tag only

```yaml
- name: Conventional Changelog Action
uses: TriPSs/conventional-changelog-action@v3
uses: TriPSs/conventional-changelog-action@v5
with:
github-token: ${{ secrets.github_token }}
skip-commit: "true"
Expand All @@ -178,12 +178,12 @@ In CI you might not want to pull extra changes before tagging e.g. if running a

```yaml
- name: Checkout repository
uses: actions/checkout@v2
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Conventional Changelog Action
uses: TriPSs/conventional-changelog-action@v3
uses: TriPSs/conventional-changelog-action@v5
with:
github-token: ${{ secrets.github_token }}
skip-git-pull: "true"
Expand All @@ -193,7 +193,7 @@ Use a custom file for versioning

```yaml
- name: Conventional Changelog Action
uses: TriPSs/conventional-changelog-action@v3
uses: TriPSs/conventional-changelog-action@v5
with:
github-token: ${{ secrets.github_token }}
version-file: "my-custom-file.yaml"
Expand All @@ -203,7 +203,7 @@ Use a pre-commit hook

```yaml
- name: Conventional Changelog Action
uses: TriPSs/conventional-changelog-action@v3
uses: TriPSs/conventional-changelog-action@v5
with:
github-token: ${{ secrets.github_token }}
pre-commit: some/path/pre-commit.js
Expand All @@ -214,7 +214,7 @@ Github releases
```yaml
- name: Conventional Changelog Action
id: changelog
uses: TriPSs/conventional-changelog-action@v3
uses: TriPSs/conventional-changelog-action@v5
with:
github-token: ${{ secrets.github_token }}
output-file: "false"
Expand All @@ -237,12 +237,12 @@ To make full use of the Deploy Key, you must set the value of github-token input

```yaml
- name: Checkout GitHub Action
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
ssh-key: ${{ secrets.SSH_DEPLOY_KEY }}
- name: Conventional Changelog Action
id: changelog
uses: TriPSs/conventional-changelog-action@v4
uses: TriPSs/conventional-changelog-action@v5
with:
github-token: ""
```
Expand Down
Loading