Skip to content

Commit 28ae718

Browse files
Update lychee (#4683)
fragment checking was fixed --------- Co-authored-by: Carlos Alberto Cortez <[email protected]>
1 parent 94c0ed4 commit 28ae718

30 files changed

+52
-39
lines changed

.lychee.toml

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,24 @@ include_fragments = true
22

33
accept = ["200..=299", "403"]
44

5+
remap = [
6+
# workaround for https://github.com/lycheeverse/lychee/issues/1729
7+
'https://github.com/(.*?)/(.*?)/blob/(.*?)/(.*#.*)$ https://raw.githubusercontent.com/$1/$2/$3/$4',
8+
'https://docs.oracle.com/(.*)#.*$ https://docs.oracle.com/$1'
9+
]
10+
511
exclude = [
6-
# excluding links to pull requests and issues is done for performance
7-
"^https://github.com/open-telemetry/opentelemetry-specification/(issues|pull)/\\d+$",
8-
# TODO (trask) look into this
9-
"^https://docs.google.com/document/d/1d0afxe3J6bQT-I6UbRXeIYNcTIyBQv4axfjKF4yvAPA/edit"
12+
# workaround for https://github.com/lycheeverse/lychee/issues/1729
13+
'^https://github.com/.*/(pull|issues|commit|compare)/.*#.*$',
14+
'.*decision-log.md#L0-L1',
15+
# excluding links to pull requests and issues is done for performance
16+
'^https://github.com/open-telemetry/opentelemetry-specification/(issues|pull)/\d+$',
17+
# TODO (trask) look into this
18+
'^https://docs.google.com/.*/edit.*$',
19+
'https://semver.org/#spec-item-11',
20+
'https://w3c.github.io/trace-context/#trace-id',
21+
'https://facebook.github.io/zstd/#small-data',
22+
'https://javadoc.io/doc/org.apache.logging.log4j/log4j-api/latest/org.apache.logging.log4j/org/apache/logging/log4j/Logger.html'
1023
]
1124

1225
# better to be safe and avoid failures

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ on each other), the owner should try to get people aligned by:
289289

290290
If none of the above worked and the PR has been stuck for more than 2 weeks, the
291291
owner should bring it to the [OpenTelemetry Specification SIG
292-
meeting](https://github.com/open-telemetry/community#cross-language-specification).
292+
meeting](https://github.com/open-telemetry/community/blob/main/README.md#specification-sigs).
293293

294294
[nvm]: https://github.com/nvm-sh/nvm/blob/master/README.md#installing-and-updating
295295

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ misspell-correction: $(MISSPELL)
2929
markdown-link-check:
3030
docker run --rm \
3131
--mount 'type=bind,source=$(PWD),target=/home/repo' \
32-
lycheeverse/lychee:sha-2aa22f8@sha256:2e3786630482c41f9f2dd081e06d7da1c36d66996e8cf6573409b8bc418d48c4 \
32+
lycheeverse/lychee:sha-8222559@sha256:6f49010cc46543af3b765f19d5319c0cdd4e8415d7596e1b401d5b4cec29c799 \
3333
--config home/repo/.lychee.toml \
3434
--root-dir /home/repo \
3535
-v \
@@ -39,7 +39,7 @@ markdown-link-check:
3939
# see https://github.com/open-telemetry/opentelemetry-specification/pull/4554
4040
docker run --rm \
4141
--mount 'type=bind,source=$(PWD),target=/home/repo' \
42-
lycheeverse/lychee:sha-2aa22f8@sha256:2e3786630482c41f9f2dd081e06d7da1c36d66996e8cf6573409b8bc418d48c4 \
42+
lycheeverse/lychee:sha-8222559@sha256:6f49010cc46543af3b765f19d5319c0cdd4e8415d7596e1b401d5b4cec29c799 \
4343
--config home/repo/.lychee.toml \
4444
--root-dir /home/repo \
4545
--max-redirects 0 \

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ APAC timezone friendly meetings are held on request. See
2929
[OpenTelemetry calendar](https://github.com/open-telemetry/community#calendar).
3030

3131
Escalations to technical committee may be made over the
32-
[e-mail](https://github.com/open-telemetry/community#tc-technical-committee).
32+
[e-mail](https://github.com/open-telemetry/community/blob/main/README.md#mailing-lists).
3333
Technical committee holds regular meetings, notes are held
3434
[here](https://docs.google.com/document/d/1hOHPCu5TGenqTeWPB9qQB_qd33uITZBcvK1FnWxYJAw/edit?usp=sharing).
3535

issue-management.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
- Reviewer:
1212
- Person whose Approval is needed to merge the PR.
1313
- Sponsor:
14-
- The [specification sponsors](https://github.com/open-telemetry/community/blob/main/community-membership.md#specification-sponsor), identified as the assignee of the issue, is responsible for the completion of the issue.
14+
- The [specification sponsors](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#specification-sponsor), identified as the assignee of the issue, is responsible for the completion of the issue.
1515
- Triager:
1616
- This person is responsible for applying appropriate labels as outlined below,
1717
following up on issues to ensure they are complete,

oteps/0001-telemetry-without-manual-instrumentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ There are some languages that will have OpenTelemetry support before they have D
8989

9090
### Governance of the auto-instrumentation libraries
9191

92-
Each `auto-instr-foo` repository must have at least one [Maintainer](https://github.com/open-telemetry/community/blob/main/community-membership.md#maintainer) in common with the main `opentelemetry-foo` language repository. There are no other requirements or constraints about the set of maintainers/approvers for the main language repository and the respective auto-instrumentation repository; in particular, there may be maintainers/approvers of the main language repository that are not maintainers/approvers for the auto-instrumentation repository, and vice versa.
92+
Each `auto-instr-foo` repository must have at least one [Maintainer](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#maintainer) in common with the main `opentelemetry-foo` language repository. There are no other requirements or constraints about the set of maintainers/approvers for the main language repository and the respective auto-instrumentation repository; in particular, there may be maintainers/approvers of the main language repository that are not maintainers/approvers for the auto-instrumentation repository, and vice versa.
9393

9494
### Mini-FAQ about this proposal
9595

oteps/0007-no-out-of-band-reporting.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,5 +57,5 @@ instance configured with it's own `Resource`.
5757
* [opentelemetry-specification/62](https://github.com/open-telemetry/opentelemetry-specification/issues/62)
5858
* [opentelemetry-specification/61](https://github.com/open-telemetry/opentelemetry-specification/issues/61)
5959

60-
[otelsvc-receiver]: https://github.com/open-telemetry/opentelemetry-collector#config-receivers
61-
[create-metric]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/api.md#create-metric
60+
[otelsvc-receiver]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/receiver/README.md
61+
[create-metric]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/api.md#get-a-meter

oteps/0035-opentelemetry-protocol.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ When an error is returned by the server it falls into 2 broad categories: retrya
9393

9494
- Not-retryable errors indicate that processing of telemetry data failed and the client MUST NOT retry sending the same telemetry data. The telemetry data MUST be dropped. This can happen, for example, when the request contains bad data and cannot be deserialized or otherwise processed by the server. The client SHOULD maintain a counter of such dropped data.
9595

96-
When using gRPC transport the server SHOULD indicate retryable errors using code [Unavailable](https://pkg.go.dev/google.golang.org/grpc/codes) and MAY supply additional [details via status](https://pkg.go.dev/google.golang.org/grpc/status#Status.WithDetails) using [RetryInfo](https://github.com/googleapis/googleapis/blob/6a8c7914d1b79bd832b5157a09a9332e8cbd16d4/google/rpc/error_details.proto#L40) containing 0 value of RetryDelay. Here is a sample Go code to illustrate:
96+
When using gRPC transport the server SHOULD indicate retryable errors using code [Unavailable](https://pkg.go.dev/google.golang.org/grpc/codes) and MAY supply additional [details via status](https://pkg.go.dev/google.golang.org/grpc/status#Status) using [RetryInfo](https://github.com/googleapis/googleapis/blob/6a8c7914d1b79bd832b5157a09a9332e8cbd16d4/google/rpc/error_details.proto#L40) containing 0 value of RetryDelay. Here is a sample Go code to illustrate:
9797

9898
```go
9999
// Do this on server side.
@@ -106,7 +106,7 @@ When using gRPC transport the server SHOULD indicate retryable errors using code
106106
return st.Err()
107107
```
108108

109-
To indicate not-retryable errors the server is recommended to use code [InvalidArgument](https://pkg.go.dev/google.golang.org/grpc/codes) and MAY supply additional [details via status](https://pkg.go.dev/google.golang.org/grpc/status#Status.WithDetails) using [BadRequest](https://github.com/googleapis/googleapis/blob/6a8c7914d1b79bd832b5157a09a9332e8cbd16d4/google/rpc/error_details.proto#L119). Other gRPC status code may be used if it is more appropriate. Here is a sample Go code to illustrate:
109+
To indicate not-retryable errors the server is recommended to use code [InvalidArgument](https://pkg.go.dev/google.golang.org/grpc/codes) and MAY supply additional [details via status](https://pkg.go.dev/google.golang.org/grpc/status#Status) using [BadRequest](https://github.com/googleapis/googleapis/blob/6a8c7914d1b79bd832b5157a09a9332e8cbd16d4/google/rpc/error_details.proto#L119). Other gRPC status code may be used if it is more appropriate. Here is a sample Go code to illustrate:
110110

111111
```go
112112
// Do this on server side.
@@ -148,7 +148,7 @@ OTLP allows backpressure signalling.
148148

149149
If the server is unable to keep up with the pace of data it receives from the client then it SHOULD signal that fact to the client. The client MUST then throttle itself to avoid overwhelming the server.
150150

151-
To signal backpressure when using gRPC transport, the server SHOULD return an error with code [Unavailable](https://pkg.go.dev/google.golang.org/grpc/codes) and MAY supply additional [details via status](https://pkg.go.dev/google.golang.org/grpc/status#Status.WithDetails) using [RetryInfo](https://github.com/googleapis/googleapis/blob/6a8c7914d1b79bd832b5157a09a9332e8cbd16d4/google/rpc/error_details.proto#L40). Here is a sample Go code to illustrate:
151+
To signal backpressure when using gRPC transport, the server SHOULD return an error with code [Unavailable](https://pkg.go.dev/google.golang.org/grpc/codes) and MAY supply additional [details via status](https://pkg.go.dev/google.golang.org/grpc/status#Status) using [RetryInfo](https://github.com/googleapis/googleapis/blob/6a8c7914d1b79bd832b5157a09a9332e8cbd16d4/google/rpc/error_details.proto#L40). Here is a sample Go code to illustrate:
152152

153153
```go
154154
// Do this on server side.
@@ -265,7 +265,7 @@ Both FlatBuffers and Capnproto are worth to be re-evaluated for future versions
265265

266266
It is also worth researching transports other than gRPC. Other transports are not included in this RFC due to time limitations.
267267

268-
Experimental implementation of OTLP over WebSockets exists and was researched as an alternate. WebSockets were not chosen as the primary transport for OTLP due to lack or immaturity of certain capabilities (such as [lack of universal support](https://github.com/gorilla/websocket#gorilla-websocket-compared-with-other-packages) for [RFC 7692](https://datatracker.ietf.org/doc/html/rfc7692) message compression extension). Despite limitations the experimental implementation demonstrated good performance and WebSocket transport will be considered for inclusion in a future OTLP Extensions RFC.
268+
Experimental implementation of OTLP over WebSockets exists and was researched as an alternate. WebSockets were not chosen as the primary transport for OTLP due to lack or immaturity of certain capabilities (such as [lack of universal support](https://github.com/gorilla/websocket/blob/v1.4.2/README.md#gorilla-websocket-compared-with-other-packages) for [RFC 7692](https://datatracker.ietf.org/doc/html/rfc7692) message compression extension). Despite limitations the experimental implementation demonstrated good performance and WebSocket transport will be considered for inclusion in a future OTLP Extensions RFC.
269269

270270
## Open Questions
271271

oteps/0155-external-modules.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ In fact, these repositories often calls for other set of skills and customer's u
5252
On contrib repository creation, new set of approvers and maintainers can be added as we do for any new repository, without time/contribution requirements.
5353
Repository maintainers are also encouraged to promote contributors to approver/maintainer role in this repository
5454
based on targeted contributions and expertise of the contrib repository rather than overall SIG scope.
55-
It is important to keep the process fair and inclusive by following the formal guidance published [here](https://github.com/open-telemetry/community/blob/main/community-membership.md#maintainer).
55+
It is important to keep the process fair and inclusive by following the formal guidance published [here](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#maintainer).
5656
A contrib repository may leverage the CODEOWNERS functionality of GitHub to assign maintainers to individual packages
5757
even if this means granting write permissions to the whole repo.
5858
The goal should be to distribute the load of reviewing PRs and accepting changes as much as possible, while keeping reliability and overall quality of components and fair governance.

oteps/0156-columnar-encoding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -804,7 +804,7 @@ dictionary and schema information. This remains an area for study.
804804
### Further-integrated compression techniques
805805

806806
ZSTD offers a training mode, which can be used to tune the algorithm for a selected type of data. The result of this
807-
training is a dictionary that can be used to compress the data. Using this [dictionary](http://facebook.github.io/zstd/#small-data)
807+
training is a dictionary that can be used to compress the data. Using this [dictionary](https://facebook.github.io/zstd/#small-data)
808808
can dramatically improve the compression rate for small batches. This future development will build on both the gRPC
809809
stream approach used in this proposal and the ability to send a ZSTD dictionary over the OTel Arrow stateful protocol,
810810
allowing us to train the ZSTD algorithm on the first batches and then update the configuration of the ZSTD

0 commit comments

Comments
 (0)