docs: prepare the v5.x branch

rlespinasse · Oct 31, 2024 · 180df90 · 180df90
1 parent c6c92fe
commit 180df90
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ This GitHub Action will expose the slug/short values of [some GitHub environment
     - [The SHORT variables doesn't have the same lengths as before](#the-short-variables-doesnt-have-the-same-lengths-as-before)
     - [One of the environment variables doesn't work as intended](#one-of-the-environment-variables-doesnt-work-as-intended)
       - [Known environment variable conflicts](#known-environment-variable-conflicts)
-        - [GITHUB_REF_NAME](#github_ref_name)
+        - [GITHUB\_REF\_NAME](#github_ref_name)
     - [An action could not be found at the URI](#an-action-could-not-be-found-at-the-uri)
   - [Thanks for talking about us](#thanks-for-talking-about-us)
 
@@ -56,7 +56,7 @@ Add this in your workflow
 
 ```yaml
 - name: Inject slug/short variables
-  uses: rlespinasse/github-slug-action@v4
+  uses: rlespinasse/github-slug-action@v5
 ```
 
 <details>
@@ -67,7 +67,7 @@ Add this in your workflow
 
   ```yaml
   - name: Inject slug/short variables
-    uses: rlespinasse/github-slug-action@v4
+    uses: rlespinasse/github-slug-action@v5
     with:
       prefix: CI_
   ```
@@ -76,7 +76,7 @@ Add this in your workflow
 
   ```yaml
   - name: Inject slug/short variables
-    uses: rlespinasse/github-slug-action@v4
+    uses: rlespinasse/github-slug-action@v5
     with:
       slug-maxlength: 80 # Use 'nolimit' to remove use of a max length (Default to 63)
   ```
@@ -85,7 +85,7 @@ Add this in your workflow
 
   ```yaml
   - name: Inject slug/short variables
-    uses: rlespinasse/github-slug-action@v4
+    uses: rlespinasse/github-slug-action@v5
     with:
       short-length: 7 # By default it's up to git to decide, use 8 to have the v3.x behavior
   ```
@@ -102,14 +102,14 @@ Check for more [examples][examples] (OS usage, URL use, ...)
 
 The short sha length is not the same as previous version.
 
-- `v4` let git configuration decide of it (but you can override it),
-- `v3` and before, it's always a length of 8 characters.
+- Since `v4` let git configuration decide of it (but you can override it),
+- With `v3` and before, it's always a length of 8 characters.
 
 So to reproduce previous behavior, use
 
 ```yaml
 - name: Inject slug/short variables
-  uses: rlespinasse/github-slug-action@v4
+  uses: rlespinasse/github-slug-action@v5
   with:
     short-length: 8 # Same as v3 and before
 ```
@@ -213,7 +213,7 @@ A possible workaround is to use `prefix` input
 
 ```yaml
 - name: Inject slug/short variables
-  uses: rlespinasse/github-slug-action@v4
+  uses: rlespinasse/github-slug-action@v5
   with:
     prefix: CI_
 ```
@@ -235,7 +235,7 @@ If the `GIT_REFERENCE` value is
 - `v4.x` or after, the branch don't exists anymore following the [end-of-life for a branch](SECURITY.md#end-of-life-of-a-branch) security process.
 - `master`, the branch don't exists anymore, read more about it on the corresponding issue ([EOL issue][issue-15])
 
-Please, use the current major tag `v4` or a version tag (see [releases pages][releases]) in order to fix your workflow.
+Please, use the current major tag `v5` or a version tag (see [releases pages][releases]) in order to fix your workflow.
 
 ## Thanks for talking about us
 
@@ -245,7 +245,7 @@ In English :gb:
 - [Serverless Deploy Previews on GitHub Actions][article-3]
 - [Let's Build a Continuous Delivery and Branching Process with Github Actions, Vercel and Heroku][article-4]
 
-In French :fr: 
+In French :fr:
 
 - [Mettre en place une CI/CD Angular avec GitHub Actions & Netlify][article-1]
 - [Github Actions : enfin des pipelines accessibles aux développeurs][talk-1]
@@ -256,7 +256,7 @@ In Chinese :cn:
 
 > The next one is you. _Don't hesitate to add youself to one of these lists._
 
-[examples]: https://github.com/rlespinasse/github-slug-action/tree/v4.x/examples
+[examples]: https://github.com/rlespinasse/github-slug-action/tree/v5.x/examples
 [custom-variable]: https://github.com/rlespinasse/github-slug-action/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=
 [releases]: https://github.com/rlespinasse/github-slug-action/releases
 [issue-15]: https://github.com/rlespinasse/github-slug-action/issues/15

diff --git a/SECURITY.md b/SECURITY.md
@@ -4,7 +4,8 @@
 
 | Version | Supported          | End of Support | Branch | Specific Tags |
 | ------- | ------------------ | -------------- | ------ | ------------- |
-| 4.x     | :white_check_mark: |                | v4.x   | v4            |
+| 5.x     | :white_check_mark: |                | v5.x   | v5            |
+| 4.x     | :white_check_mark: | 2025-01-31     | v4.x   | v4            |
 | 3.x     | :x:                | 2024-01-31     |        | v3.x, v3      |
 | 2.x     | :x:                | 2021-04-05     |        | v2.x, 2.2.0   |
 | 1.x     | :x:                | 2021-04-05     |        | v1.1.x, 1.2.0 |

diff --git a/examples/linux-usage.yml b/examples/linux-usage.yml
@@ -6,8 +6,8 @@ jobs:
   usage:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: rlespinasse/github-slug-action@v4
+      - uses: actions/checkout@v4
+      - uses: rlespinasse/github-slug-action@v5
       - name: Output
         run: |
           echo "Partial variables"

diff --git a/examples/macos-usage.yml b/examples/macos-usage.yml
@@ -6,8 +6,8 @@ jobs:
   usage:
     runs-on: macos-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: rlespinasse/github-slug-action@v4
+      - uses: actions/checkout@v4
+      - uses: rlespinasse/github-slug-action@v5
       - name: Output
         run: |
           echo "Partial variables"

diff --git a/examples/url-use.yml b/examples/url-use.yml
@@ -6,15 +6,15 @@ jobs:
   as_subdomain:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: rlespinasse/github-slug-action@v4
+      - uses: actions/checkout@v4
+      - uses: rlespinasse/github-slug-action@v5
       - run: |
           ./deploy-application.sh --url "https://${{ env.GITHUB_REF_SLUG_URL }}.staging.app.example.com"
 
   as_resource_path:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: rlespinasse/github-slug-action@v4
+      - uses: actions/checkout@v4
+      - uses: rlespinasse/github-slug-action@v5
       - run: |
           ./deploy-application.sh --url "https://staging.app.example.com/${{ env.GITHUB_REF_SLUG_URL }}"
diff --git a/examples/windows-usage.yml b/examples/windows-usage.yml
@@ -6,8 +6,8 @@ jobs:
   usage:
     runs-on: windows-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: rlespinasse/github-slug-action@v4
+      - uses: actions/checkout@v4
+      - uses: rlespinasse/github-slug-action@v5
       - name: Output
         run: |
           echo "Partial variables"