Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add goreadme to all-repos.yaml #965

Closed
wants to merge 1 commit into from

Conversation

alexandregv
Copy link

goreadme generates readme file from Go doc. I just made a PR to add pre-commit support to it.

Here is the sample .pre-commit-config.yaml I added as instructions in goreadme's README:

repos:
  - repo: https://github.com/posener/goreadme
    rev: v1.4.2 # Use the latest ref
    hooks:
      - id: goreadme
        entry: env README_FILE=README.md goreadme
        args: ['-badge-goreadme=true', '-badge-godoc=true']

I had to use entry: env README_FILE= because the tool doesn't have a flag for this and won't have it.

In the .pre-commit-hooks.yaml, I used pass_filenames: false because goreadme doesn't rely on staged filenames, it reads the repo for *.go files.

my new repository:

  • is added to the bottom or with existing repos from the same account
  • contains a license
  • is not language: system, language: script, language: docker, or language: docker_image
  • does not contain "pre-commit" in the name

@asottile
Copy link
Member

appreciate it, but pass_filenames: false is not optimal for the framework so I cannot include these hooks on this page

@asottile asottile closed this May 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants