Overview

A WoodpeckerCI plugin that formats your code with Prettier, fixes issues, and updates your pull requests automatically.

Peckify uses Prettier to check and update file formats. To avoid setup a Node.js framework and prettier locally, we decided to write the fixed files back and update your pull request.

This should simplify onboarding new contributors to your codebase while ensuring your files get checked and fixed automatically in your WoodpeckerCI workflow.

Until we reach version 1m you should use the :latest or minor version :0.1, :0.2 tag.

Settings

Settings Name	Default	Description
path	.	Tells Peckify which files to test
output_file	none	Also writes stdout and stderr in to the given file
check	true	Tells Peckify to run in check mode
write	none	Run Peckify in write mode
forge_token	none	A user token to interact with the forge system
forge_user	none	The used forge user itself
user_name	none	The username for peckify commits
user_email	none	The email used in git user config
log_level	info	log level for zerolog logger. You can use info or debug

Examples

Basic

- name: 'peckify'
  image: woodpeckercommunity/peckify:latest
  pull: true
  settings:
    write: true
    forge_user: my-forge-user
    forge_token:
      from_secret: my-forge-secret
    git_name: my-forge-user
    git_email: my.mail@foobar.com

Advanced

- name: 'peckify'
  image: woodpeckercommunity/peckify:latest
  pull: true
  settings:
    write: true
    # optional alternative test path
    path: '.'
    # optional output file
    output_file: peckify.log
    forge_user: my-forge-user
    forge_token:
      from_secret: my-forge-secret
    git_name: my-forge-user
    git_email: my.mail@foobar.com

Just Check

- name: 'peckify'
  image: woodpeckercommunity/peckify:latest
  pull: true
  settings:
    check: true