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

Build docs #10

Merged
merged 5 commits into from
Jul 29, 2023
Merged

Build docs #10

merged 5 commits into from
Jul 29, 2023

Conversation

tznind
Copy link
Contributor

@tznind tznind commented Jul 29, 2023

Hi @En3Tho, this is my personal account. I've been getting ready to tackle #9 but first I needed to work out how to build/test the module.

These are the instructions I created. Let me know if there is a far easier way to do that and I can update them.

@En3Tho
Copy link
Owner

En3Tho commented Jul 29, 2023

@tznind Nice! Seems like a great end to end tutorial. I will take a closer look a little bit later but for now I can say that the easiest way just to test the logic/UI is to use PoshRedisViewerHost project as it's just a console app.

I guess the doc can include 2 sections: one with easy way (host) and the other the hard way (module).

Usually module project is needed only for publish or when the command itself changes. Any other time host project is okay.

You can even use dotnet watch with it. It will always recompile but it's quite fast at doing so.

@tznind
Copy link
Contributor Author

tznind commented Jul 29, 2023

Ah I hadn't realized. It wasn't set as my startup project in visual studio so struggled a little.

Thanks.

I have updated this PR docs to indicate the two ways of testing.

Copy link
Owner

@En3Tho En3Tho left a comment

Choose a reason for hiding this comment

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

Just a small suggestion. Otherwise everything is perfect. Thanks!

README.md Outdated
```
3. Start a new powershell instance (prevents stale modules sitting around etc)
```
pwsh
Copy link
Owner

Choose a reason for hiding this comment

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

I think calling pwsh –noprofile here is good to be sure no modules are loaded by default

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Cool, thats a handy flag to know about. I've added it to build instructions

@@ -0,0 +1 @@
build/
Copy link
Owner

Choose a reason for hiding this comment

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

I personally lean to .artifacts. Just to be more consistent with dotnet/core#8135 (comment)

But this is just gitignore and if you're accustomized to "build" then it's okay

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have changed from -o build to -o .artifacts and updated subsequent steps and git ignore file.

@En3Tho En3Tho merged commit 682f2dd into En3Tho:main Jul 29, 2023
@En3Tho
Copy link
Owner

En3Tho commented Jul 29, 2023

Thanks!

@tznind tznind deleted the build-docs branch July 29, 2023 18:56
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.

2 participants