docs(action): Demonstrate pinning actions

crates/typos-cli/Cargo.toml

@@ -25,6 +25,7 @@ pre-release-replacements = [
   {file="../../CHANGELOG.md", search="<!-- next-url -->", replace="<!-- next-url -->\n[Unreleased]: https://github.com/crate-ci/typos/compare/{{tag_name}}...HEAD", exactly=1},
   {file="../../action/entrypoint.sh", search="VERSION=.*", replace="VERSION={{version}}", min=1},
   {file="../../docs/pre-commit.md", search="rev: .*", replace="rev: {{tag_name}}", exactly=1},
+  {file="../../docs/github-action.md", search="uses: crate-ci/typos@.*", replace="uses: crate-ci/typos@{{tag_name}}", min=1},
   {file="../../setup.py", search="TYPOS_VERSION = .*", replace="TYPOS_VERSION = '{{version}}'", exactly=1},
 ]
 

docs/github-action.md

@@ -17,31 +17,28 @@ jobs:
       uses: actions/checkout@v4
 
     - name: Check spelling of file.txt
-      uses: crate-ci/typos@master
+      uses: crate-ci/typos@v1.28.4
       with:
         files: ./file.txt
 
     - name: Use custom config file
-      uses: crate-ci/typos@master
+      uses: crate-ci/typos@v1.28.4
       with:
         files: ./file.txt
         config: ./myconfig.toml
 
     - name: Ignore implicit configuration file
-      uses: crate-ci/typos@master
+      uses: crate-ci/typos@v1.28.4
       with:
         files: ./file.txt
         isolated: true
 
     - name: Writes changes in the local checkout
-      uses: crate-ci/typos@master
+      uses: crate-ci/typos@v1.28.4
       with:
         write_changes: true
 ```
 
-**Important** for any of the examples above, make sure that you choose
-a release or commit as a version, and not a branch (which is a moving target).
-
 ## Input
 
 | Name               | Description                                                     | Required | Default                                              |