Compare commits

...

10 Commits

Author SHA1 Message Date
Vin
00198f8992 fix: use environment file to manage outputs
Co-authored-by: Vin <vin@8sistemas.com>
Co-authored-by: Romain Lespinasse <romain.lespinasse@gmail.com>
2022-10-15 20:56:22 +02:00
Romain Lespinasse
9c3571fd3d feat: generate proper git tag 2022-10-02 22:52:40 +02:00
Romain Lespinasse
0141d9b38d fix: remove trailing hypen if any after cut 2022-06-16 19:55:01 +02:00
rlespinasse
33cd7a701d docs(README): improve the overwrite troubleshooting section 2022-04-16 19:25:44 +02:00
rlespinasse
2c5a627861 fix(GITHUB_REF_NAME): correctly fill the variable on pull request events 2022-04-16 19:25:44 +02:00
Romain Lespinasse
aa95092e35 docs: remove badges 2022-04-09 08:12:02 +02:00
rlespinasse
1615fcb48b fix: preserve dash groups 2022-04-08 23:48:02 +02:00
rlespinasse
812bd42f94 fix: remove underscore from URL-compliant slugs 2022-04-08 23:48:02 +02:00
Romain Lespinasse
6839855732 ci: rename workflow 2022-04-07 20:47:54 +02:00
rlespinasse
53459a86e2 ci: improve workflow 2022-03-24 12:59:58 +01:00
4 changed files with 274 additions and 182 deletions

View File

@@ -1,7 +1,8 @@
name: Github Slug Action testing name: '[v4] Test and Release'
on: [push, pull_request] on: [push, pull_request]
jobs: jobs:
os-testing: check-v3compatibility:
name: 'Check v3 compatibility'
strategy: strategy:
fail-fast: false fail-fast: false
matrix: matrix:
@@ -10,29 +11,24 @@ jobs:
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v3 uses: actions/checkout@v3
- name: Load using v3.x
uses: rlespinasse/github-slug-action@v3.x
- name: Load using v4.x with prefix - name: Load using v4.x with prefix
uses: ./ uses: ./
with: with:
prefix: V4_ prefix: V4_
short-length: 8 short-length: 8
- name: Load using v3.x
uses: rlespinasse/github-slug-action@v3.x
- name: Validate // Partial variables - name: Validate // Partial variables
run: | run: |
echo "repository owner : ${{ env.V4_GITHUB_REPOSITORY_OWNER_PART }}"
echo "repository name : ${{ env.V4_GITHUB_REPOSITORY_NAME_PART }}"
[[ "${{ env.GITHUB_REPOSITORY_OWNER_PART }}" == "${{ env.V4_GITHUB_REPOSITORY_OWNER_PART }}" ]] [[ "${{ env.GITHUB_REPOSITORY_OWNER_PART }}" == "${{ env.V4_GITHUB_REPOSITORY_OWNER_PART }}" ]]
[[ "${{ env.GITHUB_REPOSITORY_NAME_PART }}" == "${{ env.V4_GITHUB_REPOSITORY_NAME_PART }}" ]] [[ "${{ env.GITHUB_REPOSITORY_NAME_PART }}" == "${{ env.V4_GITHUB_REPOSITORY_NAME_PART }}" ]]
shell: bash shell: bash
- name: Validate // Slug variables - name: Validate // Slug variables
run: | run: |
echo "repository : ${{ env.V4_GITHUB_REPOSITORY_SLUG }}"
echo "repository owner : ${{ env.V4_GITHUB_REPOSITORY_OWNER_PART_SLUG }}"
echo "repository name : ${{ env.V4_GITHUB_REPOSITORY_NAME_PART_SLUG }}"
echo "ref : ${{ env.V4_GITHUB_REF_SLUG }}"
echo "head ref : ${{ env.V4_GITHUB_HEAD_REF_SLUG }}"
echo "base ref : ${{ env.V4_GITHUB_BASE_REF_SLUG }}"
echo "event ref : ${{ env.V4_GITHUB_EVENT_REF_SLUG }}"
[[ "${{ env.GITHUB_REPOSITORY_SLUG }}" == "${{ env.V4_GITHUB_REPOSITORY_SLUG }}" ]] [[ "${{ env.GITHUB_REPOSITORY_SLUG }}" == "${{ env.V4_GITHUB_REPOSITORY_SLUG }}" ]]
[[ "${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG }}" == "${{ env.V4_GITHUB_REPOSITORY_OWNER_PART_SLUG }}" ]] [[ "${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG }}" == "${{ env.V4_GITHUB_REPOSITORY_OWNER_PART_SLUG }}" ]]
[[ "${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG }}" == "${{ env.V4_GITHUB_REPOSITORY_NAME_PART_SLUG }}" ]] [[ "${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG }}" == "${{ env.V4_GITHUB_REPOSITORY_NAME_PART_SLUG }}" ]]
@@ -43,13 +39,6 @@ jobs:
shell: bash shell: bash
- name: Validate // Slug variables (Case Sensitive) - name: Validate // Slug variables (Case Sensitive)
run: | run: |
echo "repository : ${{ env.V4_GITHUB_REPOSITORY_SLUG_CS }}"
echo "repository owner : ${{ env.V4_GITHUB_REPOSITORY_OWNER_PART_SLUG_CS }}"
echo "repository name : ${{ env.V4_GITHUB_REPOSITORY_NAME_PART_SLUG_CS }}"
echo "ref : ${{ env.V4_GITHUB_REF_SLUG_CS }}"
echo "head ref : ${{ env.V4_GITHUB_HEAD_REF_SLUG_CS }}"
echo "base ref : ${{ env.V4_GITHUB_BASE_REF_SLUG_CS }}"
echo "event ref : ${{ env.V4_GITHUB_EVENT_REF_SLUG_CS }}"
[[ "${{ env.GITHUB_REPOSITORY_SLUG_CS }}" == "${{ env.V4_GITHUB_REPOSITORY_SLUG_CS }}" ]] [[ "${{ env.GITHUB_REPOSITORY_SLUG_CS }}" == "${{ env.V4_GITHUB_REPOSITORY_SLUG_CS }}" ]]
[[ "${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG_CS }}" == "${{ env.V4_GITHUB_REPOSITORY_OWNER_PART_SLUG_CS }}" ]] [[ "${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG_CS }}" == "${{ env.V4_GITHUB_REPOSITORY_OWNER_PART_SLUG_CS }}" ]]
[[ "${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG_CS }}" == "${{ env.V4_GITHUB_REPOSITORY_NAME_PART_SLUG_CS }}" ]] [[ "${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG_CS }}" == "${{ env.V4_GITHUB_REPOSITORY_NAME_PART_SLUG_CS }}" ]]
@@ -60,13 +49,6 @@ jobs:
shell: bash shell: bash
- name: Validate // Slug URL variables - name: Validate // Slug URL variables
run: | run: |
echo "repository : ${{ env.V4_GITHUB_REPOSITORY_SLUG_URL }}"
echo "repository owner : ${{ env.V4_GITHUB_REPOSITORY_OWNER_PART_SLUG_URL }}"
echo "repository name : ${{ env.V4_GITHUB_REPOSITORY_NAME_PART_SLUG_URL }}"
echo "ref : ${{ env.V4_GITHUB_REF_SLUG_URL }}"
echo "head ref : ${{ env.V4_GITHUB_HEAD_REF_SLUG_URL }}"
echo "base ref : ${{ env.V4_GITHUB_BASE_REF_SLUG_URL }}"
echo "event ref : ${{ env.V4_GITHUB_EVENT_REF_SLUG_URL }}"
[[ "${{ env.GITHUB_REPOSITORY_SLUG_URL }}" == "${{ env.V4_GITHUB_REPOSITORY_SLUG_URL }}" ]] [[ "${{ env.GITHUB_REPOSITORY_SLUG_URL }}" == "${{ env.V4_GITHUB_REPOSITORY_SLUG_URL }}" ]]
[[ "${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG_URL }}" == "${{ env.V4_GITHUB_REPOSITORY_OWNER_PART_SLUG_URL }}" ]] [[ "${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG_URL }}" == "${{ env.V4_GITHUB_REPOSITORY_OWNER_PART_SLUG_URL }}" ]]
[[ "${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG_URL }}" == "${{ env.V4_GITHUB_REPOSITORY_NAME_PART_SLUG_URL }}" ]] [[ "${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG_URL }}" == "${{ env.V4_GITHUB_REPOSITORY_NAME_PART_SLUG_URL }}" ]]
@@ -77,13 +59,6 @@ jobs:
shell: bash shell: bash
- name: Validate // Slug URL variables (Case Sensitive) - name: Validate // Slug URL variables (Case Sensitive)
run: | run: |
echo "repository : ${{ env.V4_GITHUB_REPOSITORY_SLUG_URL_CS }}"
echo "repository owner : ${{ env.V4_GITHUB_REPOSITORY_OWNER_PART_SLUG_URL_CS }}"
echo "repository name : ${{ env.V4_GITHUB_REPOSITORY_NAME_PART_SLUG_URL_CS }}"
echo "ref : ${{ env.V4_GITHUB_REF_SLUG_URL_CS }}"
echo "head ref : ${{ env.V4_GITHUB_HEAD_REF_SLUG_URL_CS }}"
echo "base ref : ${{ env.V4_GITHUB_BASE_REF_SLUG_URL_CS }}"
echo "event ref : ${{ env.V4_GITHUB_EVENT_REF_SLUG_URL_CS }}"
[[ "${{ env.GITHUB_REPOSITORY_SLUG_URL_CS }}" == "${{ env.V4_GITHUB_REPOSITORY_SLUG_URL_CS }}" ]] [[ "${{ env.GITHUB_REPOSITORY_SLUG_URL_CS }}" == "${{ env.V4_GITHUB_REPOSITORY_SLUG_URL_CS }}" ]]
[[ "${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG_URL_CS }}" == "${{ env.V4_GITHUB_REPOSITORY_OWNER_PART_SLUG_URL_CS }}" ]] [[ "${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG_URL_CS }}" == "${{ env.V4_GITHUB_REPOSITORY_OWNER_PART_SLUG_URL_CS }}" ]]
[[ "${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG_URL_CS }}" == "${{ env.V4_GITHUB_REPOSITORY_NAME_PART_SLUG_URL_CS }}" ]] [[ "${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG_URL_CS }}" == "${{ env.V4_GITHUB_REPOSITORY_NAME_PART_SLUG_URL_CS }}" ]]
@@ -92,28 +67,55 @@ jobs:
[[ "${{ env.GITHUB_BASE_REF_SLUG_URL_CS }}" == "${{ env.V4_GITHUB_BASE_REF_SLUG_URL_CS }}" ]] [[ "${{ env.GITHUB_BASE_REF_SLUG_URL_CS }}" == "${{ env.V4_GITHUB_BASE_REF_SLUG_URL_CS }}" ]]
[[ "${{ env.GITHUB_EVENT_REF_SLUG_URL_CS }}" == "${{ env.V4_GITHUB_EVENT_REF_SLUG_URL_CS }}" ]] [[ "${{ env.GITHUB_EVENT_REF_SLUG_URL_CS }}" == "${{ env.V4_GITHUB_EVENT_REF_SLUG_URL_CS }}" ]]
shell: bash shell: bash
- name: Validate // Ref Name - name: Validate // Ref Name
run: | run: |
echo "raw : ${{ env.V4_GITHUB_REF_NAME }}"
echo "slug : ${{ env.V4_GITHUB_REF_NAME_SLUG }}"
echo "slug url : ${{ env.V4_GITHUB_REF_NAME_SLUG_URL }}"
echo "slug (Case Sensitive) : ${{ env.V4_GITHUB_REF_NAME_SLUG_CS }}"
echo "slug url (Case Sensitive) : ${{ env.V4_GITHUB_REF_NAME_SLUG_URL_CS }}"
[[ "${{ env.GITHUB_REF_NAME }}" == "${{ env.V4_GITHUB_REF_NAME }}" ]] [[ "${{ env.GITHUB_REF_NAME }}" == "${{ env.V4_GITHUB_REF_NAME }}" ]]
[[ "${{ env.GITHUB_REF_NAME_SLUG }}" == "${{ env.V4_GITHUB_REF_NAME_SLUG }}" ]] [[ "${{ env.GITHUB_REF_NAME_SLUG }}" == "${{ env.V4_GITHUB_REF_NAME_SLUG }}" ]]
[[ "${{ env.GITHUB_REF_NAME_SLUG_URL }}" == "${{ env.V4_GITHUB_REF_NAME_SLUG_URL }}" ]] [[ "${{ env.GITHUB_REF_NAME_SLUG_URL }}" == "${{ env.V4_GITHUB_REF_NAME_SLUG_URL }}" ]]
[[ "${{ env.GITHUB_REF_NAME_SLUG_CS }}" == "${{ env.V4_GITHUB_REF_NAME_SLUG_CS }}" ]] [[ "${{ env.GITHUB_REF_NAME_SLUG_CS }}" == "${{ env.V4_GITHUB_REF_NAME_SLUG_CS }}" ]]
[[ "${{ env.GITHUB_REF_NAME_SLUG_URL_CS }}" == "${{ env.V4_GITHUB_REF_NAME_SLUG_URL_CS }}" ]] [[ "${{ env.GITHUB_REF_NAME_SLUG_URL_CS }}" == "${{ env.V4_GITHUB_REF_NAME_SLUG_URL_CS }}" ]]
shell: bash shell: bash
- name: Validate // Short SHA variables - name: Validate // Short SHA variables
run: | run: |
echo "sha : ${{ env.V4_GITHUB_SHA_SHORT }}"
echo "pull request sha : ${{ env.V4_GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}"
[[ "${{ env.GITHUB_SHA_SHORT }}" == "${{ env.V4_GITHUB_SHA_SHORT }}" ]] [[ "${{ env.GITHUB_SHA_SHORT }}" == "${{ env.V4_GITHUB_SHA_SHORT }}" ]]
[[ "${{ env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}" == "${{ env.V4_GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}" ]] [[ "${{ env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}" == "${{ env.V4_GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}" ]]
shell: bash shell: bash
os-testing-slug-maxlength: check-v3compatibility-without-checkout:
name: 'Check v3 compatibility (without checkout)'
needs:
- check-v3compatibility
strategy:
fail-fast: false
matrix:
os: [macos-latest, ubuntu-latest, windows-latest]
runs-on: ${{ matrix.os }}
steps:
- name: Checkout
uses: actions/checkout@v3
with:
path: this-action
ref: ${{ github.ref }}
- name: Load using v4.x with prefix
uses: ./this-action
with:
prefix: V4_
short-length: 8
- name: Load using v3.x
uses: rlespinasse/github-slug-action@v3.x
- name: Validate // Short SHA variables
run: |
[[ "${{ env.GITHUB_SHA_SHORT }}" == "${{ env.V4_GITHUB_SHA_SHORT }}" ]]
[[ "${{ env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}" == "${{ env.V4_GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}" ]]
shell: bash
display:
name: 'Display produced variables'
strategy: strategy:
fail-fast: false fail-fast: false
matrix: matrix:
@@ -123,62 +125,104 @@ jobs:
- name: Checkout - name: Checkout
uses: actions/checkout@v3 uses: actions/checkout@v3
# Test 1 - name: Load using v4.x
- name: Using correct slug max length
uses: ./ uses: ./
with:
prefix: "CML_" - name: Partial variables
slug-maxlength: 1
- name: Using correct max length // Validate that all slug variables lengths are equals or under the slug-maxlength
run: | run: |
env | grep "CML_" | grep "_SLUG" | cut -d"=" -f2 | while read -r value; do [ "$(echo "$value" | wc -m)" -le 2 ] ; done echo "repository owner : ${{ env.GITHUB_REPOSITORY_OWNER_PART }}"
echo "repository name : ${{ env.GITHUB_REPOSITORY_NAME_PART }}"
shell: bash shell: bash
# Test 2 - name: Slug variables
- name: Using wrong slug max length
id: using-wrong-slug-max-length
uses: ./
with:
prefix: "WML_"
slug-maxlength: "wrong"
continue-on-error: true
- name: Using wrong slug max length // Validate that the action end with an error
run: | run: |
[[ "$(env | grep "WML_" | grep "_SLUG" | wc -l)" -eq 0 ]] echo "repository : ${{ env.GITHUB_REPOSITORY_SLUG }}"
[[ "${{ steps.using-wrong-slug-max-length.outcome }}" == "failure" ]] echo "repository owner : ${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG }}"
[[ "${{ steps.using-wrong-slug-max-length.conclusion }}" == "success" ]] echo "repository name : ${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG }}"
echo "ref : ${{ env.GITHUB_REF_SLUG }}"
echo "head ref : ${{ env.GITHUB_HEAD_REF_SLUG }}"
echo "base ref : ${{ env.GITHUB_BASE_REF_SLUG }}"
echo "event ref : ${{ env.GITHUB_EVENT_REF_SLUG }}"
shell: bash
- name: Slug variables (Case Sensitive)
run: |
echo "repository : ${{ env.GITHUB_REPOSITORY_SLUG_CS }}"
echo "repository owner : ${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG_CS }}"
echo "repository name : ${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG_CS }}"
echo "ref : ${{ env.GITHUB_REF_SLUG_CS }}"
echo "head ref : ${{ env.GITHUB_HEAD_REF_SLUG_CS }}"
echo "base ref : ${{ env.GITHUB_BASE_REF_SLUG_CS }}"
echo "event ref : ${{ env.GITHUB_EVENT_REF_SLUG_CS }}"
shell: bash
- name: Slug URL variables
run: |
echo "repository : ${{ env.GITHUB_REPOSITORY_SLUG_URL }}"
echo "repository owner : ${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG_URL }}"
echo "repository name : ${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG_URL }}"
echo "ref : ${{ env.GITHUB_REF_SLUG_URL }}"
echo "head ref : ${{ env.GITHUB_HEAD_REF_SLUG_URL }}"
echo "base ref : ${{ env.GITHUB_BASE_REF_SLUG_URL }}"
echo "event ref : ${{ env.GITHUB_EVENT_REF_SLUG_URL }}"
shell: bash
- name: Slug URL variables (Case Sensitive)
run: |
echo "repository : ${{ env.GITHUB_REPOSITORY_SLUG_URL_CS }}"
echo "repository owner : ${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG_URL_CS }}"
echo "repository name : ${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG_URL_CS }}"
echo "ref : ${{ env.GITHUB_REF_SLUG_URL_CS }}"
echo "head ref : ${{ env.GITHUB_HEAD_REF_SLUG_URL_CS }}"
echo "base ref : ${{ env.GITHUB_BASE_REF_SLUG_URL_CS }}"
echo "event ref : ${{ env.GITHUB_EVENT_REF_SLUG_URL_CS }}"
shell: bash shell: bash
# Test 3 - name: Ref Name
- name: Using empty slug max length
id: using-empty-slug-max-length
uses: ./
with:
prefix: "EML_"
slug-maxlength: ""
continue-on-error: true
- name: Using empty slug max length // Validate that the action end with an error
run: | run: |
[[ "$(env | grep "EML_" | grep "_SLUG" | wc -l)" -eq 0 ]] echo "raw : ${{ env.GITHUB_REF_NAME }}"
[[ "${{ steps.using-empty-slug-max-length.outcome }}" == "failure" ]] echo "slug : ${{ env.GITHUB_REF_NAME_SLUG }}"
[[ "${{ steps.using-empty-slug-max-length.conclusion }}" == "success" ]] echo "slug url : ${{ env.GITHUB_REF_NAME_SLUG_URL }}"
echo "slug (Case Sensitive) : ${{ env.GITHUB_REF_NAME_SLUG_CS }}"
echo "slug url (Case Sensitive) : ${{ env.GITHUB_REF_NAME_SLUG_URL_CS }}"
shell: bash shell: bash
# Test 4 - name: Short SHA variables
- name: Using no limit on slug max length
id: using-nolimit-slug-max-length
uses: ./
with:
prefix: "NLML_"
slug-maxlength: "nolimit"
- name: Using no limit on slug max length // Validate that the action end with an error
run: | run: |
[[ "$(env | grep "NLML_" | grep "_SLUG" | wc -l)" -gt 0 ]] echo "sha : ${{ env.GITHUB_SHA_SHORT }}"
[[ "${{ steps.using-nolimit-slug-max-length.outcome }}" == "success" ]] echo "pull request sha : ${{ env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}"
[[ "${{ steps.using-nolimit-slug-max-length.conclusion }}" == "success" ]]
shell: bash shell: bash
os-testing-short-length: display-without-checkout:
name: 'Display produced variables (without checkout)'
needs:
- display
strategy:
fail-fast: false
matrix:
os: [macos-latest, ubuntu-latest, windows-latest]
runs-on: ${{ matrix.os }}
steps:
- name: Checkout
uses: actions/checkout@v3
with:
path: this-action
ref: ${{ github.ref }}
- name: Load using v4.x with prefix
uses: ./this-action
with:
prefix: V4_
short-length: 8
- name: Load using v3.x
uses: rlespinasse/github-slug-action@v3.x
- name: Short SHA variables
run: |
echo "sha : ${{ env.GITHUB_SHA_SHORT }}"
echo "pull request sha : ${{ env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}"
shell: bash
input-short-length:
name: "Input 'short-length'"
strategy: strategy:
fail-fast: false fail-fast: false
matrix: matrix:
@@ -192,7 +236,7 @@ jobs:
- name: Using correct short length - name: Using correct short length
uses: ./ uses: ./
with: with:
prefix: "CSL_" prefix: 'CSL_'
short-length: 4 short-length: 4
- name: Using correct length // Validate that all short variables lengths are equals to short-length - name: Using correct length // Validate that all short variables lengths are equals to short-length
run: | run: |
@@ -204,8 +248,8 @@ jobs:
id: using-wrong-short-length id: using-wrong-short-length
uses: ./ uses: ./
with: with:
prefix: "WSL_" prefix: 'WSL_'
short-length: "wrong" short-length: 'wrong'
continue-on-error: true continue-on-error: true
- name: Using wrong short length // Validate that the action end with an error - name: Using wrong short length // Validate that the action end with an error
run: | run: |
@@ -214,34 +258,10 @@ jobs:
[[ "${{ steps.using-wrong-short-length.conclusion }}" == "success" ]] [[ "${{ steps.using-wrong-short-length.conclusion }}" == "success" ]]
shell: bash shell: bash
os-testing-without-checkout: input-short-length-without-checkout:
strategy: name: "Input 'short-length' (without checkout)"
fail-fast: false needs:
matrix: - input-short-length
os: [macos-latest, ubuntu-latest, windows-latest]
runs-on: ${{ matrix.os }}
steps:
- name: Checkout
uses: actions/checkout@v3
with:
path: this-action
ref: ${{ github.ref }}
- name: Load using v3.x
uses: rlespinasse/github-slug-action@v3.x
- name: Load using v4.x with prefix
uses: ./this-action
with:
prefix: V4_
short-length: 8
- name: Validate // Short SHA variables
run: |
echo "sha : ${{ env.V4_GITHUB_SHA_SHORT }}"
echo "pull request sha : ${{ env.V4_GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}"
[[ "${{ env.GITHUB_SHA_SHORT }}" == "${{ env.V4_GITHUB_SHA_SHORT }}" ]]
[[ "${{ env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}" == "${{ env.V4_GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}" ]]
shell: bash
os-testing-short-length-without-checkout:
strategy: strategy:
fail-fast: false fail-fast: false
matrix: matrix:
@@ -258,7 +278,7 @@ jobs:
- name: Using correct short length - name: Using correct short length
uses: ./this-action uses: ./this-action
with: with:
prefix: "CSL_" prefix: 'CSL_'
short-length: 4 short-length: 4
- name: Using correct length // Validate that all short variables lengths are equals to short-length - name: Using correct length // Validate that all short variables lengths are equals to short-length
run: | run: |
@@ -270,7 +290,7 @@ jobs:
id: using-empty-short-length id: using-empty-short-length
uses: ./this-action uses: ./this-action
with: with:
prefix: "ESL_" prefix: 'ESL_'
continue-on-error: true continue-on-error: true
- name: Using empty short length // Validate that the action don't end with an error - name: Using empty short length // Validate that the action don't end with an error
run: | run: |
@@ -284,8 +304,8 @@ jobs:
id: using-wrong-short-length id: using-wrong-short-length
uses: ./this-action uses: ./this-action
with: with:
prefix: "WSL_" prefix: 'WSL_'
short-length: "wrong" short-length: 'wrong'
continue-on-error: true continue-on-error: true
- name: Using wrong short length // Validate that the action end with an error - name: Using wrong short length // Validate that the action end with an error
run: | run: |
@@ -294,20 +314,83 @@ jobs:
[[ "${{ steps.using-wrong-short-length.conclusion }}" == "success" ]] [[ "${{ steps.using-wrong-short-length.conclusion }}" == "success" ]]
shell: bash shell: bash
input-slug-maxlength:
name: "Input 'slug-maxlength'"
strategy:
fail-fast: false
matrix:
os: [macos-latest, ubuntu-latest, windows-latest]
runs-on: ${{ matrix.os }}
steps:
- name: Checkout
uses: actions/checkout@v3
# Test 1
- name: Using correct slug max length
uses: ./
with:
prefix: 'CML_'
slug-maxlength: 1
- name: Using correct max length // Validate that all slug variables lengths are equals or under the slug-maxlength
run: |
env | grep "CML_" | grep "_SLUG" | cut -d"=" -f2 | while read -r value; do [ "$(echo "$value" | wc -m)" -le 2 ] ; done
shell: bash
# Test 2
- name: Using wrong slug max length
id: using-wrong-slug-max-length
uses: ./
with:
prefix: 'WML_'
slug-maxlength: 'wrong'
continue-on-error: true
- name: Using wrong slug max length // Validate that the action end with an error
run: |
[[ "$(env | grep "WML_" | grep "_SLUG" | wc -l)" -eq 0 ]]
[[ "${{ steps.using-wrong-slug-max-length.outcome }}" == "failure" ]]
[[ "${{ steps.using-wrong-slug-max-length.conclusion }}" == "success" ]]
shell: bash
# Test 3
- name: Using empty slug max length
id: using-empty-slug-max-length
uses: ./
with:
prefix: 'EML_'
slug-maxlength: ''
continue-on-error: true
- name: Using empty slug max length // Validate that the action end with an error
run: |
[[ "$(env | grep "EML_" | grep "_SLUG" | wc -l)" -eq 0 ]]
[[ "${{ steps.using-empty-slug-max-length.outcome }}" == "failure" ]]
[[ "${{ steps.using-empty-slug-max-length.conclusion }}" == "success" ]]
shell: bash
# Test 4
- name: Using no limit on slug max length
id: using-nolimit-slug-max-length
uses: ./
with:
prefix: 'NLML_'
slug-maxlength: 'nolimit'
- name: Using no limit on slug max length // Validate that the action end with an error
run: |
[[ "$(env | grep "NLML_" | grep "_SLUG" | wc -l)" -gt 0 ]]
[[ "${{ steps.using-nolimit-slug-max-length.outcome }}" == "success" ]]
[[ "${{ steps.using-nolimit-slug-max-length.conclusion }}" == "success" ]]
shell: bash
release: release:
runs-on: ubuntu-latest runs-on: ubuntu-latest
concurrency: concurrency:
group: release-${{ github.ref }}-${{ github.event_name }} group: release-${{ github.ref }}-${{ github.event_name }}
needs: needs:
- os-testing - check-v3compatibility-without-checkout
- os-testing-slug-maxlength - display-without-checkout
- os-testing-short-length - input-short-length-without-checkout
- os-testing-without-checkout - input-slug-maxlength
- os-testing-short-length-without-checkout
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v3 uses: actions/checkout@v3
- name: Release this GitHub Action - name: Release this GitHub Action
uses: rlespinasse/release-that@v1 uses: rlespinasse/release-that@v1
with:
without-prefix: true

View File

@@ -1,10 +1,6 @@
# GitHub Slug action # GitHub Slug action
[![Release][release-badge]][releases] This GitHub Action will expose the slug/short values of [some GitHub environment variables][default-environment-variables] inside your GitHub workflow.
![Lint][lint-badge]
[![Licence][license-badge]][license]
This GitHub Action will expose the slug/short values of [some GitHub environment variables][github-env-vars] inside your GitHub workflow.
## Table of Contents ## Table of Contents
@@ -22,6 +18,8 @@ This GitHub Action will expose the slug/short values of [some GitHub environment
- [Troubleshooting](#troubleshooting) - [Troubleshooting](#troubleshooting)
- [The SHORT variables doesn't have the same lengths as before](#the-short-variables-doesnt-have-the-same-lengths-as-before) - [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) - [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)
- [An action could not be found at the URI](#an-action-could-not-be-found-at-the-uri) - [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) - [Thanks for talking about us](#thanks-for-talking-about-us)
@@ -31,15 +29,16 @@ This GitHub Action will expose the slug/short values of [some GitHub environment
- put the variable content in lower case - put the variable content in lower case
- replace any character by `-` except `0-9`, `a-z`, `.`, and `_` - replace any character by `-` except `0-9`, `a-z`, `.`, and `_`
- remove leading and trailing `-` character - remove leading `-` characters
- limit the string size to 63 characters - limit the string size to 63 characters
- remove trailing `-` characters
<details> <details>
<summary>Others <b>Slug-ish</b> commands are available</summary> <summary>Others <b>Slug-ish</b> commands are available</summary>
<p> <p>
- `SLUG_URL` on a variable to have a `slug` variable compliant to be used in an URL - `SLUG_URL` on a variable to have a `slug` variable compliant to be used in an URL
- Like `SLUG` but `.` is also replaced by `-` - Like `SLUG` but `.`, and `_` are also replaced by `-`
- `SHORT` on a variable will limit the string size to ~8 characters - `SHORT` on a variable will limit the string size to ~8 characters
- Useful for _sha_ value - Useful for _sha_ value
- `<KEY>_PART` on a variable will give a part of a variable defined by a key - `<KEY>_PART` on a variable will give a part of a variable defined by a key
@@ -47,11 +46,10 @@ This GitHub Action will expose the slug/short values of [some GitHub environment
- `<VAR>_CS` on others variables to keep the value case-sensitive - `<VAR>_CS` on others variables to keep the value case-sensitive
- Like `GITHUB_REF_SLUG_CS` - Like `GITHUB_REF_SLUG_CS`
Additional enhanced environment variables can be compute to help you around GitHub environment variables.
</p> </p>
</details> </details>
Additional enhanced environment variables can be compute to help you around GitHub environment variables.
## Use this action ## Use this action
Add this in your workflow Add this in your workflow
@@ -61,7 +59,9 @@ Add this in your workflow
uses: rlespinasse/github-slug-action@v4 uses: rlespinasse/github-slug-action@v4
``` ```
Others configurations <details>
<summary>Others configurations</summary>
<p>
- With a prefix - With a prefix
@@ -91,6 +91,8 @@ Others configurations
``` ```
**Warning**: If you leave it empty, you need to checkout the source first in order to let git decide the size by itself. **Warning**: If you leave it empty, you need to checkout the source first in order to let git decide the size by itself.
</p>
</details>
Check for more [examples][examples] (OS usage, URL use, ...) Check for more [examples][examples] (OS usage, URL use, ...)
@@ -182,34 +184,42 @@ To manage that moving length, you can use `short-length` input
### One of the environment variables doesn't work as intended ### One of the environment variables doesn't work as intended
[**Note**][naming-conventions]: GitHub reserves the `GITHUB_` environment variable prefix for internal use by GitHub. Setting an environment variable or secret with the `GITHUB_` prefix will result in an error. [**Note**][naming-conventions]: When you set a custom environment variable, you cannot use any of the default environment variable names. For a complete list of these, see [Default environment variables][default-environment-variables]. **If you attempt to override the value of one of these default environment variables, the assignment is ignored.**
Currently, a GitHub workflow setting a `GITHUB_` variable will not cause an error, it will just fail silently. If a variable start to be used as default environment variable, the environment variable may have a different behavior than the expected one.
And if a custom `GITHUB_` variable is in conflict with an official `GITHUB_` variable, the offical `GITHUB_` variable will override custom one.
<details> If this append, the `${{ env.GITHUB_AWESOME_VARIABLE }}` and `$GITHUB_AWESOME_VARIABLE` expression will not works in the same way.
<summary>Test workflow</summary>
<p> - `${{ env.GITHUB_AWESOME_VARIABLE }}` will serve the behavior of this action,
- `$GITHUB_AWESOME_VARIABLE` will serve the behavior of GitHub Action.
Otherwise the two expression will serve the behavior of this action.
This will not occurs if you use the `prefix` input to avoid the issue.
**NOTE:** If detected, the maintainers of this action will choose the best course of action depending of the impact.
#### Known environment variable conflicts
##### GITHUB_REF_NAME
The behavior is the same as the GitHub one except on `pull_request*` workflows ([Ready the full story][issue-104]).
- `${{ env.GITHUB_REF_NAME }}` will serve the behavior of this action,
- `$GITHUB_REF_NAME` will serve the behavior of GitHub Action.
On `pull_request*` workflows, the content will be `<PR-number>/merge` instead of the branch name.
A possible workaround is to use `prefix` input
```yaml ```yaml
name: Test - name: Inject slug/short variables
on: push uses: rlespinasse/github-slug-action@v4
jobs: with:
build: prefix: CI_
runs-on: ubuntu-latest
steps:
- run: echo ${GITHUB_REF}
# print "refs/heads/v4.x"
- run: echo "GITHUB_REF=one_value" >> "$GITHUB_ENV"
- run: echo ${GITHUB_REF}
# print "refs/heads/v4.x"
- run: echo "GITHUB_REF_SLUG=another_value" >> "$GITHUB_ENV"
- run: echo ${GITHUB_REF_SLUG}
# print "another_value"
``` ```
</p> Then `${{ env.CI_GITHUB_REF_NAME }}`, and `$CI_GITHUB_REF_NAME` will serve the behavior of this action.
</details> And `$GITHUB_REF_NAME` will serve the behavior of GitHub Action.
### An action could not be found at the URI ### An action could not be found at the URI
@@ -230,29 +240,28 @@ Please, use the current major tag `v4` or a version tag (see [releases pages][re
## Thanks for talking about us ## Thanks for talking about us
- [Mettre en place une CI/CD Angular avec GitHub Actions & Netlify][article-1] (in french :fr:) - [Mettre en place une CI/CD Angular avec GitHub Actions & Netlify][article-1] (in french :fr:)
- [Github Actions : enfin des pipelines accessibles aux développeurs][talk-1] (in french :fr:)
- [Action spotlight by Michael Heap][article-2] - [Action spotlight by Michael Heap][article-2]
- [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]
- [Github Actions : enfin des pipelines accessibles aux développeurs][talk-1] (in french :fr:)
- The next one is you. _Don't hesitate to add youself to this list._ - The next one is you. _Don't hesitate to add youself to this list._
[release-badge]: https://img.shields.io/github/workflow/status/rlespinasse/github-slug-action/Release?label=Build&logo=github&style=flat-square
[lint-badge]: https://img.shields.io/github/workflow/status/rlespinasse/github-slug-action/Lint?label=Lint&logo=github&style=flat-square
[license-badge]: https://img.shields.io/github/license/rlespinasse/github-slug-action?style=flat-square
[actions]: https://github.com/rlespinasse/github-slug-action/actions
[license]: https://github.com/rlespinasse/github-slug-action/blob/v4.x/LICENSE
[examples]: https://github.com/rlespinasse/github-slug-action/tree/v4.x/examples [examples]: https://github.com/rlespinasse/github-slug-action/tree/v4.x/examples
[custom-variable]: https://github.com/rlespinasse/github-slug-action/issues/new?assignees=&labels=enhancement&template=feature_request.md&title= [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 [releases]: https://github.com/rlespinasse/github-slug-action/releases
[issue-15]: https://github.com/rlespinasse/github-slug-action/issues/15 [issue-15]: https://github.com/rlespinasse/github-slug-action/issues/15
[issue-104]: https://github.com/rlespinasse/github-slug-action/issues/104
[git-revpars]: https://git-scm.com/docs/git-rev-parse#Documentation/git-rev-parse.txt---shortlength [git-revparse]: https://git-scm.com/docs/git-rev-parse#Documentation/git-rev-parse.txt---shortlength
[git-core-abbrev]: https://git-scm.com/docs/git-config#Documentation/git-config.txt-coreabbrev [git-core-abbrev]: https://git-scm.com/docs/git-config#Documentation/git-config.txt-coreabbrev
[github-env-vars]: https://docs.github.com/en/free-pro-team@latest/actions/reference/environment-variables#default-environment-variables [default-environment-variables]: https://docs.github.com/en/actions/learn-github-actions/environment-variables#default-environment-variables
[dependabot]: https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot [dependabot]: https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot
[webhooks-and-events]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads [webhooks-and-events]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads
[naming-conventions]: https://docs.github.com/en/actions/reference/environment-variables#naming-conventions-for-environment-variables [naming-conventions]: https://docs.github.com/en/actions/reference/environment-variables#naming-conventions-for-environment-variables
[article-1]: https://esensconsulting.medium.com/mettre-en-place-une-ci-cd-angular-avec-github-actions-netlify-ca0b59b99ed8 [article-1]: https://esensconsulting.medium.com/mettre-en-place-une-ci-cd-angular-avec-github-actions-netlify-ca0b59b99ed8
[article-2]: https://michaelheap.com/github-slug-action/ [article-2]: https://michaelheap.com/github-slug-action/
[talk-1]: https://www.youtube.com/watch?v=RHnTJBwcE98 [article-3]: https://barstool.engineering/serverless-deploy-previews-on-github-actions/
[article-4]: https://javascript.plainenglish.io/lets-build-a-continuous-delivery-and-branching-process-c27dae09f0b6
[talk-1]: https://www.youtube.com/watch?v=F5mBDmOQcvE

View File

@@ -26,30 +26,30 @@ runs:
INPUT_SLUG_MAXLENGTH: ${{ inputs.slug-maxlength }} INPUT_SLUG_MAXLENGTH: ${{ inputs.slug-maxlength }}
INPUT_SHORT_LENGTH: ${{ inputs.short-length }} INPUT_SHORT_LENGTH: ${{ inputs.short-length }}
- uses: rlespinasse/slugify-value@v1.2.1 - uses: rlespinasse/slugify-value@v1.3.2
with: with:
key: GITHUB_REPOSITORY key: GITHUB_REPOSITORY
value: ${{ github.repository }} value: ${{ github.repository }}
prefix: ${{ inputs.prefix }} prefix: ${{ inputs.prefix }}
slug-maxlength: ${{ inputs.slug-maxlength }} slug-maxlength: ${{ inputs.slug-maxlength }}
- uses: rlespinasse/slugify-value@v1.2.1 - uses: rlespinasse/slugify-value@v1.3.2
with: with:
key: GITHUB_REF key: GITHUB_REF
prefix: ${{ inputs.prefix }} prefix: ${{ inputs.prefix }}
slug-maxlength: ${{ inputs.slug-maxlength }} slug-maxlength: ${{ inputs.slug-maxlength }}
- uses: rlespinasse/slugify-value@v1.2.0 - uses: rlespinasse/slugify-value@v1.3.2
with: with:
key: GITHUB_HEAD_REF key: GITHUB_HEAD_REF
prefix: ${{ inputs.prefix }} prefix: ${{ inputs.prefix }}
slug-maxlength: ${{ inputs.slug-maxlength }} slug-maxlength: ${{ inputs.slug-maxlength }}
- uses: rlespinasse/slugify-value@v1.2.1 - uses: rlespinasse/slugify-value@v1.3.2
with: with:
key: GITHUB_BASE_REF key: GITHUB_BASE_REF
prefix: ${{ inputs.prefix }} prefix: ${{ inputs.prefix }}
slug-maxlength: ${{ inputs.slug-maxlength }} slug-maxlength: ${{ inputs.slug-maxlength }}
# Specific values # Specific values
- uses: rlespinasse/slugify-value@v1.2.1 - uses: rlespinasse/slugify-value@v1.3.2
with: with:
key: GITHUB_EVENT_REF key: GITHUB_EVENT_REF
value: ${{ github.event.ref }} value: ${{ github.event.ref }}
@@ -58,27 +58,27 @@ runs:
# Calculated values # Calculated values
- id: get-github-ref-name - id: get-github-ref-name
run: echo "::set-output name=github-ref-name::$(echo "${{ github.head_ref || github.ref }}" | cut -d/ -f3)" run: echo "github-ref-name=${{ github.head_ref || github.ref_name }}" >> "$GITHUB_OUTPUT"
shell: bash shell: bash
- uses: rlespinasse/slugify-value@v1.2.1 - uses: rlespinasse/slugify-value@v1.3.2
with: with:
key: GITHUB_REF_NAME key: GITHUB_REF_NAME
value: ${{ steps.get-github-ref-name.outputs.github-ref-name }} value: ${{ steps.get-github-ref-name.outputs.github-ref-name }}
prefix: ${{ inputs.prefix }} prefix: ${{ inputs.prefix }}
slug-maxlength: ${{ inputs.slug-maxlength }} slug-maxlength: ${{ inputs.slug-maxlength }}
- id: get-github-repository-owner-part - id: get-github-repository-owner-part
run: echo "::set-output name=github-repository-owner-part::$(echo $GITHUB_REPOSITORY | cut -d/ -f1)" run: echo "github-repository-owner-part=$(echo $GITHUB_REPOSITORY | cut -d/ -f1)" >> "$GITHUB_OUTPUT"
shell: bash shell: bash
- uses: rlespinasse/slugify-value@v1.2.1 - uses: rlespinasse/slugify-value@v1.3.2
with: with:
key: GITHUB_REPOSITORY_OWNER_PART key: GITHUB_REPOSITORY_OWNER_PART
value: ${{ steps.get-github-repository-owner-part.outputs.github-repository-owner-part }} value: ${{ steps.get-github-repository-owner-part.outputs.github-repository-owner-part }}
prefix: ${{ inputs.prefix }} prefix: ${{ inputs.prefix }}
slug-maxlength: ${{ inputs.slug-maxlength }} slug-maxlength: ${{ inputs.slug-maxlength }}
- id: get-github-repository-name-part - id: get-github-repository-name-part
run: echo "::set-output name=github-repository-name-part::$(echo $GITHUB_REPOSITORY | cut -d/ -f2)" run: echo "github-repository-name-part=$(echo $GITHUB_REPOSITORY | cut -d/ -f2)" >> "$GITHUB_OUTPUT"
shell: bash shell: bash
- uses: rlespinasse/slugify-value@v1.2.1 - uses: rlespinasse/slugify-value@v1.3.2
with: with:
key: GITHUB_REPOSITORY_NAME_PART key: GITHUB_REPOSITORY_NAME_PART
value: ${{ steps.get-github-repository-name-part.outputs.github-repository-name-part }} value: ${{ steps.get-github-repository-name-part.outputs.github-repository-name-part }}

View File

@@ -31,4 +31,4 @@ else
fi fi
fi fi
echo "::debug ::Set PREFLIGHT_SHORT_LENGTH=$PREFLIGHT_SHORT_LENGTH" echo "::debug ::Set PREFLIGHT_SHORT_LENGTH=$PREFLIGHT_SHORT_LENGTH"
echo "::set-output name=PREFLIGHT_SHORT_LENGTH::$PREFLIGHT_SHORT_LENGTH" echo "PREFLIGHT_SHORT_LENGTH=$PREFLIGHT_SHORT_LENGTH" >> "$GITHUB_OUTPUT"