Skip to content

Add DependencyPackageProjects step to workflow #671

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

Merged
MichaelSimons merged 1 commit into from
May 16, 2023
Merged

Add DependencyPackageProjects step to workflow #671

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ When generating a package(s), the tooling will detect and generate all dependent
```

After generating new reference packages, all new projects must be referenced as a
[DependencyPackageProjects](https://github.com/dotnet/source-build-reference-packages/blob/main/eng/Build.props#L10).
[DependencyPackageProjects](https://github.com/dotnet/source-build-reference-packages/blob/main/eng/Build.props#L9).

@mthalman mthalman May 16, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Use a permalink instead? That alleviates the need to maintain it. Also applies to 2nd usage below.

@MichaelSimons MichaelSimons May 16, 2023

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

The downside to a permalink is that a different type of maintenance issue is caused when the documentation this link points to is updated. We want this link to point to the most recent documentation.

These must be defined in dependency order. There is a [tracking issue](https://github.com/dotnet/source-build/issues/1690)
to address this manual step.

Expand All @@ -58,9 +58,12 @@ when it was originally generated.

* Generate reference package and its depencencies running the `./generate.sh --package <package>,<version>` script.
* Revert changes for packages that were already existed in the repository.
* Add `DependencyPackageProjects` for all new projects in the [eng/Build.props](https://github.com/dotnet/source-build-reference-packages/blob/main/eng/Build.props#L9)
in the correct dependency order.
* Run build with the `./build.sh -sb` command.
* If the compilation produces numerous compilation issue - run the `./build.sh --projects <path to .csproj file>` command for each
generated reference package separately. It may be necessary to manually tweak the code to address compilation issues. When this occurs, please ensure there is an [tracking issue](#filing-issues) to address the underlying problem with the generator.
generated reference package separately. It may be necessary to manually tweak the code to address compilation issues. When this occurs,
please ensure there is an [tracking issue](#filing-issues) to address the underlying problem with the generator.

You can search for known issues in the [Known Generator Issues Markdown file](docs/known_generator_issues.md).

Expand Down