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

Improve the onboarding / project setup process #922

AlexKasaku opened this issue Jul 25, 2017 · 2 comments


None yet
1 participant
Copy link

commented Jul 25, 2017

Setting up the project on a new machine or for a new contributor is a little fiddly due to a couple of gotchas. It would be great to review this process to make it as smooth as possible.

Goals would be:

  • Move machine-specific configuration into as few files as possible, ideally one. e.g. Source folder location
  • Review + remove any old setup files that may no longer be needed. e.g. Setup_Modules.ps1
  • Use .gitignore appropriately so that machine-specific changed files don't get picked up as changed files in git.
  • Review contributor guidelines in gitbook to check they are up to date

Areas that touch on this that should be looked at:

  • MSBuild project post-build copy steps.
  • Setup_Modules.ps1 + Setup_Folders.ps1
  • Deploy.targets
  • Unicorn serialization config

A nice to have whilst looking at this would be additional developer-specific configuration so that we can overwrite default SPE settings as part of development (e.g. disable password for elevation) without effecting the default configuration for the package.

@AlexKasaku AlexKasaku self-assigned this Jul 25, 2017

AlexKasaku added a commit that referenced this issue Aug 6, 2017


This comment has been minimized.

Copy link
Contributor Author

commented Aug 6, 2017

Contributor guide now updated to reflect the new methods of building.

Changes, in summary:

  • Brains of the deployment are now mostly stored within a PowerShell script, Post_Build.ps1
  • There is now a single deploy.user.json file to edit after cloning the repo, where you just need to specify the sites you want to deploy to.
  • Each site states a path, a version (7 or 8) and whether to use junction points
  • Once setup, each time you build the projects, they will be deployed to the relevant sites.
  • There is a new folder for user specific configuration files. This allows for *.config files you want deployed to the sites as part of your SPE setup, but won't get committed into source.

There should no longer be any user-specific configuration in the .csproj files.


This comment has been minimized.

Copy link
Contributor Author

commented Aug 6, 2017

  • Setup_Folders.ps1 has been removed as it is no longer needed
  • Setup_Module.ps1 has been changed to only setup the SPE Remoting module. This is still a one-time execution after you clone the project.

@AlexKasaku AlexKasaku modified the milestones: Documentation, 5.0 Aug 6, 2017

@AlexKasaku AlexKasaku closed this Aug 6, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.