mirror of
https://github.com/creyD/prettier_action.git
synced 2026-04-15 21:00:35 +02:00
Merge branch 'dev' into override-token
This commit is contained in:
@@ -1,4 +0,0 @@
|
|||||||
FROM node:lts-alpine3.9
|
|
||||||
RUN apk update && apk add --no-cache bash git openssh
|
|
||||||
COPY entrypoint.sh /entrypoint.sh
|
|
||||||
ENTRYPOINT ["/entrypoint.sh"]
|
|
||||||
@@ -16,14 +16,15 @@ A GitHub action for styling files with [prettier](https://prettier.io).
|
|||||||
|
|
||||||
| Parameter | Required | Default | Description |
|
| Parameter | Required | Default | Description |
|
||||||
| - | :-: | :-: | - |
|
| - | :-: | :-: | - |
|
||||||
| dry | :x: | `false` | Runs the action in dry mode. Files wont get changed and the action fails if there are unprettified files. |
|
| dry | :x: | `false` | Runs the action in dry mode. Files wont get changed and the action fails if there are unprettified files. Recommended to use with prettier_options --check |
|
||||||
| prettier_version | :x: | `false` | Specific prettier version (by default use latest) |
|
| prettier_version | :x: | `false` | Specific prettier version (by default use latest) |
|
||||||
| prettier_options | :x: | `"--write **/*.js"` | Prettier options (by default it applies to the whole repository) |
|
| prettier_options | :x: | `"--write **/*.js"` | Prettier options (by default it applies to the whole repository) |
|
||||||
| commit_options | :x: | - | Custom git commit options |
|
| commit_options | :x: | - | Custom git commit options |
|
||||||
|
| push_options | :x: | - | Custom git push options |
|
||||||
| same_commit | :x: | `false` | Update the current commit instead of creating a new one, created by [Joren Broekema](https://github.com/jorenbroekema), this command works only with the checkout action set to fetch depth '0' (see example 2) |
|
| same_commit | :x: | `false` | Update the current commit instead of creating a new one, created by [Joren Broekema](https://github.com/jorenbroekema), this command works only with the checkout action set to fetch depth '0' (see example 2) |
|
||||||
| commit_message | :x: | `"Prettified Code!"` | Custom git commit message, will be ignored if used with `same_commit` |
|
| commit_message | :x: | `"Prettified Code!"` | Custom git commit message, will be ignored if used with `same_commit` |
|
||||||
| file_pattern | :x: | `*` | Custom git add file pattern, can't be used with only_changed! |
|
| file_pattern | :x: | `*` | Custom git add file pattern, can't be used with only_changed! |
|
||||||
| prettier_plugins | :x: | ` ` | Install Prettier plugins, i.e. `@prettier/prettier-php @prettier/some-other-plugin` |
|
| prettier_plugins | :x: | - | Install Prettier plugins, i.e. `@prettier/plugin-php @prettier/plugin-other` |
|
||||||
| only_changed | :x: | `false` | Only prettify changed files, can't be used with file_pattern! This command works only with the checkout action set to fetch depth '0' (see example 2)|
|
| only_changed | :x: | `false` | Only prettify changed files, can't be used with file_pattern! This command works only with the checkout action set to fetch depth '0' (see example 2)|
|
||||||
| github_token | :x: | `${{ github.token }}` | The default [GITHUB_TOKEN](https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret) or a [Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token)
|
| github_token | :x: | `${{ github.token }}` | The default [GITHUB_TOKEN](https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret) or a [Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token)
|
||||||
|
|
||||||
|
|||||||
35
action.yml
35
action.yml
@@ -7,7 +7,7 @@ inputs:
|
|||||||
commit_message:
|
commit_message:
|
||||||
description: Commit message, will be ignored if used with same_commit
|
description: Commit message, will be ignored if used with same_commit
|
||||||
required: false
|
required: false
|
||||||
default: 'Prettified Code!'
|
default: "Prettified Code!"
|
||||||
same_commit:
|
same_commit:
|
||||||
description: Update the current commit instead of creating a new one
|
description: Update the current commit instead of creating a new one
|
||||||
required: false
|
required: false
|
||||||
@@ -15,14 +15,17 @@ inputs:
|
|||||||
commit_options:
|
commit_options:
|
||||||
description: Commit options
|
description: Commit options
|
||||||
required: false
|
required: false
|
||||||
|
push_options:
|
||||||
|
description: Git push options
|
||||||
|
required: false
|
||||||
file_pattern:
|
file_pattern:
|
||||||
description: File pattern used for `git add`, can't be used with only_changed!
|
description: File pattern used for `git add`, can't be used with only_changed!
|
||||||
required: false
|
required: false
|
||||||
default: '*'
|
default: "*"
|
||||||
prettier_options:
|
prettier_options:
|
||||||
description: Options for the `prettier` command
|
description: Options for the `prettier` command
|
||||||
required: false
|
required: false
|
||||||
default: '--write **/*.js'
|
default: "--write **/*.js"
|
||||||
dry:
|
dry:
|
||||||
description: Running the script in dry mode just shows whether there are files that should be prettified or not
|
description: Running the script in dry mode just shows whether there are files that should be prettified or not
|
||||||
required: false
|
required: false
|
||||||
@@ -36,7 +39,7 @@ inputs:
|
|||||||
required: false
|
required: false
|
||||||
default: false
|
default: false
|
||||||
prettier_plugins:
|
prettier_plugins:
|
||||||
description: Install Prettier plugins, i.e. `@prettier/prettier-php @prettier/some-other-plugin`
|
description: Install Prettier plugins, i.e. `@prettier/plugin-php @prettier/plugin-other`
|
||||||
required: false
|
required: false
|
||||||
default: ''
|
default: ''
|
||||||
github_token:
|
github_token:
|
||||||
@@ -44,10 +47,26 @@ inputs:
|
|||||||
required: false
|
required: false
|
||||||
default: ${{ github.token }}
|
default: ${{ github.token }}
|
||||||
|
|
||||||
|
|
||||||
runs:
|
runs:
|
||||||
using: 'docker'
|
using: "composite"
|
||||||
image: 'Dockerfile'
|
steps:
|
||||||
|
- name: Prettify code!
|
||||||
|
shell: bash
|
||||||
|
run: >-
|
||||||
|
PATH=$(cd $GITHUB_ACTION_PATH; npm bin):$PATH
|
||||||
|
${{ github.action_path }}/entrypoint.sh
|
||||||
|
env:
|
||||||
|
INPUT_COMMIT_MESSAGE: ${{ inputs.commit_message }}
|
||||||
|
INPUT_SAME_COMMIT: ${{ inputs.same_commit }}
|
||||||
|
INPUT_COMMIT_OPTIONS: ${{ inputs.commit_options }}
|
||||||
|
INPUT_FILE_PATTERN: ${{ inputs.file_pattern }}
|
||||||
|
INPUT_PRETTIER_OPTIONS: ${{ inputs.prettier_options }}
|
||||||
|
INPUT_DRY: ${{ inputs.dry }}
|
||||||
|
INPUT_PRETTIER_VERSION: ${{ inputs.prettier_version }}
|
||||||
|
INPUT_ONLY_CHANGED: ${{ inputs.only_changed }}
|
||||||
|
INPUT_PRETTIER_PLUGINS: ${{ inputs.prettier_plugins }}
|
||||||
|
|
||||||
branding:
|
branding:
|
||||||
icon: 'award'
|
icon: "award"
|
||||||
color: 'green'
|
color: "green"
|
||||||
|
|||||||
@@ -1,7 +1,8 @@
|
|||||||
#!/bin/sh
|
#!/bin/bash
|
||||||
# e is for exiting the script automatically if a command fails, u is for exiting if a variable is not set
|
# e is for exiting the script automatically if a command fails, u is for exiting if a variable is not set
|
||||||
# x would be for showing the commands before they are executed
|
# x would be for showing the commands before they are executed
|
||||||
set -eu
|
set -eu
|
||||||
|
shopt -s globstar nullglob
|
||||||
|
|
||||||
# FUNCTIONS
|
# FUNCTIONS
|
||||||
# Function for setting up git env in the docker container (copied from https://github.com/stefanzweifel/git-auto-commit-action/blob/master/entrypoint.sh)
|
# Function for setting up git env in the docker container (copied from https://github.com/stefanzweifel/git-auto-commit-action/blob/master/entrypoint.sh)
|
||||||
@@ -25,14 +26,23 @@ _git_changed() {
|
|||||||
[[ -n "$(git status -s)" ]]
|
[[ -n "$(git status -s)" ]]
|
||||||
}
|
}
|
||||||
|
|
||||||
|
_git_changes() {
|
||||||
|
git diff
|
||||||
|
}
|
||||||
|
|
||||||
|
(
|
||||||
# PROGRAM
|
# PROGRAM
|
||||||
|
# Changing to the directory
|
||||||
|
cd "$GITHUB_ACTION_PATH"
|
||||||
|
|
||||||
echo "Installing prettier..."
|
echo "Installing prettier..."
|
||||||
|
|
||||||
case $INPUT_PRETTIER_VERSION in
|
case $INPUT_PRETTIER_VERSION in
|
||||||
false)
|
false)
|
||||||
npm install --silent --global prettier
|
npm install --silent prettier
|
||||||
;;
|
;;
|
||||||
*)
|
*)
|
||||||
npm install --silent --global prettier@$INPUT_PRETTIER_VERSION
|
npm install --silent prettier@$INPUT_PRETTIER_VERSION
|
||||||
;;
|
;;
|
||||||
esac
|
esac
|
||||||
|
|
||||||
@@ -48,15 +58,24 @@ if [ -n "$INPUT_PRETTIER_PLUGINS" ]; then
|
|||||||
done
|
done
|
||||||
npm install --silent --global $INPUT_PRETTIER_PLUGINS
|
npm install --silent --global $INPUT_PRETTIER_PLUGINS
|
||||||
fi
|
fi
|
||||||
|
)
|
||||||
|
|
||||||
echo "Prettifing files..."
|
PRETTIER_RESULT=0
|
||||||
|
echo "Prettifying files..."
|
||||||
echo "Files:"
|
echo "Files:"
|
||||||
prettier $INPUT_PRETTIER_OPTIONS || echo "Problem running prettier with $INPUT_PRETTIER_OPTIONS"
|
prettier $INPUT_PRETTIER_OPTIONS || { PRETTIER_RESULT=$?; echo "Problem running prettier with $INPUT_PRETTIER_OPTIONS"; }
|
||||||
|
|
||||||
|
# Ignore node modules and other action created files
|
||||||
|
rm -r node_modules/ || echo "No node_modules/ folder."
|
||||||
|
git reset --hard package-lock.json || rm package-lock.json || echo "No package-lock.json file."
|
||||||
|
|
||||||
# To keep runtime good, just continue if something was changed
|
# To keep runtime good, just continue if something was changed
|
||||||
if _git_changed; then
|
if _git_changed; then
|
||||||
|
# case when --write is used with dry-run so if something is unpretty there will always have _git_changed
|
||||||
if $INPUT_DRY; then
|
if $INPUT_DRY; then
|
||||||
echo "Prettier found unpretty files!"
|
echo "Unpretty Files Changes:"
|
||||||
|
_git_changes
|
||||||
|
echo "Finishing dry-run. Exiting before committing."
|
||||||
exit 1
|
exit 1
|
||||||
else
|
else
|
||||||
# Calling method to configure the git environemnt
|
# Calling method to configure the git environemnt
|
||||||
@@ -81,10 +100,18 @@ if _git_changed; then
|
|||||||
git push origin -f
|
git push origin -f
|
||||||
else
|
else
|
||||||
git commit -m "$INPUT_COMMIT_MESSAGE" --author="$GITHUB_ACTOR <$GITHUB_ACTOR@users.noreply.github.com>" ${INPUT_COMMIT_OPTIONS:+"$INPUT_COMMIT_OPTIONS"} || echo "No files added to commit"
|
git commit -m "$INPUT_COMMIT_MESSAGE" --author="$GITHUB_ACTOR <$GITHUB_ACTOR@users.noreply.github.com>" ${INPUT_COMMIT_OPTIONS:+"$INPUT_COMMIT_OPTIONS"} || echo "No files added to commit"
|
||||||
git push origin
|
git push origin $INPUT_PUSH_OPTIONS
|
||||||
fi
|
fi
|
||||||
echo "Changes pushed successfully."
|
echo "Changes pushed successfully."
|
||||||
fi
|
fi
|
||||||
else
|
else
|
||||||
|
# case when --check is used so there will never have something to commit but there are unpretty files
|
||||||
|
if [ "$PRETTIER_RESULT" -eq 1 ]; then
|
||||||
|
echo "Prettier found unpretty files!"
|
||||||
|
exit 1
|
||||||
|
else
|
||||||
|
echo "Finishing dry-run."
|
||||||
|
fi
|
||||||
|
echo "No unpretty files!"
|
||||||
echo "Nothing to commit. Exiting."
|
echo "Nothing to commit. Exiting."
|
||||||
fi
|
fi
|
||||||
|
|||||||
Reference in New Issue
Block a user