Check list for creating new Arcade package #374

JohnTortugo · 2018-07-26T01:07:49Z

Closes: #370

maririos · 2018-07-26T23:55:32Z

It might be worth to add that a way to pack the package is by using dotnet pack like what @alexperovich is promoting in #380

Documentation/HowToCreatePackages.md

@@ -0,0 +1,39 @@
+# How to Create an Arcade Package
+
+One of the goals of Arcade is to be a vehicle to provide code sharing. One of the ways that this goal is implemented by through NuGet packages. This document assumes that you are adding a package called `ProjectOne` to Arcade and provides a list of things you should check when while doing that.


Documentation/HowToCreatePackages.md

@@ -0,0 +1,39 @@
+# How to Create an Arcade Package
+
+One of the goals of Arcade is to be a vehicle to provide code sharing. One of the ways that this goal is implemented by through NuGet packages. This document assumes that you are adding a package called `ProjectOne` to Arcade and provides a list of things you should check when while doing that.


Documentation/HowToCreatePackages.md

+
+  `src/Microsoft.DotNet.ProjectOne/tests`
+
+- It would be great if you could include a `README.md` file on the root of the package.


Documentation/HowToCreatePackages.md

+
+- Include the package on the `Arcade.sln` file. This way it will be compiled automatically when the solution is built.
+
+- Make sure that library dependencies of the new package use the Arcade defined version of the library. The versions are defined in the `eng\Version.props` file. For instance, if the project has a dependence on Newtonsoft.Json you must add it as follows:


JohnTortugo · 2018-07-28T00:45:31Z

@maririos pushed new changes addressing your comments. Thanks.

I believe the packages are created automatically during the building process. Do you want me to include a comment about how to manually create the package on the command line?

Documentation/HowToCreatePackages.md

+## Further References
+
+- https://github.com/dotnet/arcade/blob/master/Documentation/Overview.md#toolset-nuget-package-requirements


Check list for creating new Arcade package.

fae2256

JohnTortugo self-assigned this Jul 26, 2018

JohnTortugo requested review from tmat, markwilkie, weshaggard, maririos and alexperovich July 26, 2018 01:07

maririos reviewed Jul 27, 2018

View reviewed changes

Documentation/HowToCreatePackages.md Outdated

`src/Microsoft.DotNet.ProjectOne/tests`

- It would be great if you could include a `README.md` file on the root of the package.

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

maririos reviewed Jul 27, 2018

View reviewed changes

maririos mentioned this pull request Jul 27, 2018

Conventions for Arcade repo #376

Merged

Addressing PR feedback.

48e48eb

JohnTortugo mentioned this pull request Jul 30, 2018

[Feed package] Use default dependency versions in Feed package #14

Closed

maririos reviewed Aug 2, 2018

View reviewed changes

Documentation/HowToCreatePackages.md Outdated

## Further References

- https://github.com/dotnet/arcade/blob/master/Documentation/Overview.md#toolset-nuget-package-requirements

This comment was marked as spam.

Sign in to view

maririos approved these changes Aug 2, 2018

View reviewed changes

JohnTortugo added 3 commits August 2, 2018 10:57

Changes after PR feedback.

2a70fec

Fix typos after PR feedback.

e4f779d

fixing typos after pr feedback changes

74559f9

JohnTortugo merged commit 2861456 into dotnet:master Aug 2, 2018

JohnTortugo deleted the PackageHowTo branch August 2, 2018 18:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Check list for creating new Arcade package #374

Check list for creating new Arcade package #374

JohnTortugo commented Jul 26, 2018

maririos commented Jul 26, 2018

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

JohnTortugo commented Jul 28, 2018

This comment was marked as spam.

		@@ -0,0 +1,39 @@
		# How to Create an Arcade Package

		One of the goals of Arcade is to be a vehicle to provide code sharing. One of the ways that this goal is implemented by through NuGet packages. This document assumes that you are adding a package called `ProjectOne` to Arcade and provides a list of things you should check when while doing that.


		`src/Microsoft.DotNet.ProjectOne/tests`

		- It would be great if you could include a `README.md` file on the root of the package.


		- Include the package on the `Arcade.sln` file. This way it will be compiled automatically when the solution is built.

		- Make sure that library dependencies of the new package use the Arcade defined version of the library. The versions are defined in the `eng\Version.props` file. For instance, if the project has a dependence on Newtonsoft.Json you must add it as follows:

		## Further References

		- https://github.com/dotnet/arcade/blob/master/Documentation/Overview.md#toolset-nuget-package-requirements

Check list for creating new Arcade package #374

Check list for creating new Arcade package #374

Conversation

JohnTortugo commented Jul 26, 2018

maririos commented Jul 26, 2018

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

JohnTortugo commented Jul 28, 2018

This comment was marked as spam.