Skip to content

docs: add example project and remove redundant release-please PR comment#14

Merged
zeitlinger merged 3 commits into
mainfrom
docs/example-project
Feb 16, 2026
Merged

docs: add example project and remove redundant release-please PR comment#14
zeitlinger merged 3 commits into
mainfrom
docs/example-project

Conversation

@zeitlinger
Copy link
Copy Markdown
Member

@zeitlinger zeitlinger commented Feb 16, 2026

Summary

  • Adds an "Example" section to the README pointing to grafana/docker-otel-lgtm as a real-world project using flint
  • Links to its CONTRIBUTING.md (developer workflow) and mise.toml (task wiring)
  • Removes the "Remind to reopen PR for CI" step from the release-please workflow, since this is already documented in the README

Related

A companion PR in docker-otel-lgtm simplifies its CONTRIBUTING.md to reference flint instead of duplicating linting/Renovate documentation: grafana/docker-otel-lgtm#1054

Test plan

  • Verify links in the new section resolve correctly

Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a short “Example” section to the README to point users to a real-world repository adopting flint, making it easier for new adopters to see an end-to-end setup.

Changes:

  • Add an “Example” section linking to grafana/docker-otel-lgtm
  • Include direct links to that repo’s CONTRIBUTING.md and mise.toml for workflow/task wiring reference

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
The README already documents that release-please PRs need to be
reopened for CI.
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
@zeitlinger zeitlinger changed the title docs: add docker-otel-lgtm as example project docs: add example project and remove redundant release-please PR comment Feb 16, 2026
Copy link
Copy Markdown
Member Author

@zeitlinger zeitlinger left a comment

Choose a reason for hiding this comment

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

Dismissing Copilot's suggestion — blob/main links render nicely on GitHub (syntax highlighting, line numbers), while raw.githubusercontent.com shows plain text. These links are also excluded from lychee checks.

Add repository guard, pin to ubuntu-24.04, add explicit token,
and add YAML document start marker for consistency.
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
@zeitlinger zeitlinger merged commit 3335de5 into main Feb 16, 2026
7 checks passed
@zeitlinger zeitlinger deleted the docs/example-project branch February 16, 2026 16:25
zeitlinger added a commit to grafana/docker-otel-lgtm that referenced this pull request Feb 16, 2026
## Summary

- Replaces the detailed "Linting" and "Renovate Dependency Tracking"
sections with a concise reference to
[flint](https://github.com/grafana/flint), which now documents all of
this
- Keeps the essential `mise run fix` / `mise run lint` commands for
quick reference
- Removes unused `[renovate]` link reference

## Related

- grafana/flint#14 — companion PR that adds
docker-otel-lgtm as an example project in flint's README

## Test plan

- [ ] Verify the flint link resolves correctly
- [ ] Confirm no other docs reference the removed "Renovate Dependency
Tracking" section heading

---------

Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
This was referenced Apr 16, 2026
@github-actions github-actions Bot mentioned this pull request May 8, 2026
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.

2 participants