mirror of https://github.com/awsdocs/aws-doc-sdk-examples.git synced 2026-03-26 06:22:18 +00:00

Files

Corey Pyle 772ce46454 Dockerfile updates and git hooks (#4261 )

* setup git hooks and add js pre-commit hook

* add readme notes on running docker file

* fix a comment

* fix grammar

* Fix grammar errors and add shell script header.

* Remove directory change.

Co-authored-by: ford prior <108086978+ford-at-aws@users.noreply.github.com>

2023-01-20 15:54:15 -06:00

pre-commit

Dockerfile updates and git hooks (#4261 )

2023-01-20 15:54:15 -06:00

README.md

Dockerfile updates and git hooks (#4261 )

2023-01-20 15:54:15 -06:00

README.md

AWS SDK Code Examples - Git hooks

This repository is configured with git hooks. These hooks run automated code-quality checks like unit tests and linters.

Installation

By default, git checks .git/hooks for existing hooks. This repository hosts hooks in a different location so they can be version controlled. Without updating your local configuration, the hooks will not run. Configure git to use these hooks by running git config core.hooksPath .git-hooks.

Usage

A hook is triggered when its corresponding event takes place. For example, the "pre-commit" hook is triggered when a user initializes a commit, but before that commit is created in the git history.

Hooks can be added to the .git-hooks folder. For a list of valid hooks, see https://git-scm.com/docs/githooks.

Existing hooks

pre-commit

This hook will always run the metadata check. Once the metadata check has passed, it will look in each child directory (non-recursive) for the following path: hook_scripts/pre-commit.sh.

If that file is found, and is executable, it will be run. The javascriptv3 script will be run on commit if changes were made in the javascriptv3 directory.