Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 2.19 KB

README.md

File metadata and controls

41 lines (28 loc) · 2.19 KB
Raw

Pre Commit Hooks

This repository is used to store all scripts that are run in our CI pipelines during the pre-commit job. If you want them in your repository, you'll have to:

  • Allow your project under the CI_JOB_TOKEN Access Token settings
  • Add the pre-commit CI template in the .github/workflows file of your repository

Using pre-commit-hooks with pre-commit

All projects that have to use these pre-commit scripts need to be in the allow list of this repository (Settings > CI/CD > Token Access and write the repository location). In the .github/workflows of your project you'll need to reference the CI Template we're using for the pre-commit by adding this:

include:
  - project: github.com/zurutech/pre-commit-hooks
    file: .pre-commit.yml   
    ref: main

The template is located here, all the fiels can be overwritten in the pre-commit job of your CI in case you need to do something differently.

WARNING: if the job gets the forbidden response when downloading the template, make sure that the PRE_COMMIT_TOKEN CI/CD variable is set under the group Zuru Home in gitlab. The token needs the priviledges to read the CI Templates repository.

The job will use the .pre-commit-config.yaml located in the root directoy of your repository. An example of how to use a hook:

- repo: https://github.com/zurutech/pre-commit-hooks
  rev: v5.0.0
  hooks:
    - id: copyright_updater

The rev field indicates the tag or the release of the code of this repository. At the moment the rev will always have to be latest and only the code in the latest commit of the main branch will be used. Since there is no latest immutable tag (like a release) there will be a warning in the pre-commit job. The tag latest job in the pipeline will tag last commit on the main branch with latest.

Add pre-commit hooks scripts to this repo

If you need to add your script you'll have to:

  • Add the script in the pre_commit_hooks folder
  • Define the entrypoint in the setup.cfg in the \[options.entry_points\] section
  • Define the prehook and its arguments in the .pre-commit-hooks.yaml file. All options are visible here