mirror of
https://github.com/rlespinasse/github-slug-action.git
synced 2026-05-18 10:31:48 +00:00
Compare commits
20 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9d2c65418d | ||
|
|
f536765da4 | ||
|
|
72cfc4cb1f | ||
|
|
d678898ce5 | ||
|
|
f527ed6e85 | ||
|
|
6efa53ebca | ||
|
|
c0eae81222 | ||
|
|
7e9b2916a8 | ||
|
|
c34e0866d5 | ||
|
|
9ed3b31f8a | ||
|
|
1172ed1802 | ||
|
|
5a334a8573 | ||
|
|
4268cc0475 | ||
|
|
9225a8adaf | ||
|
|
498f51bdf6 | ||
|
|
7c65a057e0 | ||
|
|
e5b7d5b5fc | ||
|
|
ca9a67fa1f | ||
|
|
e95fe45d8b | ||
|
|
250b75dc58 |
3
.github/FUNDING.yml
vendored
Normal file
3
.github/FUNDING.yml
vendored
Normal file
@@ -0,0 +1,3 @@
|
||||
# These are supported funding model platforms
|
||||
|
||||
github: rlespinasse
|
||||
3
.github/actions/bats/Dockerfile
vendored
3
.github/actions/bats/Dockerfile
vendored
@@ -1,3 +0,0 @@
|
||||
FROM bats/bats:latest
|
||||
|
||||
CMD ["./tests"]
|
||||
12
.github/workflows/ci.yml
vendored
12
.github/workflows/ci.yml
vendored
@@ -5,7 +5,9 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v1
|
||||
- uses: ./.github/actions/bats
|
||||
- uses: docker://ffurrer/bats:latest
|
||||
with:
|
||||
args: "--recursive ."
|
||||
- uses: cycjimmy/semantic-release-action@v2
|
||||
with:
|
||||
semantic_version: 17.0.7
|
||||
@@ -28,8 +30,16 @@ jobs:
|
||||
- name: Output
|
||||
run: |
|
||||
echo "Slug variables"
|
||||
echo " repository : ${{ env.GITHUB_REPOSITORY_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 }}"
|
||||
echo "Slug URL variables"
|
||||
echo " repository : ${{ env.GITHUB_REPOSITORY_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 }}"
|
||||
echo "Short SHA variables"
|
||||
echo " sha : ${{ env.GITHUB_SHA_SHORT }}"
|
||||
|
||||
19
CHANGELOG.md
19
CHANGELOG.md
@@ -1,27 +1,20 @@
|
||||
# [1.2.0](http://github.com/rlespinasse/github-slug-action/compare/1.1.1...1.2.0) (2021-04-05)
|
||||
# [2.2.0](http://github.com/rlespinasse/github-slug-action/compare/2.1.1...2.2.0) (2021-04-05)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add deprecation warning ([c9eec68](http://github.com/rlespinasse/github-slug-action/commit/c9eec68e1a02f91b77e9b978ad23527085244aaa))
|
||||
* add version warning ([f536765](http://github.com/rlespinasse/github-slug-action/commit/f536765da448783f587c88e2c69f8f65b4e06541))
|
||||
|
||||
## [1.1.1](http://github.com/rlespinasse/github-slug-action/compare/1.1.0...1.1.1) (2020-10-07)
|
||||
## [2.1.1](http://github.com/rlespinasse/github-slug-action/compare/2.1.0...2.1.1) (2020-10-07)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* remove set-env due to CVE fix ([6c69465](http://github.com/rlespinasse/github-slug-action/commit/6c69465e62a6430b5742c5bc0fce732f55630ee7))
|
||||
* remove set-env due to CVE fix ([d678898](http://github.com/rlespinasse/github-slug-action/commit/d678898ce55139d0005c35618747506fbeb2d1ed))
|
||||
|
||||
# [1.1.0](http://github.com/rlespinasse/github-slug-action/compare/1.0.2...1.1.0) (2019-11-11)
|
||||
# [2.1.0](http://github.com/rlespinasse/github-slug-action/compare/2.0.0...2.1.0) (2020-07-28)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **short_sha:** add a shortened sha commit id ([d77acd4](http://github.com/rlespinasse/github-slug-action/commit/d77acd4f478b6971e0f7b2c9d1d4e721032bc5ab))
|
||||
|
||||
## [1.0.2](http://github.com/rlespinasse/github-slug-action/compare/1.0.1...1.0.2) (2019-11-06)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* manage branch with slash properly ([c35fd20](http://github.com/rlespinasse/github-slug-action/commit/c35fd2094f6f0cb6c4858cf6db020eedd535671d))
|
||||
* expose slug variables for github.event.ref ([5a334a8](http://github.com/rlespinasse/github-slug-action/commit/5a334a8573fc27451af5b2a6ee175d8e11579e10))
|
||||
|
||||
@@ -1,8 +1,4 @@
|
||||
# Container image that runs your code
|
||||
FROM alpine:3.10
|
||||
|
||||
# Copies your code file from your action repository to the filesystem path `/` of the container
|
||||
RUN apk add --no-cache jq
|
||||
COPY entrypoint.sh /entrypoint.sh
|
||||
|
||||
# Code file to execute when the docker container starts up (`entrypoint.sh`)
|
||||
ENTRYPOINT ["/entrypoint.sh"]
|
||||
|
||||
2
LICENSE
2
LICENSE
@@ -1,6 +1,6 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2019 Romain Lespinasse
|
||||
Copyright (c) 2019-2020 Romain Lespinasse
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
||||
145
README.md
145
README.md
@@ -1,53 +1,88 @@
|
||||
# GitHub Slug action
|
||||
|
||||
[](https://github.com/rlespinasse/github-slug-action/actions)
|
||||
[![Actions Status][1]][2]
|
||||
[![Public workflows that use this action.][8]][9]
|
||||
|
||||
This action slug and expose some github variables.
|
||||
|
||||
`Slug` a variable will
|
||||
|
||||
- put the variable content in lower case,
|
||||
- replace any character by `-` except `0-9` and `a-z`,
|
||||
- remove leading and trailing `-` character,
|
||||
- limit the string size to 63 characters.
|
||||
- put the variable content in lower case
|
||||
- replace any character by `-` except `0-9`, `a-z`, and `.`
|
||||
- remove leading and trailing `-` character
|
||||
- limit the string size to 63 characters
|
||||
|
||||
Others `Slug`-ish commands are available:
|
||||
|
||||
- `Short SHA` a variable will limit the string size to 8 characters.
|
||||
- `Slug URL` a variable will be like the `slug` variable but the `.` character will also be replaced by `-`
|
||||
- `Short SHA` a variable will limit the string size to 8 characters
|
||||
|
||||
## Exposed environment variables
|
||||
|
||||
```yaml
|
||||
- uses: rlespinasse/github-slug-action@v1.1.x
|
||||
- name: Print slug variables
|
||||
- name: Inject slug/short variables
|
||||
uses: rlespinasse/github-slug-action@v2.x
|
||||
|
||||
- name: Print slug/short variables
|
||||
run: |
|
||||
echo ${{ env.GITHUB_REF_SLUG }}
|
||||
echo ${{ env.GITHUB_HEAD_REF_SLUG }}
|
||||
echo ${{ env.GITHUB_BASE_REF_SLUG }}
|
||||
echo ${{ env.GITHUB_SHA_SHORT }}
|
||||
echo "Slug variables"
|
||||
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 }}"
|
||||
echo " repository : ${{ env.GITHUB_REPOSITORY_SLUG }}"
|
||||
echo "Slug URL variables"
|
||||
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 }}"
|
||||
echo " repository : ${{ env.GITHUB_REPOSITORY_SLUG_URL }}"
|
||||
echo "Short SHA variables"
|
||||
echo " sha : ${{ env.GITHUB_SHA_SHORT }}"
|
||||
```
|
||||
|
||||
Read [default environment variables](https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables) page for more information.
|
||||
Read [default environment variables][3] page for more information.
|
||||
|
||||
### GITHUB_REF_SLUG
|
||||
### GITHUB_REF_SLUG / GITHUB_REF_SLUG_URL
|
||||
|
||||
Slug the environment variable **GITHUB_REF**
|
||||
|
||||
The branch or tag ref that triggered the workflow.
|
||||
_If neither a branch or tag is available for the event type, the variable will not exist._
|
||||
|
||||
| Environment variable (GITHUB_REF) | Slug variable (GITHUB_REF_SLUG) |
|
||||
|-----------------------------------|---------------------------------|
|
||||
| refs/heads/master | master |
|
||||
| refs/heads/feat/new_feature | feat-new-feature |
|
||||
| refs/tags/v1.0.0 | v1-0-0 |
|
||||
| refs/tags/product@1.0.0-rc.2 | product-1-0-0-rc-2 |
|
||||
| refs/heads/New_Awesome_Product | new-awesome-product |
|
||||
| GITHUB_REF | GITHUB_REF_SLUG | GITHUB_REF_SLUG_URL |
|
||||
| ------------------------------ | ------------------- | ------------------- |
|
||||
| refs/heads/master | master | master |
|
||||
| refs/heads/feat/new_feature | feat-new-feature | feat-new-feature |
|
||||
| refs/tags/v1.0.0 | v1.0.0 | v1-0-0 |
|
||||
| refs/tags/product@1.0.0-rc.2 | product-1.0.0-rc.2 | product-1-0-0-rc-2 |
|
||||
| refs/heads/New_Awesome_Product | new-awesome-product | new-awesome-product |
|
||||
|
||||
> **NOTE :**
|
||||
> GITHUB_REF_SLUG_URL is design to be used as subdomain in an URL.
|
||||
|
||||
_Additional variables (only set for forked repositories) :_
|
||||
|
||||
- `GITHUB_HEAD_REF_SLUG` : The branch of the head repository **GITHUB_HEAD_REF**,
|
||||
- `GITHUB_BASE_REF_SLUG` : The branch of the base repository **GITHUB_BASE_REF**.
|
||||
- `GITHUB_HEAD_REF_SLUG`/`GITHUB_HEAD_REF_SLUG_URL`, The branch of the head repository **GITHUB_HEAD_REF**
|
||||
- `GITHUB_BASE_REF_SLUG`/`GITHUB_BASE_REF_SLUG_URL`, The branch of the base repository **GITHUB_BASE_REF**
|
||||
|
||||
_Additional variables (only set for [create][4], and [delete][5] webhook events with `ref` data) :_
|
||||
|
||||
- `GITHUB_EVENT_REF_SLUG`/`GITHUB_EVENT_REF_SLUG_URL`, The git reference resource associated to the webhook.
|
||||
|
||||
### GITHUB_REPOSITORY_SLUG / GITHUB_REPOSITORY_SLUG_URL
|
||||
|
||||
Slug the environment variable **GITHUB_REPOSITORY**
|
||||
|
||||
The owner and repository name.
|
||||
|
||||
| GITHUB_REPOSITORY | GITHUB_REPOSITORY_SLUG | GITHUB_REPOSITORY_SLUG_URL |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| octocat/Hello-World | octocat-hello-world | octocat-hello-world |
|
||||
| rlespinasse/Hello-World.go | rlespinasse-hello-world.go | rlespinasse-hello-world-go |
|
||||
|
||||
> **NOTE :**
|
||||
> GITHUB_REPOSITORY_SLUG_URL is design to be used as subdomain in an URL.
|
||||
|
||||
### GITHUB_SHA_SHORT
|
||||
|
||||
@@ -55,6 +90,64 @@ Short the environment variable **GITHUB_SHA**
|
||||
|
||||
The commit SHA that triggered the workflow
|
||||
|
||||
| Environment variable (GITHUB_SHA) | Short variable (GITHUB_SHA_SHORT) |
|
||||
|------------------------------------------|-----------------------------------|
|
||||
| ffac537e6cbbf934b08745a378932722df287a53 | ffac537e |
|
||||
| GITHUB_SHA | GITHUB_SHA_SHORT |
|
||||
| ---------------------------------------- | ---------------- |
|
||||
| ffac537e6cbbf934b08745a378932722df287a53 | ffac537e |
|
||||
|
||||
### Use slug variable in an URL
|
||||
|
||||
In an URL, use `<GITHUB_VARIABLE>_SLUG_URL` instead of **<GITHUB_VARIABLE>\_SLUG** as subdomain to be compliant.
|
||||
|
||||
> **NOTE :**
|
||||
> <GITHUB*VARIABLE>\_SLUG can be used in an URL only as part of the \_resource path*.
|
||||
|
||||
```yaml
|
||||
- name: Inject slug/short variables
|
||||
uses: rlespinasse/github-slug-action@v2.x
|
||||
|
||||
- name: Deploy dummy application using slug in the 'subdomain' part
|
||||
run: |
|
||||
./deploy-application.sh --url "https://${{ env.<GITHUB_VARIABLE>_SLUG_URL }}.staging.app.mycompagny.com"
|
||||
|
||||
- name: Deploy dummy application using slug in the 'resource path' part
|
||||
run: |
|
||||
./deploy-application.sh --url "https://staging.app.mycompagny.com/${{ env.<GITHUB_VARIABLE>_SLUG }}"
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Missing master branch
|
||||
|
||||
If your workflow fail on the `Set up job` task with this kind of log :
|
||||
|
||||
```
|
||||
Download action repository 'rlespinasse/github-slug-action@master'
|
||||
##[error]An action could not be found at the URI 'https://api.github.com/repos/rlespinasse/github-slug-action/tarball/master'
|
||||
```
|
||||
|
||||
Use the current branch `v2.x` or a version tag (see [releases pages][6]).
|
||||
|
||||
The master branch EOL is set on **2020-10-25** after a 6-month deprecation period (more information on the [EOL issue][7])
|
||||
|
||||
### Can't run on Windows or Macos
|
||||
|
||||
When using this action on Windows or Macos workflows, A `##[error]Container action is only supported on Linux` error can be see in your workflow logs.
|
||||
Currently, this action don't support a system other than Linux due to Github Action Limitation on `Container`-based action.
|
||||
|
||||
On the `v3.x` branch, this GitHub action have been rewrite to be able to run on Windows or Macos workflow.
|
||||
|
||||
```yaml
|
||||
- name: Inject slug/short variables
|
||||
uses: rlespinasse/github-slug-action@v3.x
|
||||
```
|
||||
|
||||
[1]: https://github.com/rlespinasse/github-slug-action/workflows/Build/badge.svg
|
||||
[2]: https://github.com/rlespinasse/github-slug-action/actions
|
||||
[3]: https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables
|
||||
[4]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#create
|
||||
[5]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#delete
|
||||
[6]: https://github.com/rlespinasse/github-slug-action/releases
|
||||
[7]: https://github.com/rlespinasse/github-slug-action/issues/15
|
||||
[8]: https://img.shields.io/endpoint?url=https%3A%2F%2Fapi-git-master.endbug.vercel.app%2Fapi%2Fgithub-actions%2Fused-by%3Faction%3Drlespinasse%2Fgithub-slug-action%26badge%3Dtrue
|
||||
[9]: https://github.com/search?o=desc&q=rlespinasse%2Frlespinasse/github-slug-action+path%3A.github%2Fworkflows+language%3AYAML&s=&type=Code
|
||||
|
||||
|
||||
13
SECURITY.md
13
SECURITY.md
@@ -1,11 +1,14 @@
|
||||
# Security Policy
|
||||
|
||||
## Supported Versions
|
||||
## Supported Versions and Branches
|
||||
|
||||
| Version | Supported |
|
||||
|---------|--------------------|
|
||||
| 1.1.x | :white_check_mark: |
|
||||
| < 1.0.x | :x: |
|
||||
| Version | Branch | Supported |
|
||||
|---------|--------|--------------------|
|
||||
| 2.x | v2.x | :white_check_mark: |
|
||||
| 1.1.x | v1.1.x | :white_check_mark: |
|
||||
| < 1.0.x | master | :x: |
|
||||
|
||||
A GitHub repository can used one of the available branches as action inside its workflows.
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
|
||||
@@ -1,6 +1,27 @@
|
||||
#!/bin/sh -l
|
||||
|
||||
slug() {
|
||||
echo "$1" |
|
||||
tr "[:upper:]" "[:lower:]" |
|
||||
sed -r 's/[~\^]+//g;s/[^a-zA-Z0-9.]+/-/g;s/^-+\|-+$//g;s/^-*//;s/-*$//' |
|
||||
cut -c1-63
|
||||
}
|
||||
|
||||
slug_url() {
|
||||
echo "$1" |
|
||||
tr "[:upper:]" "[:lower:]" |
|
||||
sed -r 's/[~\^]+//g;s/[^a-zA-Z0-9]+/-/g;s/^-+\|-+$//g;s/^-*//;s/-*$//' |
|
||||
cut -c1-63
|
||||
}
|
||||
|
||||
slug_ref() {
|
||||
echo "$1" |
|
||||
tr "[:upper:]" "[:lower:]" |
|
||||
sed -r 's#refs/[^\/]*/##;s/[~\^]+//g;s/[^a-zA-Z0-9.]+/-/g;s/^-+\|-+$//g;s/^-*//;s/-*$//' |
|
||||
cut -c1-63
|
||||
}
|
||||
|
||||
slug_url_ref() {
|
||||
echo "$1" |
|
||||
tr "[:upper:]" "[:lower:]" |
|
||||
sed -r 's#refs/[^\/]*/##;s/[~\^]+//g;s/[^a-zA-Z0-9]+/-/g;s/^-+\|-+$//g;s/^-*//;s/-*$//' |
|
||||
@@ -12,11 +33,24 @@ short_sha() {
|
||||
cut -c1-8
|
||||
}
|
||||
|
||||
get_event_keyvalue() {
|
||||
if [ -f "$GITHUB_EVENT_PATH" ]; then
|
||||
jq -r ".$1" "$GITHUB_EVENT_PATH" | grep -v "null"
|
||||
fi
|
||||
}
|
||||
|
||||
{
|
||||
echo "GITHUB_REPOSITORY_SLUG=$(slug "$GITHUB_REPOSITORY")"
|
||||
echo "GITHUB_REPOSITORY_SLUG_URL=$(slug_url "$GITHUB_REPOSITORY")"
|
||||
echo "GITHUB_REF_SLUG=$(slug_ref "$GITHUB_REF")"
|
||||
echo "GITHUB_HEAD_REF_SLUG=$(slug_ref "$GITHUB_HEAD_REF")"
|
||||
echo "GITHUB_BASE_REF_SLUG=$(slug_ref "$GITHUB_BASE_REF")"
|
||||
echo "GITHUB_EVENT_REF_SLUG=$(slug_ref "$(get_event_keyvalue "ref")")"
|
||||
echo "GITHUB_REF_SLUG_URL=$(slug_url_ref "$GITHUB_REF")"
|
||||
echo "GITHUB_HEAD_REF_SLUG_URL=$(slug_url_ref "$GITHUB_HEAD_REF")"
|
||||
echo "GITHUB_BASE_REF_SLUG_URL=$(slug_url_ref "$GITHUB_BASE_REF")"
|
||||
echo "GITHUB_EVENT_REF_SLUG_URL=$(slug_url_ref "$(get_event_keyvalue "ref")")"
|
||||
echo "GITHUB_SHA_SHORT=$(short_sha "$GITHUB_SHA")"
|
||||
} >>"$GITHUB_ENV"
|
||||
|
||||
echo "::warning ::This version is deprecated, please use 'rlespinasse/github-slug-action@v3.x' instead"
|
||||
echo "::warning ::This version only support linux-based workflow, please use 'rlespinasse/github-slug-action@v3.x' instead"
|
||||
|
||||
1333
package-lock.json
generated
1333
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@@ -3,7 +3,7 @@
|
||||
"version": "0.0.0",
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
"test": "docker run -w /workdir -v $(pwd):/workdir bats/bats:latest ./tests",
|
||||
"test": "docker run -w /workdir -v $(pwd):/workdir ffurrer/bats:latest --recursive .",
|
||||
"release": "semantic-release"
|
||||
},
|
||||
"repository": {
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
#!/usr/bin/env bats
|
||||
|
||||
@test "Short long hash" {
|
||||
@test "short_sha: long hash" {
|
||||
test_short_sha \
|
||||
"a35a1a486a260cfd99c5b6f8c6034a2929ba9b3f" \
|
||||
"a35a1a48"
|
||||
|
||||
49
tests/slug.bats
Normal file
49
tests/slug.bats
Normal file
@@ -0,0 +1,49 @@
|
||||
#!/usr/bin/env bats
|
||||
|
||||
@test "slug: a word" {
|
||||
test_slug \
|
||||
"word" \
|
||||
"word"
|
||||
}
|
||||
|
||||
@test "slug: a string" {
|
||||
test_slug \
|
||||
"basic-string" \
|
||||
"basic-string"
|
||||
}
|
||||
|
||||
@test "slug: a string in camel case" {
|
||||
test_slug \
|
||||
"camelCase" \
|
||||
"camelcase"
|
||||
}
|
||||
|
||||
@test "slug: a path" {
|
||||
test_slug \
|
||||
"path/to/something" \
|
||||
"path-to-something"
|
||||
}
|
||||
|
||||
@test "slug: a number" {
|
||||
test_slug \
|
||||
"4.2" \
|
||||
"4.2"
|
||||
}
|
||||
|
||||
@test "slug: a very long string" {
|
||||
test_slug \
|
||||
"an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters" \
|
||||
"an-awesome-feature-very-very-very-very-very-very-very-long-more"
|
||||
}
|
||||
|
||||
# Load sluf_ref function
|
||||
source entrypoint.sh > /dev/null 2>&1
|
||||
|
||||
test_slug() {
|
||||
given="${1}"
|
||||
expected="${2}"
|
||||
|
||||
actual="$(slug \"${given}\")"
|
||||
echo "expected : [${expected}], actual : [${actual}]"
|
||||
[ "${actual}" == "${expected}" ]
|
||||
}
|
||||
@@ -1,43 +1,43 @@
|
||||
#!/usr/bin/env bats
|
||||
|
||||
@test "Slug master branch" {
|
||||
test_sluf_ref \
|
||||
@test "slug_ref:: master branch" {
|
||||
test_slug_ref \
|
||||
"refs/heads/master" \
|
||||
"master"
|
||||
}
|
||||
|
||||
@test "Slug a feature branch" {
|
||||
test_sluf_ref \
|
||||
@test "slug_ref: a feature branch" {
|
||||
test_slug_ref \
|
||||
"refs/heads/feat/new_feature" \
|
||||
"feat-new-feature"
|
||||
}
|
||||
|
||||
@test "Slug a fix branch" {
|
||||
test_sluf_ref \
|
||||
@test "slug_ref: a fix branch" {
|
||||
test_slug_ref \
|
||||
"refs/heads/fix/issue_number" \
|
||||
"fix-issue-number"
|
||||
}
|
||||
|
||||
@test "Slug a simple tag" {
|
||||
test_sluf_ref \
|
||||
@test "slug_ref: a simple tag" {
|
||||
test_slug_ref \
|
||||
"refs/tags/v1.0.0" \
|
||||
"v1-0-0"
|
||||
"v1.0.0"
|
||||
}
|
||||
|
||||
@test "Slug a complex tag" {
|
||||
test_sluf_ref \
|
||||
@test "slug_ref: a complex tag" {
|
||||
test_slug_ref \
|
||||
"refs/tags/product@1.0.0-rc.2" \
|
||||
"product-1-0-0-rc-2"
|
||||
"product-1.0.0-rc.2"
|
||||
}
|
||||
|
||||
@test "Slug a reference with upper case letters" {
|
||||
test_sluf_ref \
|
||||
@test "slug_ref: a reference with upper case letters" {
|
||||
test_slug_ref \
|
||||
"refs/heads/New_Awesome_Product" \
|
||||
"new-awesome-product"
|
||||
}
|
||||
|
||||
@test "Slug a very long name" {
|
||||
test_sluf_ref \
|
||||
@test "slug_ref: a very long name" {
|
||||
test_slug_ref \
|
||||
"refs/heads/an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters" \
|
||||
"an-awesome-feature-very-very-very-very-very-very-very-long-more"
|
||||
}
|
||||
@@ -45,7 +45,7 @@
|
||||
# Load sluf_ref function
|
||||
source entrypoint.sh > /dev/null 2>&1
|
||||
|
||||
test_sluf_ref() {
|
||||
test_slug_ref() {
|
||||
given="${1}"
|
||||
expected="${2}"
|
||||
|
||||
|
||||
49
tests/slug_url.bats
Normal file
49
tests/slug_url.bats
Normal file
@@ -0,0 +1,49 @@
|
||||
#!/usr/bin/env bats
|
||||
|
||||
@test "slug_url: a word" {
|
||||
test_slug_url \
|
||||
"word" \
|
||||
"word"
|
||||
}
|
||||
|
||||
@test "slug_url: a string" {
|
||||
test_slug_url \
|
||||
"basic-string" \
|
||||
"basic-string"
|
||||
}
|
||||
|
||||
@test "slug_url: a string in camel case" {
|
||||
test_slug_url \
|
||||
"camelCase" \
|
||||
"camelcase"
|
||||
}
|
||||
|
||||
@test "slug_url: a path" {
|
||||
test_slug_url \
|
||||
"path/to/something" \
|
||||
"path-to-something"
|
||||
}
|
||||
|
||||
@test "slug_url: a number" {
|
||||
test_slug_url \
|
||||
"4.2" \
|
||||
"4-2"
|
||||
}
|
||||
|
||||
@test "slug_url: a very long string" {
|
||||
test_slug_url \
|
||||
"an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters" \
|
||||
"an-awesome-feature-very-very-very-very-very-very-very-long-more"
|
||||
}
|
||||
|
||||
# Load sluf_ref function
|
||||
source entrypoint.sh > /dev/null 2>&1
|
||||
|
||||
test_slug_url() {
|
||||
given="${1}"
|
||||
expected="${2}"
|
||||
|
||||
actual="$(slug_url \"${given}\")"
|
||||
echo "expected : [${expected}], actual : [${actual}]"
|
||||
[ "${actual}" == "${expected}" ]
|
||||
}
|
||||
55
tests/slug_url_ref.bats
Normal file
55
tests/slug_url_ref.bats
Normal file
@@ -0,0 +1,55 @@
|
||||
#!/usr/bin/env bats
|
||||
|
||||
@test "slug_url_ref: master branch" {
|
||||
test_slug_url_ref \
|
||||
"refs/heads/master" \
|
||||
"master"
|
||||
}
|
||||
|
||||
@test "slug_url_ref: a feature branch" {
|
||||
test_slug_url_ref \
|
||||
"refs/heads/feat/new_feature" \
|
||||
"feat-new-feature"
|
||||
}
|
||||
|
||||
@test "slug_url_ref: a fix branch" {
|
||||
test_slug_url_ref \
|
||||
"refs/heads/fix/issue_number" \
|
||||
"fix-issue-number"
|
||||
}
|
||||
|
||||
@test "slug_url_ref: a simple tag" {
|
||||
test_slug_url_ref \
|
||||
"refs/tags/v1.0.0" \
|
||||
"v1-0-0"
|
||||
}
|
||||
|
||||
@test "slug_url_ref: a complex tag" {
|
||||
test_slug_url_ref \
|
||||
"refs/tags/product@1.0.0-rc.2" \
|
||||
"product-1-0-0-rc-2"
|
||||
}
|
||||
|
||||
@test "slug_url_ref: a reference with upper case letters" {
|
||||
test_slug_url_ref \
|
||||
"refs/heads/New_Awesome_Product" \
|
||||
"new-awesome-product"
|
||||
}
|
||||
|
||||
@test "slug_url_ref: a very long name" {
|
||||
test_slug_url_ref \
|
||||
"refs/heads/an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters" \
|
||||
"an-awesome-feature-very-very-very-very-very-very-very-long-more"
|
||||
}
|
||||
|
||||
# Load sluf_ref function
|
||||
source entrypoint.sh > /dev/null 2>&1
|
||||
|
||||
test_slug_url_ref() {
|
||||
given="${1}"
|
||||
expected="${2}"
|
||||
|
||||
actual="$(slug_url_ref \"${given}\")"
|
||||
echo "expected : [${expected}], actual : [${actual}]"
|
||||
[ "${actual}" == "${expected}" ]
|
||||
}
|
||||
Reference in New Issue
Block a user