Skip to content

Ensure Lint CI catch documentation difference error #5367

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 8 commits into from
Jun 29, 2023
Merged

Ensure Lint CI catch documentation difference error #5367

merged 8 commits into from
Jun 29, 2023

Conversation

jcwchen
Copy link
Member

@jcwchen jcwchen commented Jun 26, 2023 •
edited
Loading

Description

Ensure Lint CI catch documentation diff (Operators.md) error: specify ONNX_ML=0 and ONNX_ML=1 to update Operators.md and Operators-ml.md

Motivation and Context

#5344 we removed doc diff in required Azp CI and now only Lint CI has doc diff check. However, documentation diff in Lint CI seems not working. This PR is trying to ensure doc diff errors will be caught.

@jcwchen
ensure installing develop onnx
9efc498 
Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com>
@jcwchen jcwchen added module: CI pipelines Issues related to the CI pipeline topic: code style Issues related to coding style or the linter labels Jun 26, 2023
@jcwchen jcwchen requested a review from a team as a code owner June 26, 2023 16:24
@jcwchen jcwchen marked this pull request as draft June 26, 2023 16:24
jcwchen added 6 commits June 26, 2023 09:27
@jcwchen
try making diff
c374c8f 
Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com>
@jcwchen
move section
dc87acc 
Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com>
@jcwchen
remove namespace
f88f7ea 
Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com>
@jcwchen
try text
340d42e 
Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com>
@jcwchen
ONNX_ML=0
d083fc8 
Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com>
@jcwchen
revert testing doc diff
d19d8cd 
Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com>
@jcwchen jcwchen changed the title [WIP] Ensure Lint CI catch documentation difference error Ensure Lint CI catch documentation difference error Jun 26, 2023
@jcwchen jcwchen marked this pull request as ready for review June 26, 2023 21:28
@jcwchen
Copy link
Member Author

jcwchen commented Jun 26, 2023 •
edited
Loading

cc @justinchuby Lint CI uses ONNX_ML=1 so it does not generate document (e.g., Operators.md) under ONNX domain. Specify ONNX_ML=0 and ONNX_ML=1 to ensure both documents will be updated.

Another thought: I think it's better for us to pick up this PR again: #3467. Ideally python onnx/defs/gen_doc.py should update all documents in one shot and I don't see any benefit to decouple them...

@jcwchen jcwchen mentioned this pull request Jun 26, 2023
Merged
@justinchuby
Copy link
Member

Thank you! I think the suggestion makes total sense

@jcwchen jcwchen enabled auto-merge (squash) June 28, 2023 22:46
@jcwchen jcwchen merged commit e131980 into onnx:main Jun 29, 2023
@jcwchen jcwchen deleted the jcw/diff-markdown branch June 29, 2023 00:09
@jcwchen jcwchen mentioned this pull request Jun 29, 2023
Closed
xadupre pushed a commit to xadupre/onnx that referenced this pull request Jul 4, 2023
@jcwchen @xadupre
Ensure Lint CI catch documentation difference error (onnx#5367)
b988e15 
### Description
<!-- - Describe your changes. -->
Ensure Lint CI catch documentation diff (Operators.md) error: specify
ONNX_ML=0 and ONNX_ML=1 to update Operators.md and Operators-ml.md

### Motivation and Context
<!-- - Why is this change required? What problem does it solve? -->
<!-- - If it fixes an open issue, please link to the issue here. -->
onnx#5344 we removed doc diff in required
Azp CI and now only Lint CI has doc diff check. However, documentation
diff in Lint CI seems not working. This PR is trying to ensure doc diff
errors will be caught.

---------

Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com>
Signed-off-by: Xavier Dupre <xadupre@microsoft.com>
xadupre pushed a commit to xadupre/onnx that referenced this pull request Jul 4, 2023
@jcwchen @xadupre
Ensure Lint CI catch documentation difference error (onnx#5367)
a706371 
### Description
<!-- - Describe your changes. -->
Ensure Lint CI catch documentation diff (Operators.md) error: specify
ONNX_ML=0 and ONNX_ML=1 to update Operators.md and Operators-ml.md

### Motivation and Context
<!-- - Why is this change required? What problem does it solve? -->
<!-- - If it fixes an open issue, please link to the issue here. -->
onnx#5344 we removed doc diff in required
Azp CI and now only Lint CI has doc diff check. However, documentation
diff in Lint CI seems not working. This PR is trying to ensure doc diff
errors will be caught.

---------

Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com>
Signed-off-by: Xavier Dupre <xadupre@microsoft.com>
adityagoel4512 pushed a commit to adityagoel4512/onnx that referenced this pull request Jul 15, 2023
@jcwchen @adityagoel4512
Ensure Lint CI catch documentation difference error (onnx#5367)
a7b953f 
### Description
<!-- - Describe your changes. -->
Ensure Lint CI catch documentation diff (Operators.md) error: specify
ONNX_ML=0 and ONNX_ML=1 to update Operators.md and Operators-ml.md

### Motivation and Context
<!-- - Why is this change required? What problem does it solve? -->
<!-- - If it fixes an open issue, please link to the issue here. -->
onnx#5344 we removed doc diff in required
Azp CI and now only Lint CI has doc diff check. However, documentation
diff in Lint CI seems not working. This PR is trying to ensure doc diff
errors will be caught.

---------

Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com>
Signed-off-by: Aditya Goel <agoel4512@gmail.com>
adityagoel4512 pushed a commit to adityagoel4512/onnx that referenced this pull request Jul 28, 2023
@jcwchen @adityagoel4512
Ensure Lint CI catch documentation difference error (onnx#5367)
c3bc5ab 
### Description
<!-- - Describe your changes. -->
Ensure Lint CI catch documentation diff (Operators.md) error: specify
ONNX_ML=0 and ONNX_ML=1 to update Operators.md and Operators-ml.md

### Motivation and Context
<!-- - Why is this change required? What problem does it solve? -->
<!-- - If it fixes an open issue, please link to the issue here. -->
onnx#5344 we removed doc diff in required
Azp CI and now only Lint CI has doc diff check. However, documentation
diff in Lint CI seems not working. This PR is trying to ensure doc diff
errors will be caught.

---------

Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com>
Signed-off-by: Aditya Goel <agoel4512@gmail.com>
adityagoel4512 pushed a commit to adityagoel4512/onnx that referenced this pull request Jul 28, 2023
@jcwchen @adityagoel4512
Ensure Lint CI catch documentation difference error (onnx#5367)
2cb6094 
<!-- - Describe your changes. -->
Ensure Lint CI catch documentation diff (Operators.md) error: specify
ONNX_ML=0 and ONNX_ML=1 to update Operators.md and Operators-ml.md

<!-- - Why is this change required? What problem does it solve? -->
<!-- - If it fixes an open issue, please link to the issue here. -->
onnx#5344 we removed doc diff in required
Azp CI and now only Lint CI has doc diff check. However, documentation
diff in Lint CI seems not working. This PR is trying to ensure doc diff
errors will be caught.

---------

Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com>
Signed-off-by: Aditya Goel <agoel4512@gmail.com>
adityagoel4512 pushed a commit to adityagoel4512/onnx that referenced this pull request Jul 28, 2023
@jcwchen @adityagoel4512
Ensure Lint CI catch documentation difference error (onnx#5367)
c045327 
### Description
<!-- - Describe your changes. -->
Ensure Lint CI catch documentation diff (Operators.md) error: specify
ONNX_ML=0 and ONNX_ML=1 to update Operators.md and Operators-ml.md

### Motivation and Context
<!-- - Why is this change required? What problem does it solve? -->
<!-- - If it fixes an open issue, please link to the issue here. -->
onnx#5344 we removed doc diff in required
Azp CI and now only Lint CI has doc diff check. However, documentation
diff in Lint CI seems not working. This PR is trying to ensure doc diff
errors will be caught.

---------

Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com>
Signed-off-by: Aditya Goel <agoel4512@gmail.com>
adityagoel4512 pushed a commit to adityagoel4512/onnx that referenced this pull request Jul 28, 2023
@jcwchen @adityagoel4512
Ensure Lint CI catch documentation difference error (onnx#5367)
7888528 
<!-- - Describe your changes. -->
Ensure Lint CI catch documentation diff (Operators.md) error: specify
ONNX_ML=0 and ONNX_ML=1 to update Operators.md and Operators-ml.md

<!-- - Why is this change required? What problem does it solve? -->
<!-- - If it fixes an open issue, please link to the issue here. -->
onnx#5344 we removed doc diff in required
Azp CI and now only Lint CI has doc diff check. However, documentation
diff in Lint CI seems not working. This PR is trying to ensure doc diff
errors will be caught.

---------

Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com>
Signed-off-by: Aditya Goel <agoel4512@gmail.com>
adityagoel4512 pushed a commit to adityagoel4512/onnx that referenced this pull request Jul 28, 2023
@jcwchen @adityagoel4512
Ensure Lint CI catch documentation difference error (onnx#5367)
019a2ec 
### Description
<!-- - Describe your changes. -->
Ensure Lint CI catch documentation diff (Operators.md) error: specify
ONNX_ML=0 and ONNX_ML=1 to update Operators.md and Operators-ml.md

### Motivation and Context
<!-- - Why is this change required? What problem does it solve? -->
<!-- - If it fixes an open issue, please link to the issue here. -->
onnx#5344 we removed doc diff in required
Azp CI and now only Lint CI has doc diff check. However, documentation
diff in Lint CI seems not working. This PR is trying to ensure doc diff
errors will be caught.

---------

Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com>
Signed-off-by: Aditya Goel <agoel4512@gmail.com>
adityagoel4512 pushed a commit to adityagoel4512/onnx that referenced this pull request Jul 28, 2023
@jcwchen @adityagoel4512
Ensure Lint CI catch documentation difference error (onnx#5367)
882232e 
<!-- - Describe your changes. -->
Ensure Lint CI catch documentation diff (Operators.md) error: specify
ONNX_ML=0 and ONNX_ML=1 to update Operators.md and Operators-ml.md

<!-- - Why is this change required? What problem does it solve? -->
<!-- - If it fixes an open issue, please link to the issue here. -->
onnx#5344 we removed doc diff in required
Azp CI and now only Lint CI has doc diff check. However, documentation
diff in Lint CI seems not working. This PR is trying to ensure doc diff
errors will be caught.

---------

Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com>
Signed-off-by: Aditya Goel <agoel4512@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@liqunfu liqunfu liqunfu approved these changes

Assignees
No one assigned
Labels
module: CI pipelines Issues related to the CI pipeline topic: code style Issues related to coding style or the linter
Projects
PR Tracker
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jcwchen @justinchuby @liqunfu