Skip to content
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.

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

[chore] Enbled make fix can fix table format #1699

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

gyliu513
Copy link
Member

Fixes #1692

Changes

Please provide a brief description of the changes here.

Note: if the PR is touching an area that is not listed in the existing areas, or the area does not have sufficient domain experts coverage, the PR might be tagged as experts needed and move slowly until experts are identified.

Merge requirement checklist

@gyliu513 gyliu513 requested review from a team as code owners December 18, 2024 19:56
@@ -13,16 +13,16 @@

The Android platform on which the Android application is running.

| Attribute | Type | Description | Examples | Stability |
|---|---|---|---|---|
| Attribute | Type | Description | Examples | Stability |
Copy link
Contributor

Choose a reason for hiding this comment

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

these files are auto-generated, we should not modify them (and I think whitespaces in jinja are too complicated to format them in this way)

Copy link
Member Author

Choose a reason for hiding this comment

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

@lmolkova make fix-format will update the tables

Copy link
Contributor

@lmolkova lmolkova left a comment

Choose a reason for hiding this comment

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

I believe we don't use format checks in the workflows/CI and can probably remove this check from the makefile.

Wonder what @open-telemetry/specs-semconv-maintainers think

@gyliu513
Copy link
Member Author

I believe we don't use format checks in the workflows/CI and can probably remove this check from the makefile.

Yes, we can discuss if we need make fix-format or not, I have added fix-format to CI process in this PR.

@lmolkova
Copy link
Contributor

lmolkova commented Dec 18, 2024

Yes, we can discuss if we need make fix-format or not, I have added fix-format to CI process in this PR.

as you can see it breaks other checks (registry validation). Personally, I don't see a benefit in format check in MD + yaml repo with MD and yaml lint checks.

@gyliu513
Copy link
Member Author

Thanks @lmolkova , with that, shall we remove both check-format and fix-format from makefile? It is really annoying when running make check.

@lmolkova
Copy link
Contributor

Thanks @lmolkova , with that, shall we remove both check-format and fix-format from makefile? It is really annoying when running make check.

I don't use make check since it takes forever, so I wonder if other @open-telemetry/specs-semconv-maintainers have any thoughts.

@trask
Copy link
Member

trask commented Dec 19, 2024

I don't use make check since it takes forever, so I wonder if other @open-telemetry/specs-semconv-maintainers have any thoughts.

fwiw, the only thing I ever use is make table-generation attribute-registry-generation

@gyliu513
Copy link
Member Author

Hi @lmolkova and @trask , I removed check-format and fix-format in Makefile, hope this is ok, thanks!

@joaopgrassi
Copy link
Member

I think we discussed in some other PR/Issue that it would be good to start enforcing the line limit in markdown, but that's probably a bigger endeavor. For ex we would have to avoid modifying any part of the auto-generated content (tables etc).

For now removing it sounds good to me. I also don't use it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

make check-format failed
4 participants