speckle-server/.pre-commit-config.yaml

# pre-commit for deployment related resources
# e.g. shell files, dockerfiles, helm chart etc..
repos:
  - repo: https://github.com/hadolint/hadolint
    rev: 'v2.10.0'
    hooks:
      - id: hadolint
  # Cannot use official repo as it relies on Docker, which cannot be supported by either pre-commit.ci or CircleCI
  - repo: https://github.com/Jarmos-san/shellcheck-precommit
    rev: 'v0.2.0'
    hooks:
      - id: shellcheck-system
        name: shellcheck

  - repo: https://github.com/syntaqx/git-hooks
    rev: 'v0.0.17'
    hooks:
      - id: circleci-config-validate

  - repo: https://github.com/specklesystems/pre-commit
    rev: '0.2.0'
    hooks:
      - id: ggshield-not-ci

  - repo: https://github.com/psf/black
    rev: '22.10.0'
    hooks:
      - id: black # python formatter
        name: black (python formatter)

  - repo: https://github.com/charliermarsh/ruff-pre-commit
    rev: v0.0.170
    hooks:
      - id: ruff
        name: ruff (python linter)
        args:
          - --ignore=E501 # ignoring error about lines that are too long

  - repo: local
    hooks:
      - id: helm-documentation
        name: Helm Json Schema
        language: system
        files: utils\/helm\/speckle\-server\/values\.yaml
        entry: utils/helm/update-schema-json.sh
        description: If this fails it is because the values.yaml file was updated. Or has missing or incorrect documentation.

    # helmlint should occur after the json schema is updated
  - repo: https://github.com/gruntwork-io/pre-commit
    rev: 'v0.1.17'
    hooks:
      - id: helmlint

ci:
  autoupdate_schedule: quarterly
gergo/pre commit (#906) * Adds hadolint as pre-commit * Addresses all hadolint comments * Hadolint docker works when entrypoint explicitly provided * Use noninteractive apt-get frontend and clean after install * build(circleci): filters for pre-commit should be same as for test-server * remove cache prefix as not currently necessary due to pre-commit-config.yaml changing * build(circleci): enable remote docker for pre-commit * build(circleci): use speckle pre-commit runner with built-in hadolint * build(server): dockerfile RUN statements are consolidated Each RUN statement in a Dockerfile creates a new layer. Hadolint rule DL3059 suggests they should be consolidated. * build(server): dockerfile RUN statements are consolidated Each RUN statement in a Dockerfile creates a new layer. Hadolint rule DL3059 suggests they should be consolidated. * Improve husky bash script to catch errors * Integrates pre-commit with husky * pre-commit should now be run by husky on every commit * pre-commit which requires additional installed dependencies is moved to separate file * Update README for revised developer instructions * Updates pre-commit yarn script * refactor(pre-commit): make everyone happy with loosly integrating husky and pre-commit scripts * chore(clean up pre-commit configs): clean some more pre-commit mess * chore(pre-commit): run pre-commit in ci too * fix(husky pre-commit): fix ci build husky invocation, the script is not commited to git * fix(circleci config): install yarn packages for linting in pre-commit * fix(pre-commit): fix shellcheck disable comment placement * fix(pre-commit): add shellcheck ignore * fix(pre-commit husyk): fix shellcheck ignore version Co-authored-by: Iain Sproat <68657+iainsproat@users.noreply.github.com> 2022-08-11 14:49:47 +03:00			`# pre-commit for deployment related resources`
			`# e.g. shell files, dockerfiles, helm chart etc..`
feat(root): add pre-commit configuration with eslint and prettier 2022-04-01 10:56:47 +03:00			`repos:`
gergo/pre commit (#906) * Adds hadolint as pre-commit * Addresses all hadolint comments * Hadolint docker works when entrypoint explicitly provided * Use noninteractive apt-get frontend and clean after install * build(circleci): filters for pre-commit should be same as for test-server * remove cache prefix as not currently necessary due to pre-commit-config.yaml changing * build(circleci): enable remote docker for pre-commit * build(circleci): use speckle pre-commit runner with built-in hadolint * build(server): dockerfile RUN statements are consolidated Each RUN statement in a Dockerfile creates a new layer. Hadolint rule DL3059 suggests they should be consolidated. * build(server): dockerfile RUN statements are consolidated Each RUN statement in a Dockerfile creates a new layer. Hadolint rule DL3059 suggests they should be consolidated. * Improve husky bash script to catch errors * Integrates pre-commit with husky * pre-commit should now be run by husky on every commit * pre-commit which requires additional installed dependencies is moved to separate file * Update README for revised developer instructions * Updates pre-commit yarn script * refactor(pre-commit): make everyone happy with loosly integrating husky and pre-commit scripts * chore(clean up pre-commit configs): clean some more pre-commit mess * chore(pre-commit): run pre-commit in ci too * fix(husky pre-commit): fix ci build husky invocation, the script is not commited to git * fix(circleci config): install yarn packages for linting in pre-commit * fix(pre-commit): fix shellcheck disable comment placement * fix(pre-commit): add shellcheck ignore * fix(pre-commit husyk): fix shellcheck ignore version Co-authored-by: Iain Sproat <68657+iainsproat@users.noreply.github.com> 2022-08-11 14:49:47 +03:00			`- repo: https://github.com/hadolint/hadolint`
			`rev: 'v2.10.0'`
feat(root): add pre-commit configuration with eslint and prettier 2022-04-01 10:56:47 +03:00			`hooks:`
gergo/pre commit (#906) * Adds hadolint as pre-commit * Addresses all hadolint comments * Hadolint docker works when entrypoint explicitly provided * Use noninteractive apt-get frontend and clean after install * build(circleci): filters for pre-commit should be same as for test-server * remove cache prefix as not currently necessary due to pre-commit-config.yaml changing * build(circleci): enable remote docker for pre-commit * build(circleci): use speckle pre-commit runner with built-in hadolint * build(server): dockerfile RUN statements are consolidated Each RUN statement in a Dockerfile creates a new layer. Hadolint rule DL3059 suggests they should be consolidated. * build(server): dockerfile RUN statements are consolidated Each RUN statement in a Dockerfile creates a new layer. Hadolint rule DL3059 suggests they should be consolidated. * Improve husky bash script to catch errors * Integrates pre-commit with husky * pre-commit should now be run by husky on every commit * pre-commit which requires additional installed dependencies is moved to separate file * Update README for revised developer instructions * Updates pre-commit yarn script * refactor(pre-commit): make everyone happy with loosly integrating husky and pre-commit scripts * chore(clean up pre-commit configs): clean some more pre-commit mess * chore(pre-commit): run pre-commit in ci too * fix(husky pre-commit): fix ci build husky invocation, the script is not commited to git * fix(circleci config): install yarn packages for linting in pre-commit * fix(pre-commit): fix shellcheck disable comment placement * fix(pre-commit): add shellcheck ignore * fix(pre-commit husyk): fix shellcheck ignore version Co-authored-by: Iain Sproat <68657+iainsproat@users.noreply.github.com> 2022-08-11 14:49:47 +03:00			`- id: hadolint`
			`# Cannot use official repo as it relies on Docker, which cannot be supported by either pre-commit.ci or CircleCI`
			`- repo: https://github.com/Jarmos-san/shellcheck-precommit`
			`rev: 'v0.2.0'`
			`hooks:`
			`- id: shellcheck-system`
Enable python linting/formatting in pre-commit (#1257) - fix all the linting/formatting issues 2022-12-09 14:20:45 +03:00			`name: shellcheck`
ci(pre-commit): add pre-commit ci badge (#664) * ci(pre-commit): add pre-commit ci badge * ci(pre-commit ci): add eslint extra dependencies * test(server test): remove to short timeout from rest tests * ci(pre-commit ci): add eslint as dependenency * ci(circle ci): remove linting from circle ci since its moved to pre-commit ci 2022-04-05 17:18:17 +03:00
Circleci added to pre commit (#951) * Add CircleCI config validation to pre-commit 2022-08-23 11:18:40 +03:00			`- repo: https://github.com/syntaqx/git-hooks`
			`rev: 'v0.0.17'`
			`hooks:`
			`- id: circleci-config-validate`

Adds gitguardian ggshield pre-commit hook (#912) * Adds gitguardian ggshield pre-commit step * Intended to be run locally and not in CI * Updates gitguardian config to version 2 2022-10-25 15:41:00 +03:00			`- repo: https://github.com/specklesystems/pre-commit`
			`rev: '0.2.0'`
			`hooks:`
			`- id: ggshield-not-ci`

Enable python linting/formatting in pre-commit (#1257) - fix all the linting/formatting issues 2022-12-09 14:20:45 +03:00			`- repo: https://github.com/psf/black`
			`rev: '22.10.0'`
			`hooks:`
			`- id: black # python formatter`
			`name: black (python formatter)`

			`- repo: https://github.com/charliermarsh/ruff-pre-commit`
			`rev: v0.0.170`
			`hooks:`
			`- id: ruff`
			`name: ruff (python linter)`
			`args:`
			`- --ignore=E501 # ignoring error about lines that are too long`

feat(circleci): adds a new step to ensure Helm Chart documentation is kept in line with Helm Chart (#1574) * fix(helm): update documentation to match helm chart * fix(helm): update documentation should not update README in helm repository * fix(helm): should ensure output schema conforms to prettier requirements * feat(pre-commit): update helm documentation as part of pre-commit * feat(circleci): update Helm README when publishing new Helm chart * fix(pre-commit): need to npm install before using readme generator 2023-05-12 15:26:28 +03:00			`- repo: local`
			`hooks:`
			`- id: helm-documentation`
feat(helm): configure inspect flag for server via helm chart (#1593) 2023-06-01 23:43:22 +03:00			`name: Helm Json Schema`
feat(circleci): adds a new step to ensure Helm Chart documentation is kept in line with Helm Chart (#1574) * fix(helm): update documentation to match helm chart * fix(helm): update documentation should not update README in helm repository * fix(helm): should ensure output schema conforms to prettier requirements * feat(pre-commit): update helm documentation as part of pre-commit * feat(circleci): update Helm README when publishing new Helm chart * fix(pre-commit): need to npm install before using readme generator 2023-05-12 15:26:28 +03:00			`language: system`
feat: add missing FE1 fields to the FE2 GQL schema (#2471) * WIP version create * commitCreate migrated * minor cleanup * commitReceived migrated * added Project.object * Project.comment introduced * moving away old API usages in FE1 * ProjectMutations.batchDelete * project pending access requests * WIP project access req tests * project access req tests done * ModelByName test * version mutation tests * project.object tests * batch delete tests * minor improvements to redirect logging 2024-07-10 12:33:53 +03:00			`files: utils\/helm\/speckle\-server\/values\.yaml`
feat(circleci): adds a new step to ensure Helm Chart documentation is kept in line with Helm Chart (#1574) * fix(helm): update documentation to match helm chart * fix(helm): update documentation should not update README in helm repository * fix(helm): should ensure output schema conforms to prettier requirements * feat(pre-commit): update helm documentation as part of pre-commit * feat(circleci): update Helm README when publishing new Helm chart * fix(pre-commit): need to npm install before using readme generator 2023-05-12 15:26:28 +03:00			`entry: utils/helm/update-schema-json.sh`
			`description: If this fails it is because the values.yaml file was updated. Or has missing or incorrect documentation.`

feat(helm): allow pretty-format logging to be enabled in helm chart (#2433) * feat(helm): allow pretty-format logging to be enabled in helm chart * fix json schema * ensure helm linting occurs after the json schema is updated * Booleans must be quoted when passed to environment variables 2024-06-25 20:12:03 +03:00			`# helmlint should occur after the json schema is updated`
			`- repo: https://github.com/gruntwork-io/pre-commit`
			`rev: 'v0.1.17'`
			`hooks:`
			`- id: helmlint`

ci(pre-commit ci): set auto update frequency for pre-commit ci 2022-04-13 13:58:21 +03:00			`ci:`
			`autoupdate_schedule: quarterly`