From 1f38adcc343e234b4cbede36c6ec34ac8521b0a7 Mon Sep 17 00:00:00 2001 From: Phil Jay Date: Mon, 10 Aug 2026 16:01:01 +1000 Subject: [PATCH] Rework example to show tagging at the end Closes #42 --- README.md | 36 +++++++++++++++++++++++++++++++----- 1 file changed, 31 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 62f90a6..b1877d3 100644 --- a/README.md +++ b/README.md @@ -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 🔗