Skip to content

Commit b97fc45

Browse files
authored
ci: prepare flint next-release lint setup (#2782)
1 parent 27ac47b commit b97fc45

42 files changed

Lines changed: 727 additions & 530 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/config/.rumdl.toml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# See https://rumdl.dev/
2+
# and https://rumdl.dev/rules/
3+
[MD004]
4+
enabled = true
5+
style = "asterisk"
6+
7+
[MD013]
8+
enabled = true
9+
line-length = 120
10+
code-blocks = false
11+
tables = false
12+
13+
[MD060]
14+
enabled = true
15+
style = "aligned"

.github/config/lychee.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ include_fragments = "full"
1212
exclude = [
1313
# excluding links to pull requests and issues is done for performance
1414
"^https://github.com/open-telemetry/opentelemetry-java-contrib/(issues|pull)/\\d+$",
15+
# developer.ibm.com intermittently returns 500 for MQ downloads
16+
"^https://developer\\.ibm\\.com/articles/mq-downloads/$",
1517
# groovy-lang.org is frequently unreachable / times out
1618
"^https?://[^/]*groovy-lang\\.org",
1719
]

.github/copilot-instructions.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,26 +8,26 @@ This repository provides observability instrumentation for Java applications.
88

99
**PRIORITY**: Verify that all code changes follow the [Style Guide](../docs/style-guide.md). Check:
1010

11-
- Code formatting (auto-formatting, static imports, class organization)
12-
- Java language conventions (`final` usage, `@Nullable` annotations, `Optional` usage)
13-
- Performance constraints (hot path allocations)
14-
- Implementation patterns (SPI registration, configuration conventions)
15-
- Gradle conventions (Kotlin DSL, plugin usage, module naming)
16-
- Documentation standards (README files, deprecation processes)
11+
* Code formatting (auto-formatting, static imports, class organization)
12+
* Java language conventions (`final` usage, `@Nullable` annotations, `Optional` usage)
13+
* Performance constraints (hot path allocations)
14+
* Implementation patterns (SPI registration, configuration conventions)
15+
* Gradle conventions (Kotlin DSL, plugin usage, module naming)
16+
* Documentation standards (README files, deprecation processes)
1717

1818
### Critical Areas
1919

20-
- **Public APIs**: Changes affect downstream users and require careful review
21-
- **Performance**: Instrumentation must have minimal overhead
22-
- **Thread Safety**: Ensure safe concurrent access patterns
23-
- **Memory Management**: Prevent leaks and excessive allocations
20+
* **Public APIs**: Changes affect downstream users and require careful review
21+
* **Performance**: Instrumentation must have minimal overhead
22+
* **Thread Safety**: Ensure safe concurrent access patterns
23+
* **Memory Management**: Prevent leaks and excessive allocations
2424

2525
### Quality Standards
2626

27-
- Proper error handling with appropriate logging levels
28-
- OpenTelemetry specification and semantic convention compliance
29-
- Resource cleanup and lifecycle management
30-
- Comprehensive unit tests for new functionality
27+
* Proper error handling with appropriate logging levels
28+
* OpenTelemetry specification and semantic convention compliance
29+
* Resource cleanup and lifecycle management
30+
* Comprehensive unit tests for new functionality
3131

3232
### Test suites
3333

@@ -63,4 +63,4 @@ When implementing changes or new features:
6363
1. Follow all [Style Guide](../docs/style-guide.md) conventions and the Code Review Priorities above
6464
2. Run tests to ensure they still pass (use `./gradlew test` and `./gradlew integrationTest` as needed)
6565
3. **Always run `./gradlew spotlessApply`** after making code changes to ensure proper formatting
66-
4. Run markdown lint to ensure it still passes: `mise run lint:markdown`
66+
4. Run linting to ensure it still passes: `mise run lint`

.github/renovate.json5

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
$schema: 'https://docs.renovatebot.com/renovate-schema.json',
33
extends: [
4+
"github>grafana/flint#v0.21.0",
45
'config:best-practices',
56
'helpers:pinGitHubActionDigestsToSemver',
67
'customManagers:githubActionsVersions',

.github/repository-settings.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,32 +8,32 @@ private admin repo.
88

99
[The admin repo doesn't currently support tracking merge queue settings.]
1010

11-
- Require merge queue: CHECKED
12-
- Build concurrency: 5
13-
- Maximum pull requests to build: 5
14-
- Minimum pull requests to merge: 1, or after 5 minutes
15-
- Maximum pull requests to merge: 5
16-
- Only merge non-failing pull requests: CHECKED
17-
- Status check timeout: 60 minutes
11+
* Require merge queue: CHECKED
12+
* Build concurrency: 5
13+
* Maximum pull requests to build: 5
14+
* Minimum pull requests to merge: 1, or after 5 minutes
15+
* Maximum pull requests to merge: 5
16+
* Only merge non-failing pull requests: CHECKED
17+
* Status check timeout: 60 minutes
1818

1919
## Secrets and variables > Actions
2020

2121
### Repository secrets
2222

23-
- `GPG_PASSWORD` - stored in OpenTelemetry-Java 1Password
24-
- `GPG_PRIVATE_KEY` - stored in OpenTelemetry-Java 1Password
25-
- `SONATYPE_GUIDE_PAT` - owned by [@trask](https://github.com/trask)
26-
- `SONATYPE_KEY` - owned by [@trask](https://github.com/trask)
27-
- `SONATYPE_USER` - owned by [@trask](https://github.com/trask)
23+
* `GPG_PASSWORD` - stored in OpenTelemetry-Java 1Password
24+
* `GPG_PRIVATE_KEY` - stored in OpenTelemetry-Java 1Password
25+
* `SONATYPE_GUIDE_PAT` - owned by [@trask](https://github.com/trask)
26+
* `SONATYPE_KEY` - owned by [@trask](https://github.com/trask)
27+
* `SONATYPE_USER` - owned by [@trask](https://github.com/trask)
2828

2929
### Organization secrets
3030

31-
- `CODECOV_TOKEN`
32-
- `DEVELOCITY_ACCESS_KEY` (scoped only to Java repos)
33-
- `FOSSA_API_KEY`
34-
- `OTELBOT_PRIVATE_KEY`
31+
* `CODECOV_TOKEN`
32+
* `DEVELOCITY_ACCESS_KEY` (scoped only to Java repos)
33+
* `FOSSA_API_KEY`
34+
* `OTELBOT_PRIVATE_KEY`
3535

3636
### Organization variables
3737

38-
- `OSSF_SCORECARD_APP_ID`
39-
- `OTELBOT_APP_ID`
38+
* `OSSF_SCORECARD_APP_ID`
39+
* `OTELBOT_APP_ID`

.markdownlint.yaml

Lines changed: 0 additions & 13 deletions
This file was deleted.

.mise/tasks/lint/markdown.sh

Lines changed: 0 additions & 11 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -33,20 +33,20 @@ To run the tests:
3333

3434
## Markdown linting
3535

36-
This repository uses [markdownlint](https://github.com/DavidAnson/markdownlint) via `markdownlint-cli2` managed by [mise](https://github.com/jdx/mise).
36+
This repository uses [rumdl](https://rumdl.dev/) via [Flint](https://github.com/grafana/flint), managed by [mise](https://github.com/jdx/mise).
3737

38-
To check all Markdown files:
38+
To check Markdown and links:
3939

4040
```bash
41-
mise run lint:markdown
41+
mise run lint
4242
```
4343

4444
(note: Windows users may need to run `mise install` first)
4545

46-
To automatically fix fixable issues:
46+
To automatically fix fixable Markdown issues:
4747

4848
```bash
49-
mise run lint:markdown --fix
49+
mise run lint:fix
5050
```
5151

5252
## Snapshot Builds
@@ -63,15 +63,15 @@ See [Style Guide](docs/style-guide.md).
6363

6464
When submitting a pull request, please ensure that you:
6565

66-
- Clearly describe the change and its motivation
67-
- Mention any breaking changes
68-
- Include tests for new functionality
69-
- Follow the [Style Guide](docs/style-guide.md)
66+
* Clearly describe the change and its motivation
67+
* Mention any breaking changes
68+
* Include tests for new functionality
69+
* Follow the [Style Guide](docs/style-guide.md)
7070

7171
## Getting Help
7272

7373
If you need assistance or have questions:
7474

75-
- Post on the [#otel-java](https://cloud-native.slack.com/archives/C014L2KCTE3) Slack channel
76-
- [Open an issue](https://github.com/open-telemetry/opentelemetry-java-contrib/issues/new/choose) in
75+
* Post on the [#otel-java](https://cloud-native.slack.com/archives/C014L2KCTE3) Slack channel
76+
* [Open an issue](https://github.com/open-telemetry/opentelemetry-java-contrib/issues/new/choose) in
7777
this repository

README.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@
88

99
This project is intended to provide helpful libraries and standalone OpenTelemetry-based utilities that don't fit
1010
the express scope of the [OpenTelemetry Java](https://github.com/open-telemetry/opentelemetry-java) or
11-
[Java Instrumentation](https://github.com/open-telemetry/opentelemetry-java-instrumentation) projects. If you need an
11+
[Java Instrumentation](https://github.com/open-telemetry/opentelemetry-java-instrumentation) projects. If you need an
1212
easier way to bring observability to remote JVM-based applications and workflows that isn't easily satisfied by an SDK
1313
feature or via instrumentation, this project is hopefully for you.
1414

1515
## Provided Libraries
1616

1717
| Status* | Library |
18-
|---------|-------------------------------------------------------------------|
18+
| ------- | ----------------------------------------------------------------- |
1919
| beta | [AWS Resources](./aws-resources/README.md) |
2020
| stable | [AWS X-Ray SDK Support](./aws-xray/README.md) |
2121
| alpha | [AWS X-Ray Propagator](./aws-xray-propagator/README.md) |
@@ -47,39 +47,38 @@ feature or via instrumentation, this project is hopefully for you.
4747
To reach stable status, the library needs to have stable APIs, stable semantic conventions, and be production ready.
4848
On reaching stable status, the `otel.stable` value in `gradle.properties` should be set to `true`.
4949
Note that currently all the libraries are released together with the version of this repo, so breaking changes (after stable
50-
status is reached) would bump the major version of all libraries together. This could get complicated so `stable` has a high bar.
50+
status is reached) would bump the major version of all libraries together.
51+
This could get complicated, so `stable` has a high bar.
5152

5253
## Contributing
5354

5455
See [CONTRIBUTING.md](CONTRIBUTING.md).
5556

5657
### Maintainers
5758

58-
- [Jack Berg](https://github.com/jack-berg), Grafana Labs
59-
- [Jason Plumb](https://github.com/breedx-splk), Splunk
60-
- [Jay DeLuca](https://github.com/jaydeluca), Grafana Labs
61-
- [Lauri Tulmin](https://github.com/laurit), Splunk
62-
- [Trask Stalnaker](https://github.com/trask), Microsoft
59+
* [Jack Berg](https://github.com/jack-berg), Grafana Labs
60+
* [Jason Plumb](https://github.com/breedx-splk), Splunk
61+
* [Jay DeLuca](https://github.com/jaydeluca), Grafana Labs
62+
* [Lauri Tulmin](https://github.com/laurit), Splunk
63+
* [Trask Stalnaker](https://github.com/trask), Microsoft
6364

6465
For more information about the maintainer role, see the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#maintainer).
6566

6667
### Approvers
6768

68-
- [Gregor Zeitlinger](https://github.com/zeitlinger), Grafana Labs
69-
- [John Watson](https://github.com/jkwatson), Sublime Security
69+
* [Gregor Zeitlinger](https://github.com/zeitlinger), Grafana Labs
70+
* [John Watson](https://github.com/jkwatson), Sublime Security
7071

7172
For more information about the approver role, see the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#approver).
7273

7374
### Emeritus maintainers
7475

75-
- [Mateusz Rzeszutek](https://github.com/mateuszrzeszutek)
76-
- [Nikita Salnikov-Tarnovski](https://github.com/iNikem)
77-
- [Ryan Fitzpatrick](https://github.com/rmfitzpatrick)
76+
* [Mateusz Rzeszutek](https://github.com/mateuszrzeszutek)
77+
* [Nikita Salnikov-Tarnovski](https://github.com/iNikem)
78+
* [Ryan Fitzpatrick](https://github.com/rmfitzpatrick)
7879

7980
For more information about the emeritus role, see the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#emeritus-maintainerapprovertriager).
8081

81-
### Thanks to all of our contributors!
82+
### Thanks to all of our contributors
8283

83-
<a href="https://github.com/open-telemetry/opentelemetry-java-contrib/graphs/contributors">
84-
<img alt="Repo contributors" src="https://contrib.rocks/image?repo=open-telemetry/opentelemetry-java-contrib" />
85-
</a>
84+
[![Repo contributors](https://contrib.rocks/image?repo=open-telemetry/opentelemetry-java-contrib)](https://github.com/open-telemetry/opentelemetry-java-contrib/graphs/contributors)

aws-resources/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This module contains AWS resource detectors including Beanstalk, EC2, ECS, EKS,
44

55
## Component owners
66

7-
- [Lei Wang](https://github.com/wangzlei), AWS
8-
- [Prashant Srivastava](https://github.com/srprash), AWS
7+
* [Lei Wang](https://github.com/wangzlei), AWS
8+
* [Prashant Srivastava](https://github.com/srprash), AWS
99

1010
Learn more about component owners in [component_owners.yml](../.github/component_owners.yml).

0 commit comments

Comments
 (0)