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

Fix update target in metricbeat magefile.go to include collectDocs target #18062

Merged

Conversation

blakerouse
Copy link
Contributor

@blakerouse blakerouse commented Apr 28, 2020

What does this PR do?

Fixes the mage update target in metricbeat to also call mage collectDocs.

Why is it important?

So the docs/ are generate for metricbeat.

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation~~
  • [ ] I have made corresponding change to the default configuration files
  • [ ] I have added tests that prove my fix is effective or that my feature works
  • [ ] I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Author's Checklist

  • Calling mage update updates the documentation.

How to test this PR locally

$ mage update

or

$ make update

@blakerouse blakerouse added the Team:Platforms Label for the Integrations - Platforms team label Apr 28, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/integrations-platforms (Team:Platforms)

@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Apr 28, 2020
@blakerouse blakerouse removed the needs_team Indicates that the issue/PR needs a Team:* label label Apr 28, 2020
Copy link
Contributor

@kaiyan-sheng kaiyan-sheng left a comment

Choose a reason for hiding this comment

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

Thank you for fixing this!!

@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

Pipeline View Test View Changes Artifacts preview stats

Expand to view the summary

Build stats

Test stats 🧪

Test Results
Failed 0
Passed 2634
Skipped 733
Total 3367

@dedemorton
Copy link
Contributor

I think there are still problems (unless we removed support for make docs and no one told me). :-)

1 - make docs doesn't work.
2 - When I run make update, it doesn't update fields.asciidoc with changes made to the fields.yml.

Here's git status after running make update from beats/metricbeat. Notice that fields.yml changed, but the fields.asciidoc is not updated as it should be:

Rhodas-MBP:metricbeat⎇ metricbeat-collect-docs-on-update⇡$ git status
On branch metricbeat-collect-docs-on-update
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git checkout -- <file>..." to discard changes in working directory)

	modified:   module/aerospike/_meta/fields.yml
	modified:   module/aerospike/fields.go

@dedemorton
Copy link
Contributor

I checked Filebeat and confirmed that make docs and make docs-preview do work for that beat, so it must be a metricbeat issue.

@dedemorton
Copy link
Contributor

Seems like this commit broke the doc scripts for metricbeat: 8786d05#diff-34acb1c4bf062801dbb1a2e9554fcfaf

@blakerouse
Copy link
Contributor Author

@dedemorton Nice catch, I have updated the magefile to do the correct thing for the asciidocs on fields. I also added the make doc and make doc-preview shims, so those will work now in the metricbeat directory.

@blakerouse blakerouse merged commit 7d16a0f into elastic:master Apr 28, 2020
@blakerouse blakerouse deleted the metricbeat-collect-docs-on-update branch April 28, 2020 21:58
blakerouse added a commit to blakerouse/beats that referenced this pull request Apr 28, 2020
…rget (elastic#18062)

* Fix update target in metricbeat magefile.go to include collectDocs target.

* Add make doc to makefile shim, use collectall instead of collectdocs in update target.

(cherry picked from commit 7d16a0f)
blakerouse added a commit that referenced this pull request Apr 29, 2020
…rget (#18062) (#18072)

* Fix update target in metricbeat magefile.go to include collectDocs target.

* Add make doc to makefile shim, use collectall instead of collectdocs in update target.

(cherry picked from commit 7d16a0f)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Team:Platforms Label for the Integrations - Platforms team v7.8.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants