Feature/#1688 workflows

[thompson-tomo]

Fixes #

Changes

This PR is intended to serve as a goal post for workflows with the pr intended to be submitted to semconv in bite sized pieces Starting off with the highest level Workflow & working way down.

Important

Pull requests acceptance are subject to the triage process as described in Issue and PR Triage Management.
PRs that do not follow the guidance above, may be automatically rejected and closed.

Merge requirement checklist

• CONTRIBUTING.md guidelines followed.
• Change log entry added, according to the guidelines in When to add a changelog entry.
  • If your PR does not need a change log, start the PR title with [chore]
• Links to the prototypes or existing instrumentations (when adding or changing conventions)

[kamphaus]

A consumer of SemConv for CI/CD might not know to look in workflow for CI/CD conventions.

What can we do to make this clearer?

Can we improve the docs/cicd/README.md or docs/cicd/cicd-spans and link to the workflows page?

[thompson-tomo]

I agree a key thing would be to ensure that the docs are easily discoverable to a user.

What I am thinking is we focus on having mapping documents ie a github doc within the cicd section which brings in the appropriate definitions regardless of the definition namespace that way a reader can simply browse based on the topic and not need. This would also mean that the generic spans doc would also include the spans from Workflow namespace.

[kamphaus]

How do these spans relate to the cicd-spans?

Would these replace the existing cicd-spans (ie deprecate them) or complement them?

[thompson-tomo]

So the intention would be the spans replace the cicd spans.

If my understanding of cicd spans/concept is correct and how they would map to a system such as github.

• the cicd pipeline run would be the Workflow task execution span
• the cicd pipeline task run would need a new span Workflow step run and the corresponding attributes.

[kamphaus]

Previous PR that was auto-closed due to missing SIG:

• Initial implementation of workflows #1688 open-telemetry/semantic-conventions#2387

[github-actions]

This PR has been labeled as stale due to lack of activity. It will be automatically closed if there is no further activity over the next 14 days.