Skip to content

Commit

Permalink
docs(detector-github): add useful links (#600)
Browse files Browse the repository at this point in the history
Keeps aligned with other packages in the repo.

Co-authored-by: Valentin Marchaud <contact@vmarchaud.fr>
  • Loading branch information
legendecas and vmarchaud authored Aug 7, 2021
1 parent b489222 commit 66295ea
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion detectors/node/opentelemetry-resource-detector-github/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# OpenTelemetry Resource Detector for GitHub Actions

[![NPM Published Version][npm-img]][npm-url]
[![dependencies][dependencies-image]][dependencies-url]
[![devDependencies][devDependencies-image]][devDependencies-url]
[![Apache License][license-image]][license-image]

Resource detector for GitHub Actions.

Detects `GITHUB_*` environment variables [specified here](https://docs.github.com/en/free-pro-team@latest/actions/reference/environment-variables) and adds as attributes on a resource.
Expand Down Expand Up @@ -30,4 +35,21 @@ run()

## Useful links

* [GitHub Action Enviornment Variables](https://docs.github.com/en/free-pro-team@latest/actions/reference/environment-variables)
- [GitHub Action Enviornment Variables](https://docs.github.com/en/free-pro-team@latest/actions/reference/environment-variables)
- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
- For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
- For help or feedback on this project, join us in [GitHub Discussions][discussions-url]

## License

Apache 2.0 - See [LICENSE][license-url] for more information.

[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions
[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE
[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
[dependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=detectors%2Fnode%2Fopentelemetry-resource-detector-github
[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=detectors%2Fnode%2Fopentelemetry-resource-detector-github
[devDependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=detectors%2Fnode%2Fopentelemetry-resource-detector-github&type=dev
[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=detectors%2Fnode%2Fopentelemetry-resource-detector-github&type=dev
[npm-url]: https://www.npmjs.com/package/@opentelemetry/resource-detector-github
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fresource-detector-github.svg

0 comments on commit 66295ea

Please sign in to comment.