chore(release): 1.1.0 [skip ci]

# [1.1.0](http://github.com/rlespinasse/github-slug-action/compare/1.0.2...1.1.0) (2019-11-11)

### Features

* **short_sha:** add a shortened sha commit id ([d77acd4](d77acd4f47))

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,23 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/actions/bats/Dockerfile

@@ -0,0 +1,5 @@
+FROM dduportal/bats:latest
+
+COPY entrypoint.sh /entrypoint.sh
+
+ENTRYPOINT ["/entrypoint.sh"]

.github/actions/bats/entrypoint.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+
+/sbin/bats ./tests

.github/workflows/ci.yml

@@ -0,0 +1,16 @@
+name: ci
+on: push
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: ./.github/actions/bats
+      - uses: cycjimmy/semantic-release-action@v2
+        if: github.ref == 'refs/heads/master'
+        with:
+          extra_plugins: |
+            @semantic-release/git
+            @semantic-release/changelog
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}

.gitignore

@@ -0,0 +1 @@
+node_modules/

CHANGELOG.md

@@ -0,0 +1,13 @@
+# [1.1.0](http://github.com/rlespinasse/github-slug-action/compare/1.0.2...1.1.0) (2019-11-11)
+
+
+### 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))

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at romain.lespinasse@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -6,9 +6,13 @@ This action slug and expose some github variables.
 
 - put the variable content in lower case,
 - replace any caracter by `-` except `0-9` and `a-z`,
-- limit the string size to 63 caracters
+- remove leading and trailing `-` caracter,
+- limit the string size to 63 caracters.
 
-## Environement Variables
+Others `Slug`-ish commands are available:
+- `Short SHA` a variable will limit the string size to 8 caracters.
+
+## Environment Variables
 
 | GitHub environment variable | Slug variable |
 | - | - |
@@ -16,13 +20,18 @@ This action slug and expose some github variables.
 | GITHUB_HEAD_REF | GITHUB_HEAD_REF_SLUG |
 | GITHUB_BASE_REF | GITHUB_BASE_REF_SLUG |
 
+| GitHub environment variable | Short variable |
+| - | - |
+| GITHUB_SHA | GITHUB_SHA_SHORT |
+
 ## Example usage
 
 ```yaml
-- uses: rlespinasse/github-slug-action@1.0.0
+- uses: rlespinasse/github-slug-action@master
 - name: Print slug variables
   run: |
     echo ${{ env.GITHUB_REF_SLUG }}
     echo ${{ env.GITHUB_HEAD_REF_SLUG }}
     echo ${{ env.GITHUB_BASE_REF_SLUG }}
+    echo ${{ env.GITHUB_SHA_SHORT }}
 ```

entrypoint.sh

@@ -1,12 +1,18 @@
 #!/bin/sh -l
 
 slug_ref() {
-    echo $1 \
-         | tr A-Z a-z \
-         | sed -r 's#refs/.*/##;s/[~\^]+//g;s/[^a-zA-Z0-9]+/-/g;s/^-+\|-+$//g' \
+    echo "$1" \
+         | tr "[:upper:]" "[:lower:]" \
+         | sed -r 's#refs/[^\/]*/##;s/[~\^]+//g;s/[^a-zA-Z0-9]+/-/g;s/^-+\|-+$//g;s/^-*//;s/-*$//' \
          | cut -c1-63
 }
 
-echo ::set-env name=GITHUB_REF_SLUG::$(slug_ref $GITHUB_REF)
-echo ::set-env name=GITHUB_HEAD_REF_SLUG::$(slug_ref $GITHUB_HEAD_REF)
-echo ::set-env name=GITHUB_BASE_REF_SLUG::$(slug_ref $GITHUB_BASE_REF)
+short_sha(){
+  echo "$1" \
+        | cut -c1-8
+}
+
+echo ::set-env name=GITHUB_REF_SLUG::"$(slug_ref "$GITHUB_REF")"
+echo ::set-env name=GITHUB_HEAD_REF_SLUG::"$(slug_ref "$GITHUB_HEAD_REF")"
+echo ::set-env name=GITHUB_BASE_REF_SLUG::"$(slug_ref "$GITHUB_BASE_REF")"
+echo ::set-env name=GITHUB_SHA_SHORT::"$(short_sha "$GITHUB_SHA")"

package.json

@@ -0,0 +1,28 @@
+{
+  "name": "github-slug-action",
+  "version": "1.0.1",
+  "license": "MIT",
+  "scripts": {
+    "test": "docker run -w /workdir -v $(pwd):/workdir dduportal/bats:latest ./tests",
+    "release": "semantic-release"
+  },
+  "repository": {
+    "type": "git",
+    "url": "http://github.com/rlespinasse/github-slug-action.git"
+  },
+  "devDependencies": {
+    "@semantic-release/changelog": "^3.0.5",
+    "@semantic-release/git": "^7.0.18",
+    "semantic-release": "^15.13.30"
+  },
+  "release": {
+    "tagFormat": "${version}",
+    "plugins": [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      "@semantic-release/changelog",
+      "@semantic-release/git",
+      "@semantic-release/github"
+    ]
+  }
+}

tests/short_sha.bats

@@ -0,0 +1,19 @@
+#!/usr/bin/env bats
+
+@test "Short long hash" {
+  test_short_sha \
+    "a35a1a486a260cfd99c5b6f8c6034a2929ba9b3f" \
+    "a35a1a48"
+}
+
+# Load sluf_ref function
+source entrypoint.sh > /dev/null 2>&1
+
+test_short_sha(){
+  given="${1}"
+  expected="${2}"
+
+  actual="$(short_sha ${given})"
+  echo "expected : [${expected}], actual : [${actual}]"
+  [ "${actual}" == "${expected}" ]
+}

tests/slug_ref.bats

@@ -0,0 +1,55 @@
+#!/usr/bin/env bats
+
+@test "Slug master branch" {
+  test_sluf_ref \
+    "refs/heads/master" \
+    "master"
+}
+
+@test "Slug a feature branch" {
+  test_sluf_ref \
+    "refs/heads/feat/new_feature" \
+    "feat-new-feature"
+}
+
+@test "Slug a fix branch" {
+  test_sluf_ref \
+    "refs/heads/fix/issue_number" \
+    "fix-issue-number"
+}
+
+@test "Slug a simple tag" {
+  test_sluf_ref \
+    "refs/tags/v1.0.0" \
+    "v1-0-0"
+}
+
+@test "Slug a complex tag" {
+  test_sluf_ref \
+    "refs/tags/product@1.0.0-rc.2" \
+    "product-1-0-0-rc-2"
+}
+
+@test "Slug a reference with upper case letters" {
+  test_sluf_ref \
+    "refs/heads/New_Awesome_Product" \
+    "new-awesome-product"
+}
+
+@test "Slug a very long name" {
+  test_sluf_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_sluf_ref() {
+  given="${1}"
+  expected="${2}"
+
+  actual="$(slug_ref \"${given}\")"
+  echo "expected : [${expected}], actual : [${actual}]"
+  [ "${actual}" == "${expected}" ]
+}