cloudposse / cloudposse/atmos

Support Atmos Pre-Commit Hooks

Open
#3,023 6 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
1.4k
Forks
175
Avg merge
2d 3h
Merged PRs (30d)
134

Description

### Describe the Feature

Support Atmos Pre-commit hooks for documentation generation, validation, linting, and whatever else your heart desires. Maybe something like:

```yaml
repos:
- repo: https://github.com/cloudposse/atmos
rev: v1.227.0
hooks:
- id: atmos-generate-docs
- id: atmos-validate-components
- id: atmos-validate-stacks
```

### Expected Behavior

_No response_

### Use Case

_No response_

### Describe Ideal Solution

```yaml
# .pre-commit-hooks.yaml
- id: atmos-generate-docs
name: Atmos Generate Documentation
description: Generate component and stack documentation.
entry: atmos docs generate readme
language: golang
pass_filenames: false

### Alternatives Considered

_No response_

### Additional Context

_No response_

Contributor guide

Open the contributing guide

Research direction

Start with the proposed .pre-commit-hooks.yaml file and the `atmos docs generate readme` command shown in the issue. Determine the hook entries needed for documentation generation, component and stack validation, and linting, then verify they run through pre-commit without filenames. Done means the supported hooks are usable from a pre-commit configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.