diff --git a/README.md b/README.md index 4d0fb81..707adc0 100644 --- a/README.md +++ b/README.md @@ -18,11 +18,13 @@ A GitHub action for styling files with [prettier](https://prettier.io). | - | :-: | :-: | - | | 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) | +| working_directory | :x: | `false` | Specify a directory to cd into before installing prettier and running it, use relative file path to the repository root for example `app/` | | prettier_options | :x: | `"--write **/*.js"` | Prettier options (by default it applies to the whole repository) | | 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) | | commit_message | :x: | `"Prettified Code!"` | Custom git commit message, will be ignored if used with `same_commit` | +| commit_description | :x: | - | Custom git extended 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! | | 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)| @@ -32,7 +34,8 @@ A GitHub action for styling files with [prettier](https://prettier.io). ### Example Config -#### Example 1 (run on push in master) +> Hint: if you still use the old naming convention or generally a different branch name, please replace the `main` in the following configurations. +#### Example 1 (run on push in branch main) ```yaml name: Continuous Integration @@ -41,7 +44,7 @@ on: pull_request: push: branches: - - master + - main jobs: prettier: @@ -55,7 +58,7 @@ jobs: ref: ${{ github.head_ref }} - name: Prettify code - uses: creyD/prettier_action@v4.0 + uses: creyD/prettier_action@v4.1 with: # This part is also where you can pass other options, for example: prettier_options: --write **/*.{js,md} @@ -67,7 +70,7 @@ name: Continuous Integration on: pull_request: - branches: [master] + branches: [main] jobs: prettier: @@ -83,7 +86,7 @@ jobs: fetch-depth: 0 - name: Prettify code - uses: creyD/prettier_action@v4.0 + uses: creyD/prettier_action@v4.1 with: # This part is also where you can pass other options, for example: prettier_options: --write **/*.{js,md} @@ -96,7 +99,7 @@ name: Continuous Integration on: pull_request: - branches: [master] + branches: [main] jobs: prettier: @@ -112,7 +115,7 @@ jobs: persist-credentials: false - name: Prettify code - uses: creyD/prettier_action@v4.0 + uses: creyD/prettier_action@v4.1 with: prettier_options: --write **/*.{js,md} only_changed: True @@ -126,7 +129,7 @@ name: Continuous Integration on: pull_request: - branches: [master] + branches: [main] jobs: prettier: @@ -142,7 +145,7 @@ jobs: persist-credentials: false - name: Prettify code - uses: creyD/prettier_action@v4.0 + uses: creyD/prettier_action@v4.1 with: dry: True github_token: ${{ secrets.PERSONAL_GITHUB_TOKEN }} diff --git a/action.yml b/action.yml index 3217353..c709804 100644 --- a/action.yml +++ b/action.yml @@ -8,6 +8,10 @@ inputs: description: Commit message, will be ignored if used with same_commit required: false default: "Prettified Code!" + commit_description: + description: Extended commit message, will be ignored if used with same_commit + required: false + default: "" same_commit: description: Update the current commit instead of creating a new one required: false @@ -34,6 +38,10 @@ inputs: description: Specific version of prettier (by default just use the latest version) required: false default: false + working_directory: + description: Specify a directory to cd into before installing prettier and running it + required: false + default: false only_changed: description: Only prettify files changed in the last commit, can't be used with file_pattern! required: false @@ -41,13 +49,12 @@ inputs: prettier_plugins: description: Install Prettier plugins, i.e. `@prettier/plugin-php @prettier/plugin-other` required: false - default: '' + default: "" github_token: description: GitHub Token or PAT token used to authenticate against a repository required: false default: ${{ github.token }} - runs: using: "composite" steps: @@ -58,6 +65,7 @@ runs: ${{ github.action_path }}/entrypoint.sh env: INPUT_COMMIT_MESSAGE: ${{ inputs.commit_message }} + INPUT_COMMIT_DESCRIPTION: ${{ inputs.commit_description }} INPUT_SAME_COMMIT: ${{ inputs.same_commit }} INPUT_COMMIT_OPTIONS: ${{ inputs.commit_options }} INPUT_FILE_PATTERN: ${{ inputs.file_pattern }} @@ -66,6 +74,7 @@ runs: INPUT_PRETTIER_VERSION: ${{ inputs.prettier_version }} INPUT_ONLY_CHANGED: ${{ inputs.only_changed }} INPUT_PRETTIER_PLUGINS: ${{ inputs.prettier_plugins }} + INPUT_WORKING_DIRECTORY: ${{ inputs.working_directory }} INPUT_GITHUB_TOKEN: ${{ inputs.github_token }} branding: diff --git a/entrypoint.sh b/entrypoint.sh index d3a358b..7a764a4 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -37,6 +37,14 @@ cd "$GITHUB_ACTION_PATH" echo "Installing prettier..." +case $INPUT_WORKING_DIRECTORY in + false) + ;; + *) + cd $INPUT_WORKING_DIRECTORY + ;; +esac + case $INPUT_PRETTIER_VERSION in false) npm install --silent prettier @@ -74,7 +82,7 @@ else fi if [ -f 'package-lock.json' ]; then - git reset --hard package-lock.json || rm package-lock.json + git checkout -- package-lock.json else echo "No package-lock.json file." fi @@ -93,10 +101,13 @@ if _git_changed; then if $INPUT_ONLY_CHANGED; then # --diff-filter=d excludes deleted files + OLDIFS="$IFS" + IFS=$'\n' for file in $(git diff --name-only --diff-filter=d HEAD^..HEAD) do - git add $file + git add "$file" done + IFS="$OLDIFS" else # Add changes to git git add "${INPUT_FILE_PATTERN}" || echo "Problem adding your files with pattern ${INPUT_FILE_PATTERN}" @@ -109,7 +120,7 @@ if _git_changed; then git commit --amend --no-edit git push origin -f 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" if [ "$INPUT_COMMIT_DESCRIPTION" != "" ]; then echo '-m "$INPUT_COMMIT_DESCRIPTION"' fi --author="$GITHUB_ACTOR <$GITHUB_ACTOR@users.noreply.github.com>" ${INPUT_COMMIT_OPTIONS:+"$INPUT_COMMIT_OPTIONS"} || echo "No files added to commit" git push origin ${INPUT_PUSH_OPTIONS:-} fi echo "Changes pushed successfully."