Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (40 loc) · 5.03 KB

CONTRIBUTING.md

File metadata and controls

55 lines (40 loc) · 5.03 KB

Development flow tips

To slightly help with the "repolepsy" and make working with multiple repos and elements together easier, you may consider using bower link.

  • keep the clone of some client package repo in a separate folder, for example /path/to/imported-template,
  • develop it there in isolation, use polyserve, livereaload, wct, etc,
  • call bower link in imported-template folder, so Bower could link to your working folder from whenever you want. Now you can share the same version of the element across other dependent packages and apps.
    • call bower link imported-template from path/to/starcounter-include when you work with other package that needs it,
    • call it from /path/to/StarcounterClientFiles/src/StarcounterClientFiles when you are running SCF as an app,
    • call it from C:\Program Files\Starcounter\ClientFiles when you want to test it directly on any Starcounter solution you're running It creates just symlinks, so you will see the changes in git status of all joined repos, so you can easily revert and checkout needed versions.

Testing your PR in TeamCity

For your feature branch to be honoured by TeamCity, its name needs to start with 3.x (eg: 3.x/fix-something).

Usage of StarcounterClientFiles 3.x in Level1 build automation

Whatever is pushed on branch 3.x, will be bundled in the Starcounter installer by the Level1 build automation. See the announcement for more details.

The name of the StarcounterClientFiles branch used by the Level1 build is configured via the GIT_CLIENTFILES_BRANCH parameter in TeamCity.

Releasing of a new version of StarcounterClientFiles 3.x

The developer process of releasing of a new version of StarcounterClientFiles 3.x to Starcounter:

  1. Make sure you have npm, bower(npm install -g bower) and nuget cli installed,

  2. Commit changes to individual client-side package's repo, like https://github.com/Starcounter/starcounter-include, and release a version there,

  3. Bump files in a feature branch of StarcounterClientFiles started from 3.x, either:

    • by updating bower.json and running bower install,
    • or by calling bower install --save packagename[#version]

  4. Update bower-list.txt by calling bower list > bower-list.txt

  5. Build the project using build.bat or VS. This triggers msbuild, which also triggers npm run build

  6. When you push to a feature branch of StarcounterClientFiles, TeamCity will run a integration test of this branch with KitchenSink and Blending. Make sure these tests are passing.

  7. Make a PR for someone to review the complete set of changes.

  8. After PR approval, still in PR branch publish a package of this version to App Warehouse (built with Starcounter 2.4). Follow the steps to do this here. But make sure to have cake dotnet CLI tool installed before this step: dotnet tool install -g Cake.Tool

    • this will create a nuget package of StarcounterClientFiles called Starcounter.ClientFiles to folder %STAR_NUGET%/Starcounter.ClientFiles.X.Y.Z.nupkg or /StarcounterClientFiles/artifacts/Starcounter.ClientFiles.X.Y.Z.nupkg

  9. Execute push_nuget_package.bat

    • Requires full path to nupkg file + NuGet api key:
    push_nuget_package.bat C:\StarcounterClientFiles\artifacts\Starcounter.ClientFiles.X.Y.Z.nupkg XXXXXXXXXXXXXXXXXXXXXX

    Note that the newly added functionality is executed through Cake scripts, which makes it possible to execute through Bifrost as well. This means that this new workflow adds the nuget.exe dependency. Please add the directory where your nuget.exe file is located to %PATH% environment variable.

  10. Merge the PR to StarcounterClientFiles branch 3.x.

    • at this point, a new daily build of Starcounter 2.4 is started
    • it will be detected and included in the next nightly build of Starcounter 2.4

  11. Check the next section and decide if you need to follow the instructions in it.

Bumping level1 to use the new version

Starcounter Level1 pulls this app as a Nuget package as a source for Client Files. But level1 is locked to a certain version of this app. This configuration in level can be found in this file. If you release a version and want it to be pulled by level1, you must bump this line. Please make sure to bump level1 only after you release SCF to avoid broken level1 builds.

You may also use wildcards (eg 3.*), in which case the SCF package will be pulled immediately after it's released (assuming it matches the wildcard) and it will be bundled within the next release of Starcounter. Kindly release with care.