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

Update readme with a call out for status ending a trace in v2 #156

Merged
merged 6 commits into from
Oct 12, 2022
Merged

Update readme with a call out for status ending a trace in v2 #156

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
174260a
be clear that status will end the trace
mjayaram Oct 12, 2022
b789afa
adds a note
mjayaram Oct 12, 2022
508986b
add an explanation of NOT needing to start trace in every job
mjayaram Oct 12, 2022
12f3cef
little more editing
mjayaram Oct 12, 2022
92818a8
Update README.md
mjayaram Oct 12, 2022
8013abd
Update README.md
mjayaram Oct 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,10 @@ This GitHub Action instruments your workflows using [Honeycomb's buildevents too

### 📣 Adopting version 2.0.0

- The required input field `job-status` has been renamed to `status`. This was done because status now can be job's or the workflow's.
- The input field `job-status` has been renamed to `status`. This no longer required in every job. This was done because status now can be job's or the workflow's.
We still support job-status but will give a warning that it is deprecated and encourage the switch to the status field.

- `status` is no longer required in every job because including the `status` field ends a trace. For multi job workflows this is only required as part of the last job or the job that will end the trace.

- Each Job MUST include unique STEP IDs to ensure each job's spans are properly organized together.
- An example of adopting these changes is in the [Integration Worflow](.github/workflows/integration.yaml) of this repo. Here is the corresponding trace:
Expand Down Expand Up @@ -55,7 +56,6 @@ This GitHub Action instruments your workflows using [Honeycomb's buildevents too

In the **FIRST JOB**

Note: The step to start the workflow's trace should run first (before other jobs too)

```yaml
the-job-that-runs-first:
Expand Down Expand Up @@ -85,7 +85,14 @@ the-job-that-runs-first:
# ... Job 2 ...
```

Then add the **new** **LAST JOB**
**NOTE:**

The step to start the workflow's trace should run first (before other jobs too). You do not need to start the trace in subsequent jobs.

The output is important. This is the parent trace ID and will be used by the LAST job to connect all other traces.


Add the **new** **LAST JOB**

```yaml
end-trace:
Expand Down