Skip to content

Latest commit

 

History

History
54 lines (34 loc) · 2.09 KB

README.md

File metadata and controls

54 lines (34 loc) · 2.09 KB
Raw

🛠️ link-dependencies

Attempts to add links to the original changelogs for dependency bumps in changelog.yaml.

The link is computed automatically when the dependency name is a full route, like github.com/org/package, or it's got from a dictionary file when present.

Example Usage

Example with a dictionary:

- name: Link dependencies
  uses: newrelic/release-toolkit/link-dependencies@v1
  with:
    dictionary: .github/dictionary.yaml

Dictionary file:

dictionary:
  common-library: "https://github.com/newrelic/helm-charts/releases/tag/common-library-{{.To}}"
  golangci-lint: "https://github.com/golangci/golangci-lint/releases/tag/{{.To.Original}}"

Notice that the implementation for {{.To}} uses dep.To.ToString that removes the leading v if present. That is ideal since it allow us to write down a rule no matter if the version comes as vx.y.z or x.y.z.

Parameters

All parameters are optional and match the ones used for the cli command flag, you can see the values and the defaults in here)

Contributing

Standard policy and procedure across the New Relic GitHub organization.

Useful Links

Support

New Relic has open-sourced this project. This project is provided AS-IS WITHOUT WARRANTY OR DEDICATED SUPPORT. Issues and contributions should be reported to the project here on GitHub.

We encourage you to bring your experiences and questions to the Explorers Hub where our community members collaborate on solutions and new ideas.

License

release-toolkit is licensed under the Apache 2.0 License.

Disclaimer

This tool is provided by New Relic AS IS, without warranty of any kind. New Relic does not guarantee that the tool will: not cause any disruption to services or systems; provide results that are complete or 100% accurate; correct or cure any detected vulnerability; or provide specific remediation advice.