Skip to content

docs: update README for lint-shared.yml and pre-commit linter - #83

Merged
ineedjet merged 9 commits into
mainfrom
docs/update-readme
Jul 2, 2026
Merged

docs: update README for lint-shared.yml and pre-commit linter#83
ineedjet merged 9 commits into
mainfrom
docs/update-readme

Conversation

@ineedjet

@ineedjet ineedjet commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Replace outdated Quick Setup (manual actions + runtime installs) with lint-shared.yml one-liner
  • Update composite actions table: add Key column mapping linter keys to actions, add pre-commit / check-precommit-sync row
  • Document coverage + sync checks
  • Fix SSH URLs → HTTPS (git@github.comhttps://github.com)
  • Make pre-commit example minimal — ruff and erb-lint commented out with stack hints

ineedjet and others added 4 commits July 2, 2026 22:22
- Replace manual action steps in Quick Setup with lint-shared.yml call
- Update composite actions table: add Key column, pre-commit row, herb note
- Document check-precommit-sync (coverage + sync checks)
- Fix SSH URLs to HTTPS (git@github.com → https://github.com)
- Make pre-commit example minimal — comment out ruff/erb-lint

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Gem is published on RubyGems — git source workaround no longer needed.
Update version example from 0.5.0 to VERSION placeholder.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: ec91c3974d

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md Outdated
Comment thread README.md Outdated
ineedjet and others added 3 commits July 2, 2026 22:41
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 6baea8d4fb

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
- uses: rubykatzen/baseline/.github/actions/lint-actionlint@VERSION
- uses: rubykatzen/baseline/.github/actions/lint-rubocop@VERSION
- uses: rubykatzen/baseline/.github/actions/lint-erb-lint@VERSION
uses: rubykatzen/baseline/.github/workflows/lint-shared.yml@VERSION

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Keep reusable workflow pins aligned with VERSION

🤖 [rubykatzen/baseline]: This new setup tells consumers to pin only lint-shared.yml@VERSION, but the called workflow currently hard-codes each nested baseline action to @v0.7 in .github/workflows/lint-shared.yml lines 16-35. When a repo follows this example with any newer release tag or a Dependabot bump, the run still downloads the older action wrappers/configs, so the documented VERSION pin does not actually select the release users requested.

Useful? React with 👍 / 👎.

Comment thread README.md Outdated
ineedjet and others added 2 commits July 2, 2026 22:49
- README + .pre-commit-config.yaml.example: include all linters so
  consumers start with everything and prune what they don't need
- .pre-commit-config.yaml.example: fix stale rev v0.0.6 → VERSION
- AGENTS.md: full revision — remove deleted workflow, update setup-runtimes
  description, add check-precommit-sync action, fix lint-shared export note,
  expand Adding a New Linter steps

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 3e73d45761

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
```yaml
repos:
- repo: https://github.com/rubykatzen/baseline
rev: v0.7.3

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Keep the pre-commit example versioned by release

🤖 [rubykatzen/baseline]: This hard-codes the copied pre-commit config to v0.7.3 even though the section above tells consumers to replace VERSION with the current release; checked .github/actions/bump-pre-commit-rev/action.yml, and the release automation only edits .pre-commit-config.yaml, not this README snippet. On the next release, new repos following Quick setup will start with stale hook definitions until Dependabot happens to open a follow-up PR, so keep this as VERSION or update it in the release workflow.

Useful? React with 👍 / 👎.

Comment thread README.md
@ineedjet
ineedjet merged commit b6e5e8a into main Jul 2, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant