Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .github/workflows/test-and-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -166,3 +166,4 @@ jobs:
draft: false
prerelease: false
tag_name: "${{ steps.version.outputs.version }}"
generate_release_notes: true
40 changes: 33 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Version Increment ➕

This action calculates the next version based on existing Git tags.

Intentionally, this action does not create tags. It's suggested to use an
action dedicated to creating tags in a step following the successful steps
that make up your test, build and releasing process. See the example below.

## Use 📄

> [!NOTE]
Expand All @@ -9,22 +15,42 @@
### Example ⌨️

```yaml
name: Build and release

on:
push:
branches:
- main

jobs:
build-release:
permissions:
contents: write
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
uses: actions/checkout@v7

- name: Get next version
uses: reecetech/version-increment@2024.10.1
uses: reecetech/version-increment@2026.8.4
id: version
with:
scheme: semver
increment: patch

# Example building, using the `version` output from `version-increment`
- name: Build image
uses: docker/build-push-action@v2
uses: docker/build-push-action@v7
with:
push: false
tags: "example/application:${{ steps.version.outputs.version }}"
context: .

- name: Create tag & GitHub release
uses: softprops/action-gh-release@v3
with:
draft: false
generate_release_notes: true
prerelease: false
tag_name: ${{ steps.version.outputs.version }}
```

#### API mode 🔗
Expand All @@ -34,7 +60,7 @@ use the API mode:

```yaml
- name: Get next version
uses: reecetech/version-increment@2024.10.1
uses: reecetech/version-increment@2026.8.4
id: version
with:
use_api: true
Expand Down Expand Up @@ -106,7 +132,7 @@ release branch name as an input. For example:

```yaml
- name: Get next version
uses: reecetech/version-increment@2023.10.1
uses: reecetech/version-increment@2026.8.4
id: version
with:
release_branch: publish
Expand Down
Loading