Update docs and release reference (#185)

Co-authored-by: ChristophShyper <45788587+ChristophShyper@users.noreply.github.com>

Author: github-actions[bot]

.dockerignore

@@ -5,3 +5,4 @@
 !LICENSE
 !README.md
 !entrypoint.sh
+!action-pull-request.png

.github/workflows/pull-request.yml

@@ -77,7 +77,7 @@ jobs:
           curl -LsS https://raw.githubusercontent.com/devops-infra/.github/master/PULL_REQUEST_TEMPLATE.md -o .tmp/PULL_REQUEST_TEMPLATE.md
 
       - name: Create Pull Request
-        uses: devops-infra/action-pull-request@v0.6.0
+        uses: devops-infra/action-pull-request@v0.6
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           assignee: ${{ github.actor }}

Dockerfile

@@ -43,7 +43,7 @@ ARG AUTHOR="Krzysztof Szyper / ChristophShyper / biotyk@mail.com"
 ARG HOMEPAGE="https://shyper.pro"
 ARG BUILD_DATE=2020-04-01T00:00:00Z
 ARG VCS_REF=abcdef1
-ARG VERSION=v0.0
+ARG VERSION
 LABEL \
   com.github.actions.name="${NAME}" \
   com.github.actions.author="${AUTHOR}" \

README.md

@@ -1,11 +1,24 @@
-# GitHub Action for creating Pull Requests
+# 🚀 GitHub Action for creating Pull Requests
 
 **GitHub Action that will create a pull request from the currently selected branch.**
 
 **Useful in combination with my other action [devops-infra/action-commit-push](https://github.com/devops-infra/action-commit-push).**
 
+
+## 📦 Available on
 Dockerized as [devopsinfra/action-pull-request](https://hub.docker.com/repository/docker/devopsinfra/action-pull-request).
-Built from [devops-infra/action-pull-request](https://github.com/devops-infra/action-pull-request).
+Built from [ghcr.io/devops-infra//action-pull-request](https://github.com/devops-infra/pkgs/container/template-action).
+
+
+## ✨ Features
+* Creates pull request if triggered from a current branch or any specified by `source_branch` to a `target_branch`
+* Title and body of a pull request can be specified with `title` and `body`
+* Can assign `assignee`, `reviewer`, one or more `label`, a `milestone` or mark it as a `draft`
+* Can replace any `old_string` inside a pull request template with a `new_string`. Or put commits' subjects in place of `old_string`
+* When `get_diff` is `true` will add list of commits in place of `<!-- Diff commits -->` and list of modified files in place of `<!-- Diff files -->` in a pull request template
+* When `allow_no_diff` is set to true will continue execution and create pull request even if both branches have no differences, e.g. having only a merge commit
+* Supports both `amd64` and `arm64` architectures
+
 
 ## Badge swag
 [
@@ -22,31 +35,33 @@ Built from [devops-infra/action-pull-request](https://github.com/devops-infra/ac
 ![Docker Pulls](https://img.shields.io/docker/pulls/devopsinfra/action-pull-request?color=blue&label=Pulls&logo=docker&style=plastic)
 ](https://hub.docker.com/r/devopsinfra/action-pull-request "shields.io")
 
-## Reference
+
+## 📖 API Reference
 
 ```yaml
-- name: Run the Action
-  uses: devops-infra/action-pull-request@v0.6.0
-  with:
-    github_token: ${{ secrets.GITHUB_TOKEN }}
-    source_branch: development
-    target_branch: master
-    title: My pull request
-    template: .github/PULL_REQUEST_TEMPLATE.md
-    body: "**Automated pull request**"
-    reviewer: octocat
-    assignee: octocat
-    label: enhancement
-    milestone: My milestone
-    draft: true
-    old_string: "<!-- Add your description here -->"
-    new_string: "** Automatic pull request**"
-    get_diff: true
-    ignore_users: "dependabot"
-    allow_no_diff: false
+    - name: Run the Action
+      uses: devops-infra/action-pull-request@v0.6
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        source_branch: development
+        target_branch: master
+        title: My pull request
+        template: .github/PULL_REQUEST_TEMPLATE.md
+        body: "**Automated pull request**"
+        reviewer: octocat
+        assignee: octocat
+        label: enhancement
+        milestone: My milestone
+        draft: true
+        old_string: "<!-- Add your description here -->"
+        new_string: "** Automatic pull request**"
+        get_diff: true
+        ignore_users: "dependabot"
+        allow_no_diff: false
 ```
 
-## Inputs
+
+### 🔧 Input Parameters
 
 | Input Variable | Required | Default                       | Description                                                                                                             |
 |----------------|----------|-------------------------------|-------------------------------------------------------------------------------------------------------------------------|
@@ -67,24 +82,16 @@ Built from [devops-infra/action-pull-request](https://github.com/devops-infra/ac
 | ignore_users   | No       | `"dependabot"`                | List of users to ignore, comma separated                                                                                |
 | allow_no_diff  | No       | `false`                       | Allows to continue on merge commits with no diffs                                                                       |
 
-## Outputs
+
+### 🔧 Input Parameters
 
 | Output    | Description                   |
 |-----------|-------------------------------|
 | url       | Pull request URL              |
 | pr_number | Number of GitHub pull request |
 
-## Features
 
-* Creates pull request if triggered from a current branch or any specified by `source_branch` to a `target_branch`
-* Title and body of a pull request can be specified with `title` and `body`
-* Can assign `assignee`, `reviewer`, one or more `label`, a `milestone` or mark it as a `draft`
-* Can replace any `old_string` inside a pull request template with a `new_string`. Or put commits' subjects in place of `old_string`
-* When `get_diff` is `true` will add list of commits in place of `<!-- Diff commits -->` and list of modified files in place of `<!-- Diff files -->` in a pull request template
-* When `allow_no_diff` is set to true will continue execution and create pull request even if both branches have no differences, e.g. having only a merge commit
-* Supports both `amd64` and `arm64` architectures
-
-### How get_diff works
+### ➿ How get_diff works
 
 In previous versions occurrences of following strings in a template result with replacing them with list of commits and list of modified files (`<!-- Diff commits -->` and `<!-- Diff files -->`).
 
@@ -98,14 +105,16 @@ If your template uses old comment strings it will try to adjust them in the pull
 
 **CAUTION**: Remember to not use default `fetch-depth` for [actions/checkout](https://github.com/actions/checkout) action. Rather set it to `0` - see example below.
 
-## Examples
+
+## 💻 Usage Examples
 
 Red areas show fields that can be dynamically expanded based on commits to the current branch.
 Blue areas show fields that can be set in action configuration.
 
 ![Example screenshot](https://github.com/devops-infra/action-pull-request/raw/master/action-pull-request.png)
 
-### Simple
+
+### 📝 Basic Example
 
 Create pull request for non-master branches:
 
@@ -121,13 +130,14 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
       - name: Create pull request
-        uses: devops-infra/action-pull-request@v0.6.0
+        uses: devops-infra/action-pull-request@v0.6
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           title: Automatic pull request
 ```
 
-### Advanced
+
+### 🔀 Advanced Example
 
 Use first commit as a title and part of body, add a label based on a branch name, add git differences in the template:
 
@@ -146,7 +156,7 @@ jobs:
           fetch-depth: 0
       - name: Run the Action
         if: startsWith(github.ref, 'refs/heads/feature')
-        uses: devops-infra/action-pull-request@v0.6.0
+        uses: devops-infra/action-pull-request@v0.6
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           title: ${{ github.event.commits[0].message }}
@@ -158,24 +168,35 @@ jobs:
           get_diff: true
 ```
 
-## Available images
 
-| Registry                                                                               | Image                                      |
-|----------------------------------------------------------------------------------------|--------------------------------------------|
-| [Docker Hub](https://hub.docker.com/repository/docker/devopsinfra/action-pull-request) | `devopsinfra/action-pull-request`          |
-| [GitHub Packages](https://github.com/devops-infra/action-pull-request/packages)        | `ghcr.io/devops-infra/action-pull-request` |
+## 🏷️ Version Tags: vX, vX.Y, vX.Y.Z
+
+This action supports three tag levels for flexible versioning:
+
+- **`vX`**: Always points to the latest patch of a major version (e.g., `v1` → `v1.2.3`).  
+  _Benefit: Get all latest fixes for a major version automatically._
+
+- **`vX.Y`**: Always points to the latest patch of a minor version (e.g., `v1.2` → `v1.2.3`).  
+  _Benefit: Stay on a minor version, always up-to-date with bugfixes._
+
+- **`vX.Y.Z`**: Fixed to a specific release (e.g., `v1.2.3`).  
+  _Benefit: Full reproducibility—never changes._
+
+**Use the tag depth that matches your stability needs.**
+
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request. Refer to the [CONTRIBUTING](https://github.com/devops-infra/.github/blob/master/CONTRIBUTING.md) for guidelines.
 
-Following platforms for those images are supported:
 
-| OS    | Architecture |
-|-------|--------------|
-| Linux | `amd64`      |
-| Linux | `arm64`      |
+## 📄 License
 
-## Other DevOps-Infra actions
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
-Check [devops-infra](https://github.com/devops-infra) for other GitHub Actions.
 
-## License
+## 💬 Support
 
-[MIT License](LICENSE)
+If you have any questions or need help, please:
+- 📝 Create an [issue](https://github.com/devops-infra/template-action/issues)
+- 🌟 Star this repository if you find it useful!