Rework example to show tagging at the end

Closes #42
This commit is contained in:
Phil Jay
2026-08-10 16:21:09 +10:00
parent 72771d55b6
commit 1f38adcc34
+31 -5
View File
@@ -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]
@@ -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@v7.0.1
uses: actions/checkout@v7
- name: Get next version
uses: reecetech/version-increment@2026.8.3
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@v7.3.0
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 🔗