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.

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

Add CI testing for metadata.yaml for all components. #23376

Closed
3 tasks done
Tracked by #23335
mackjmr opened this issue Jun 14, 2023 · 3 comments
Closed
3 tasks done
Tracked by #23335

Add CI testing for metadata.yaml for all components. #23376

mackjmr opened this issue Jun 14, 2023 · 3 comments
Assignees
@mackjmr
Labels
cmd/mdatagen mdatagen command Stale

Comments

@mackjmr
Copy link
Member

mackjmr commented Jun 14, 2023 •
edited
Loading

Component(s)

cmd/mdatagen

Describe the issue you're reporting

The proposal is that for all components, the CI test will check:

  • The presence of the metadata.yaml file. (PR)
  • That all required fields as defined here are present and the value is correct (e.g. one of receiver|processor|exporter|connector|extension for class). (PR)
  • That the generated files after running the mdatagen tool match the generated files in the repo. (Already done here)
@mackjmr mackjmr added the needs triage New item requiring triage label Jun 14, 2023
@github-actions github-actions bot added the cmd/mdatagen mdatagen command label Jun 14, 2023
@github-actions
Copy link
Contributor

Pinging code owners:

See Adding Labels via Comments if you do not have permissions to add labels yourself.

@mackjmr mackjmr mentioned this issue Jun 14, 2023
Closed
2 tasks
@songy23 songy23 removed the needs triage New item requiring triage label Jun 14, 2023
This was referenced Jun 16, 2023
Closed
Closed
mackjmr added a commit to mackjmr/opentelemetry-collector-contrib that referenced this issue Jul 27, 2023
@mackjmr
[chore] Add test to ensure metadata.yaml is present for all components
0552822 
This PR uses the checkfile tool introduced in open-telemetry/opentelemetry-go-build-tools#348 in order to validate the presence of the metadata.yaml file in all components. It also removes the checkdoc tool in favor of the checkfile tool, which is now also used to validate the presence of README.md.
Issue: open-telemetry#23376
@mackjmr mackjmr mentioned this issue Jul 27, 2023
Merged
dmitryax pushed a commit that referenced this issue Jul 27, 2023
@mackjmr
[chore] Add test to ensure metadata.yaml is present for all components (
bd5439c 
#24643)

**Description:**
This PR uses the checkfile tool introduced in
open-telemetry/opentelemetry-go-build-tools#348
in order to validate the presence of the metadata.yaml file in all
components. It also removes the checkdoc tool in favor of the checkfile
tool, which is now also used to validate the presence of README.md.

**Link to tracking Issue:**
#23376
@github-actions
Copy link
Contributor

This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping @open-telemetry/collector-contrib-triagers. If this issue is still relevant, please ping the code owners or leave a comment explaining why it is still relevant. Otherwise, please close it.

Pinging code owners:

See Adding Labels via Comments if you do not have permissions to add labels yourself.

@github-actions github-actions bot added the Stale label Aug 14, 2023
@mackjmr
Copy link
Member Author

mackjmr commented Aug 14, 2023

Three tasks are complete, closing issue.

@mackjmr mackjmr closed this as completed Aug 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mackjmr mackjmr

Labels
cmd/mdatagen mdatagen command Stale
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@songy23 @mackjmr