From 33111e11f33dae31da9ce5e45573004ff05a74dd Mon Sep 17 00:00:00 2001 From: rlespinasse Date: Sat, 4 Dec 2021 23:30:11 +0100 Subject: [PATCH] feat: support basic short revision --- .github/FUNDING.yml | 3 + .github/workflows/shortify-git-revision.yaml | 65 ++++++++++ CODE_OF_CONDUCT.md | 128 +++++++++++++++++++ README.md | 34 +++++ action.yml | 21 +++ shortify.sh | 21 +++ 6 files changed, 272 insertions(+) create mode 100644 .github/FUNDING.yml create mode 100644 .github/workflows/shortify-git-revision.yaml create mode 100644 CODE_OF_CONDUCT.md create mode 100644 README.md create mode 100644 action.yml create mode 100755 shortify.sh diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..8affb62 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,3 @@ +# These are supported funding model platforms + +github: rlespinasse diff --git a/.github/workflows/shortify-git-revision.yaml b/.github/workflows/shortify-git-revision.yaml new file mode 100644 index 0000000..c7c9707 --- /dev/null +++ b/.github/workflows/shortify-git-revision.yaml @@ -0,0 +1,65 @@ +name: Shortify git revision testing +on: [push] +jobs: + shortify-git-revision-on-os: + strategy: + fail-fast: false + matrix: + os: [macos-latest, ubuntu-latest, windows-latest] + runs-on: ${{ matrix.os }} + concurrency: + group: shortify-git-revision-on-os-${{ github.ref }} + cancel-in-progress: true + steps: + - name: Checkout + uses: actions/checkout@v2 + + # Test 1 + - name: Shortify an existing git revision + uses: ./ + with: + name: ROOT_COMMIT + revision: 88428f56bd9d2751c47106bedfd148162dfa50b8 + - name: Test result 1 + run: | + [[ "${{ env.ROOT_COMMIT }}" == "88428f56bd9d2751c47106bedfd148162dfa50b8" ]] + [[ "${{ env.ROOT_COMMIT_SHORT }}" == "88428f5" ]] + shell: bash + + # Test 2 + - name: Shortify an existing git revision from an env variable + uses: ./ + with: + name: ENV_VAR_COMMIT + env: + ENV_VAR_COMMIT: 88428f56bd9d2751c47106bedfd148162dfa50b8 + - name: Test result 1 + run: | + [[ "${{ env.ENV_VAR_COMMIT }}" == "88428f56bd9d2751c47106bedfd148162dfa50b8" ]] + [[ "${{ env.ENV_VAR_COMMIT_SHORT }}" == "88428f5" ]] + shell: bash + + # Test 3 + - name: Shortify a missing git revision + uses: ./ + with: + name: MISSING_REVISION + revision: "" + - name: Test result 3 + run: | + [[ -z "${{ env.MISSING_REVISION }}" ]] + [[ -z "${{ env.MISSING_REVISION_SHORT }}" ]] + shell: bash + + shortify-git-revision-release: + runs-on: ubuntu-latest + concurrency: + group: shortify-git-revision-release-${{ github.ref }} + needs: shortify-git-revision-on-os + steps: + - name: Checkout + uses: actions/checkout@v2 + + # 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..ee27f05 --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# Shortify git revision + +> Github Action to shortify a git revision + +Produce short revision environment variable based on the input one. + +## Usage + +- Shortify an environment variable + + ```yaml + - uses: rlespinasse/shortify-git-revision@v1.x + with: + name: GITHUB_SHA + revision: value_to_slugify + ``` + + Will make available + + - `GITHUB_SHA_SHORT` + +- Shortify any revision + + ```yaml + - uses: rlespinasse/slugify-value@v1.x + with: + name: SOME_REVISION + revision: 88428f56bd9d2751c47106bedfd148162dfa50b8 + ``` + + Will make available + + - `SOME_REVISION` + - `SOME_REVISION_SHORT` diff --git a/action.yml b/action.yml new file mode 100644 index 0000000..936f490 --- /dev/null +++ b/action.yml @@ -0,0 +1,21 @@ +name: "Shortify Git Revision" +description: "Github Action to shortify a git revision" +author: "Romain Lespinasse" +inputs: + name: + description: "Environment variable that will hold the value and serve as prefix to shortify value" + required: true + revision: + description: "Revision to short" + required: false +branding: + icon: "crop" + color: "gray-dark" +runs: + using: "composite" + steps: + - run: $GITHUB_ACTION_PATH/shortify.sh + shell: bash + env: + INPUT_NAME: ${{ inputs.name }} + INPUT_REVISION: ${{ inputs.revision }} diff --git a/shortify.sh b/shortify.sh new file mode 100755 index 0000000..87568e9 --- /dev/null +++ b/shortify.sh @@ -0,0 +1,21 @@ +#!/usr/bin/env bash + +if [[ "$OSTYPE" == "darwin"* ]]; then + # On MacOS, + # bash don't support substitution, so we use 'tr' + NAME=$(echo "$INPUT_NAME" | tr '[:lower:]' '[:upper:]') +else + NAME=${INPUT_NAME^^} +fi +REVISION=${INPUT_REVISION:-${!NAME}} + +if [ -z "$REVISION" ]; then + exit 0 +fi + +if [ "$(git cat-file -e "$REVISION")" == "" ]; then + { + echo "${NAME}=${REVISION}" + echo "${NAME}_SHORT=$(git rev-parse --short "$REVISION")" + } >>"$GITHUB_ENV" +fi