feat: Cache NuGet global-packages folder by nogic1008 · Pull Request #303 · actions/setup-dotnet

nogic1008 · 2022-08-01T03:23:41Z

Description

This PR adds the feature to cache NuGet global-packages folder. (inspired by actions/setup-node)

Usage

env:
  NUGET_PACKAGES: ${{ github.workspace }}/.nuget/packages # optional, but recommended
steps:
  - uses: actions/checkout@v3
  - uses: actions/setup-dotnet@v2
    with:
      dotnet-version: '6.0.x'
      cache: true # default: false

This feature needs to NuGet lock file (**/packages.lock.json).

By default, global-packages folder path is %userprofile%\.nuget\packages (Windows) or ~/.nuget/packages (Mac/Linux).
Depending on host runners, this folder may already contain huge files. (like Xamarin)
Therefore, if there is no problem, we recommend that you specify the NUGET_PACKAGES environment variable to create your own cache folder.

See also: https://docs.microsoft.com/nuget/consume-packages/managing-the-global-packages-and-cache-folders

Tasks

Related issue

None

Check list

Mark if documentation changes are required.
Mark if tests were added or updated to cover the changes.

nogic1008 · 2022-10-18T04:58:14Z

To maintainer
Please review the license for these packages.

tslib: 0-BSD
sax: ISC + MIT

IvanZosimov · 2022-11-23T13:57:25Z

Hi. @nogic1008, thanks a lot for that huge PR! Could you clarify a little the list of caching directories? In the PR description, you wrote that you are going to cache the global-packages directory. But in the code, I see that you call dotnet nuget locals all --list --force-english-output which shows all 4 cache-related directories as stated here: https://learn.microsoft.com/en-us/nuget/consume-packages/managing-the-global-packages-and-cache-folders Do we want to cache all of them?

IvanZosimov · 2022-12-05T19:15:53Z

Hi, @nogic1008 just a gentle ping 📟

rohthegreat

I Approve.

README.md

panticmilos · 2023-03-20T16:10:10Z

hi @nogic1008, could you sync with the main branch?

panticmilos · 2023-03-28T09:08:41Z

hi @nogic1008, just a gentle ping :)

nogic1008 · 2023-03-29T23:44:19Z

Hi. @nogic1008, thanks a lot for that huge PR! Could you clarify a little the list of caching directories? In the PR description, you wrote that you are going to cache the global-packages directory. But in the code, I see that you call dotnet nuget locals all --list --force-english-output which shows all 4 cache-related directories as stated here: https://learn.microsoft.com/en-us/nuget/consume-packages/managing-the-global-packages-and-cache-folders Do we want to cache all of them?

@IvanZosimov
As you say, getNuGetFolderPath() returns 4 paths but this features only use global-cache path.
It is left for future enhancements. (ex. cache other folders)

IvanZosimov · 2023-04-25T08:18:48Z

Hi, @nogic1008 👋 Thank you for the update! Could you, please, sync your PR with the main branch? There are some new changes related to the e2e tests, check this PR to learn more.

nogic1008 · 2023-04-25T23:18:14Z

@IvanZosimov
I have rebased to the latest main branch, it's ready for review.
I don't want to rebase too many times because there are big diffs in this PR.

action.yml

README.md

src/cache-utils.ts

IvanZosimov · 2023-04-26T10:33:49Z

Hi, @nogic1008 👋 Thanks for the update, I left several comments, please take a look. Also, may I ask you to add e2e tests?

nogic1008 · 2023-04-27T02:39:11Z

@IvanZosimov
Thank you for your review. I have resolved some points.

add end-to-end tests for cache feature
- I added on previous commit, but I missed it when resolving conflict.
fix README
fix getNuGetFolderPath
- change Regex parttern to support .NET Core 2.1
fix isCacheFeatureAvailable
- call core.warning() instead of throw Error
- extern isGHES
change main script path to setup/
- To resolve it, we need to change unit test for installer.ts. It is difficult for me because it is not "unit" test but calls install script directly.
Support cache-dependency-path
- Please give me some time because I need to implement it anew.

IvanZosimov · 2023-04-27T07:25:15Z

Thanks for the update @nogic1008 ❤️! Regarding the unit tests for the installer.ts, I will help you. When you change the logic, I'll fix the tests by myself. Don't worry at all!

src/setup-dotnet.ts

IvanZosimov · 2023-05-24T13:06:06Z

Hi, @nogic1008 👋 Could you, please, resolve merge conflicts? As I see we got all necessary approvals, as soon as you resolve the conflicts we can make final tests and then we are ready to go 🚀

nogic1008 · 2023-05-24T23:49:23Z

@IvanZosimov
Resolved merge conflict. Ready to go.

IvanZosimov · 2023-05-26T13:41:20Z

Hi, @nogic1008 👋 During testing, I found a problem, my test project failed to restore dependencies using dotnet restore --locked-mode with error NU1403. As we suggest dotnet restore --locked-mode command to customers, I think it's important to give them a small note that in case of error NU1403 while restoring a project's dependencies, they can add this setting in the .csproj file and the problem will be solved. Could you share your opinion about this point? If you agree, could you add this info as a > **Note** to the README.md file ?

P.S. There are also some merge conficts, sorry for that. May I ask you to solve them one more time ? 😇

src/cache-restore.ts

Co-authored-by: Ivan <98037481+IvanZosimov@users.noreply.github.com>

also add guide on README

nogic1008 · 2023-05-28T23:48:54Z

@IvanZosimov
Resolved merge conflicts.
And add guide on README to resolve NU1403 error.
Please review this section.

IvanZosimov · 2023-05-29T10:45:47Z

Hi, @nogic1008 👋 The PR is merged 🚀 Thanks a lot for your willingness to make our action better! ❤️

* feat: cache NuGet global-packages folder * fix: remove unused files * docs: fix incorrect action * ci: add e2e test for cache * docs: accept suggested changes on README * docs: add simple cache example * build: change main script path * fix: change relative path to install scripts * fix: change relative path to problem matcher * refactor: accept changes on cache-utils * fix: revert main script path changes * test: fix cache-utils unit test * test: fix cache-utils unit test * feat: add `cache-dependency-path` variables * build: change main script dist path * ci: add `cache-dependency-path` e2e test & missing lock file * fix: accept change suggestions * ci: copy NuGet lock file to root to pass "test-setup-with-cache" e2e test * docs: change README guide * fix: apply suggestions from code review Co-authored-by: Ivan <98037481+IvanZosimov@users.noreply.github.com> * test: fix some failed unit tests - fix `restoreCache()` test for 9703c8 - update installer script * build: rebuild dist * Update unit-tests - Additional unit test were added to setup-dotnet.test.ts * Update unit tests for unix systems * Format and lint unit tests * fix: avoid use '/' on `path.join` * fix: rebuild dist * fix: apply suggestions from code review Co-authored-by: Ivan <98037481+IvanZosimov@users.noreply.github.com> * build: add `DisableImplicitNuGetFallbackFolder` option also add guide on README * docs: highlight warnings and notes * docs: update note about handling NU1403 --------- Co-authored-by: Ivan <98037481+IvanZosimov@users.noreply.github.com> Co-authored-by: IvanZosimov <ivanzosimov@github.com>

nogic1008 marked this pull request as ready for review October 18, 2022 04:33

IvanZosimov self-requested a review November 17, 2022 08:26

IvanZosimov self-assigned this Nov 17, 2022

rohthegreat approved these changes Jan 30, 2023

View reviewed changes

README.md Show resolved Hide resolved

nogic1008 requested a review from a team as a code owner March 29, 2023 15:13

nogic1008 added 3 commits April 25, 2023 11:05

feat: cache NuGet global-packages folder

af15115

fix: remove unused files

8752594

docs: fix incorrect action

4e3fa35

IvanZosimov reviewed Apr 26, 2023

View reviewed changes

nogic1008 added 10 commits April 27, 2023 08:13

ci: add e2e test for cache

71228fd

docs: accept suggested changes on README

b40f9e8

docs: add simple cache example

2683943

build: change main script path

3fcae62

fix: change relative path to install scripts

061d7af

fix: change relative path to problem matcher

cffdfc8

refactor: accept changes on cache-utils

d958ca3

fix: revert main script path changes

3025f77

test: fix cache-utils unit test

6985ab3

test: fix cache-utils unit test

15b6d31

dsame reviewed May 18, 2023

View reviewed changes

src/setup-dotnet.ts Outdated Show resolved Hide resolved

dsame approved these changes May 18, 2023

View reviewed changes

nikolai-laevskii approved these changes May 18, 2023

View reviewed changes

Robin777555 approved these changes May 20, 2023

View reviewed changes

MaksimZhukov approved these changes May 22, 2023

View reviewed changes

marko-zivic-93 approved these changes May 23, 2023

View reviewed changes

fix: avoid use '/' on path.join

39d3726

nogic1008 added 2 commits May 24, 2023 23:43

Merge remote-tracking branch 'origin/main' into feat/nuget-cache

72ff56e

fix: rebuild dist

173e371

dmitry-shibanov approved these changes May 25, 2023

View reviewed changes

IvanZosimov reviewed May 26, 2023

View reviewed changes

src/cache-restore.ts Outdated Show resolved Hide resolved

nogic1008 and others added 3 commits May 29, 2023 08:09

fix: apply suggestions from code review

4a7f04a

Co-authored-by: Ivan <98037481+IvanZosimov@users.noreply.github.com>

Merge remote-tracking branch 'origin/main' into feat/nuget-cache

0a1e793

build: add DisableImplicitNuGetFallbackFolder option

248bcfb

also add guide on README

docs: highlight warnings and notes

10e8639

MaksimZhukov approved these changes May 29, 2023

View reviewed changes

docs: update note about handling NU1403

78b8e27

IvanZosimov merged commit 3447fd6 into actions:main May 29, 2023

Conversation

nogic1008 commented Aug 1, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Usage

Tasks

Related issue

Check list

Uh oh!

nogic1008 commented Oct 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

IvanZosimov commented Nov 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

IvanZosimov commented Dec 5, 2022

Uh oh!

rohthegreat left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

panticmilos commented Mar 20, 2023

Uh oh!

panticmilos commented Mar 28, 2023

Uh oh!

nogic1008 commented Mar 29, 2023

Uh oh!

IvanZosimov commented Apr 25, 2023

Uh oh!

nogic1008 commented Apr 25, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

IvanZosimov commented Apr 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nogic1008 commented Apr 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

IvanZosimov commented Apr 27, 2023

Uh oh!

Uh oh!

IvanZosimov commented May 24, 2023

Uh oh!

nogic1008 commented May 24, 2023

Uh oh!

IvanZosimov commented May 26, 2023

Uh oh!

Uh oh!

nogic1008 commented May 28, 2023

Uh oh!

IvanZosimov commented May 29, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

nogic1008 commented Aug 1, 2022 •

edited

Loading

nogic1008 commented Oct 18, 2022 •

edited

Loading

IvanZosimov commented Nov 23, 2022 •

edited

Loading

IvanZosimov commented Apr 26, 2023 •

edited

Loading

nogic1008 commented Apr 27, 2023 •

edited

Loading