From ed398f784ffc6201a439326df239ebcef308c8e2 Mon Sep 17 00:00:00 2001 From: rlespinasse Date: Tue, 12 Oct 2021 13:10:35 +0200 Subject: [PATCH] feat: slugify a value --- .github/workflows/slugify.yaml | 41 +++++++++++ CODE_OF_CONDUCT.md | 128 +++++++++++++++++++++++++++++++++ README.md | 53 ++++++++++++++ action.yml | 21 ++++++ slugify.sh | 25 +++++++ 5 files changed, 268 insertions(+) create mode 100644 .github/workflows/slugify.yaml create mode 100644 CODE_OF_CONDUCT.md create mode 100644 README.md create mode 100644 action.yml create mode 100755 slugify.sh diff --git a/.github/workflows/slugify.yaml b/.github/workflows/slugify.yaml new file mode 100644 index 0000000..e7cc07a --- /dev/null +++ b/.github/workflows/slugify.yaml @@ -0,0 +1,41 @@ +name: Slugify testing +on: [push] +jobs: + slugify: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + + # Test 1 + - name: Slugify key only + uses: ./ + with: + key: KEY_TEST + env: + KEY_TEST: Key_Test.values + - name: Test result of key only + run: | + [[ "${{ env.KEY_TEST }}" == "Key_Test.values" ]] + [[ "${{ env.KEY_TEST_SLUG }}" == "key_test.values" ]] + [[ "${{ env.KEY_TEST_SLUG_CS }}" == "Key_Test.values" ]] + [[ "${{ env.KEY_TEST_SLUG_URL }}" == "key_test-values" ]] + [[ "${{ env.KEY_TEST_SLUG_URL_CS }}" == "Key_Test-values" ]] + + # Test 2 + - name: Slugify key/value + uses: ./ + with: + key: KEY_VALUE_TEST + value: refs/pulls/feat/-----Some----Changes_to.be------ + - name: Test result of key only + run: | + [[ "${{ env.KEY_VALUE_TEST }}" == "refs/pulls/feat/-----Some----Changes_to.be------" ]] + [[ "${{ env.KEY_VALUE_TEST_SLUG }}" == "feat-some-changes_to.be" ]] + [[ "${{ env.KEY_VALUE_TEST_SLUG_CS }}" == "feat-Some-Changes_to.be" ]] + [[ "${{ env.KEY_VALUE_TEST_SLUG_URL }}" == "feat-some-changes_to-be" ]] + [[ "${{ env.KEY_VALUE_TEST_SLUG_URL_CS }}" == "feat-Some-Changes_to-be" ]] + + # Release + - name: Release this GitHub Action + uses: rlespinasse/release-that@v1.x diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..86b2501 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible 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. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders 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, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +romain.lespinasse@gmail.com. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/README.md b/README.md new file mode 100644 index 0000000..96a6dfb --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +# Slugify + +> Github Action to slugify a value + +Produce some `slug`-ed environment variables based on the input one. + +- `_SLUG` + + - 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 + +- `_SLUG_CS` + + - like `_SLUG` but the content is not put in lower case + +- `_SLUG_URL` (or `_SLUG_URL_CS`) + + - like `_SLUG` (or `_SLUG_CS`) with the `.` character also replaced by `-` + +## Usage + +- Slugify a value and store it using a key + + ```yaml + - uses: rlespinasse/slugify@v1.x + with: + key: KEY_NAME + value: value_to_slugify + ``` + + Will make available + + - `KEY_NAME_SLUG` + - `KEY_NAME_SLUG_CS` + - `KEY_NAME_SLUG_URL` + - `KEY_NAME_SLUG_URL_CS` + +- Slugify the value of an environment variable + + ```yaml + - uses: rlespinasse/slugify@v1.x + with: + key: EXISTING_ENV_VAR + ``` + + Will make available + + - `EXISTING_ENV_VAR_SLUG` + - `EXISTING_ENV_VAR_SLUG_CS` + - `EXISTING_ENV_VAR_SLUG_URL` + - `EXISTING_ENV_VAR_SLUG_URL_CS` diff --git a/action.yml b/action.yml new file mode 100644 index 0000000..c0d6260 --- /dev/null +++ b/action.yml @@ -0,0 +1,21 @@ +name: "Slugify" +description: "Github Action to slugify a value" +author: "Romain Lespinasse" +inputs: + key: + description: "Environment variable that will hold the value and serve as prefix to slugified value" + required: true + value: + description: "Value to slugify" + required: false +branding: + icon: "crop" + color: "gray-dark" +runs: + using: "composite" + steps: + - run: ${{ github.action_path }}/slugify.sh + shell: bash + env: + INPUT_KEY: ${{ inputs.key }} + INPUT_VALUE: ${{ inputs.value }} diff --git a/slugify.sh b/slugify.sh new file mode 100755 index 0000000..3dcb854 --- /dev/null +++ b/slugify.sh @@ -0,0 +1,25 @@ +#!/usr/bin/env bash + +KEY=${INPUT_KEY^^} +CS_VALUE=${INPUT_VALUE:-${!INPUT_KEY}} +VALUE=${CS_VALUE,,} + +slug() { + echo "$1" | + sed -r 's#refs/[^\/]*/##;s/[^a-zA-Z0-9._]+/-/g;s/^-*//;s/-*$//' | + cut -c1-63 +} + +slug_url() { + echo "$1" | + sed -r 's#refs/[^\/]*/##;s/[^a-zA-Z0-9_]+/-/g;s/^-//;s/-$//' | + cut -c1-63 +} + +{ + echo "${KEY}=${CS_VALUE}" + echo "${KEY}_SLUG=$(slug "$VALUE")" + echo "${KEY}_SLUG_CS=$(slug "$CS_VALUE")" + echo "${KEY}_SLUG_URL=$(slug_url "$VALUE")" + echo "${KEY}_SLUG_URL_CS=$(slug_url "$CS_VALUE")" +} >>"$GITHUB_ENV"