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

Improve documentation #21

Closed

1 of 2 tasks

kvrhdn opened this issue Dec 15, 2020 · 0 comments

Assignees

Contributor

kvrhdn commented Dec 15, 2020 •

edited

The README is getting a bit long and the action is aggregating quite a bit of logic that is worth documenting.

We could split up the documentation in information about:

using the action: the syntax, the available inputs and outputs
its behavior: the trace ID, how to uses buildevents internally, how to add your own fields, how to connect spans
development: how to contribute, how to build, release procedure

To consider:

I believe the README is shown in the sidebar when editing GitHub Actions workflows

TODO

Document how to override BUILDEVENT_FILE and add your own arbitrary fields (we might be able to refer to the buildevents docs?) Provide a mechanism to add arbitrary fields to the Honeycomb event #3 (comment), Allow users to add/override fields #18
Document meta.source field Enable detection of gha-buildevents created spans #19

The text was updated successfully, but these errors were encountered:

kvrhdn self-assigned this

kvrhdn changed the title ~~Better structure the documentation~~ Improve documentation

kvrhdn mentioned this issue

Create buildevents.txt at the start of the run #22

Closed

kvrhdn closed this as completed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment