nunit / docs

Documentation for all active NUnit projects
https://docs.nunit.org
MIT License
602 stars 149 forks source link

Document TypeArgs for TestCase + TestCaseSource #903

Closed stevenaw closed 4 months ago

stevenaw commented 4 months ago

Fixes https://github.com/nunit/docs/issues/902

Build currently fails as it needs to update the version of NUnit to build the snippet

SeanKilleen commented 4 months ago

@stevenaw sorry about the build issues. I don't think it's you; I think it's a permissions issue with how it's being run. It seems to be inconsistent but realizing there might be an access token that I misunderstood. Will investigate but let me know when this is ready and I'll check it out and merge it.

stevenaw commented 4 months ago

Not a problem, thanks for the update @SeanKilleen ! A few of these linting and spelling issues were certainly me.

The Test Snippets build failure also seems to be related to trying to add an example for a new TypeArgs property on a very recently merged framework PR of mine.

SeanKilleen commented 4 months ago

@stevenaw I manually set the NUnit release version to pull into the docs. If it's in a later NUnit release, I may need to tweak that. I have a backlog item to make the build always pull the latest non-beta according to semver.

OsirisTerje commented 4 months ago

We now push all PRs to master as a package on myget. Is it possible to use that one?

stevenaw commented 4 months ago

Thanks @SeanKilleen I think I see your efforts here in the github action output 🙂

In this case these are changes not-yet-released in a stable version - or I think an alpha version from MyGet. If my math is right, I believe my changes merged in a few hours after the latest alpha publish time.

@OsirisTerje Are there any visibility toggles I'd need to adjust on my end to be able to locally pull the dev packages from myget? I'm having a hard time seeing it on https://www.myget.org/feed/nunit/package/nuget/Nunit or when I try and add https://www.myget.org/F/nunit/api/v2 as a local package source and targeting pre-release packages

OsirisTerje commented 4 months ago

Hmm, don't you see the package at all, or just in the feed ?

> dotnet add package NUnit --version 4.1.0-alpha.0.3 --source https://www.myget.org/F/nunit/api/v3/index.json

image

Noticed you referred to v2, whereas I had v3, could that be it ?

stevenaw commented 4 months ago

Oh! I think I see my source of confusion now. @OsirisTerje The changes from your branch were published as 4.1.0-alpha.0.3, but post-merge they published as 4.0.0-alpha.51 - causing it to appear much further down in the list. I simply hadn't scrolled down far enough.

We may need to change it to publish under 4.1.0-alpha instead of 4.0.0-alpha on master, but that's outside of what we need to worry about in this docs PR.

I've updated the snippets solution on my branch and repushed

stevenaw commented 4 months ago

Ok, snippets are now building! I think the remaining issue is related to having pushed to a branch on a fork