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.

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

Add documentation for PackageDependencies #510

Merged
merged 2 commits into from
Feb 7, 2025

Conversation

bchuo
Copy link
Contributor

@bchuo bchuo commented Jan 30, 2025

What this PR does / why we need it: Adds missing documentation for the PackageDependencies struct and updates relevant docs with links to it

Which issue(s) this PR fixes (optional, using fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when the PR gets merged):
Fixes #470

Special notes for your reviewer:

@bchuo bchuo requested a review from a team as a code owner January 30, 2025 20:30
@cpuguy83 cpuguy83 requested a review from adamperlin January 30, 2025 21:39
title: Dependencies
---

`PackageDependencies` is a list of dependencies for a package. This will be included in the package metadata so that the package manager can install the dependencies. It also includes build-time dependencies, which we'll install before running any build steps. They are overwritten if specified in the target map for the requested distro.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`PackageDependencies` is a list of dependencies for a package. This will be included in the package metadata so that the package manager can install the dependencies. It also includes build-time dependencies, which we'll install before running any build steps. They are overwritten if specified in the target map for the requested distro.
`PackageDependencies` specifies dependency information for a particular package. This includes dependencies for runtime, which will be installed along with the package by the package manager, as well as any dependencies needed to build and/or test the resulting package. Configuration for any additional package repositories which are required may also be added here.

website/docs/dependencies.md Outdated Show resolved Hide resolved
@bchuo bchuo merged commit 9a8651c into Azure:main Feb 7, 2025
5 checks passed
@bchuo bchuo deleted the update-docs-package-dependencies branch February 7, 2025 18:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[REQ] Docs are missing details on package dependency constraints
3 participants