Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
A
auto-tx
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
vamp
auto-tx
Commits
09e28152
Commit
09e28152
authored
5 years ago
by
Niko Ehrenfeuchter
Browse files
Options
Downloads
Patches
Plain Diff
Document build-deploy-update cycle through helper scripts
Fixes
#65
parent
3c816a18
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
CONTRIBUTING.md
+75
-0
75 additions, 0 deletions
CONTRIBUTING.md
with
75 additions
and
0 deletions
CONTRIBUTING.md
+
75
−
0
View file @
09e28152
...
...
@@ -67,6 +67,81 @@ Refactoring suggestions and / or pull requests are welcome!
reference that issue in the commit message (issue tracking is done in the
[
primary repository in the Uni Basel GitLab
][
web_autotx_gitlab
]
).
## The Full Cycle: Change / Compile / Package / Update / Test
To run a typical development cycle, a few helper scripts are provided, most
notably to facilitate / automate that cycle whilst using the common
functionalities coming with AutoTx (like the updater).
### Building / Compiling
Open a shell session using the
`Developer Command Prompt for VS 2017`
shortcut
(doesn't require any special permissions, i.e. can be your user that's also
running Visual Studio). For convenience reasons it is recommended to start
`PowerShell`
within this terminal, but this is not strictly required. Navigate
to the
`AutoTx`
source code base directory, then call any of the
`.cmd`
scripts
under
`Scripts/msbuild`
depending on your needs. For a
*Debug*
build this would
be something like this:
```
PowerShell
cd C:\Devel\AutoTx ## <- adjust path to your requirements
.\Scripts\msbuild\build\debug.cmd
```
### Creating an Installation / Updater Package
After building the service has completed, use the
`Deploy-NewBuild.ps1`
script,
optionally with specifying the path to the updater configuration (by default
the script will assume "
`C:\Tools\AutoTx-Updater\UpdaterConfig.inc.ps1`
" for
this).
```
PowerShell
.\Scripts\Deploy-NewBuild.ps1
# or by specifying the config explicitly:
.\Scripts\Deploy-NewBuild.ps1 -UpdaterSettings C:\Path\To\UpdaterConfig.inc.ps1
```
Running this should produce output similar to the one shown here:
```
Creating package [build_2019-04-23_14-14-42__3.0-70-gf90a55c] using binaries from:
[C:\Devel\AutoTx\ATxService\bin\Debug]
[C:\Devel\AutoTx\ATxTray\bin\Debug]
[C:\Devel\AutoTx\ATxConfigTest\bin\Debug]
[C:\Devel\AutoTx\ATxDiagnostics\bin\Debug]
Removing existing package dir [build_2019-04-23_14-14-42__3.0-70-gf90a55c]...
Done creating package [build_2019-04-23_14-14-42__3.0-70-gf90a55c]
[configuration: Debug]
[commit: 3.0-70-gf90a55c]
Location: [C:\Devel\AutoTx\Scripts\build_2019-04-23_14-14-42__3.0-70-gf90a55c]
```
### Triggering the Updater
Running the updater can be done in various ways, for example you could simply
call the script manually from a PowerShell session with sufficient privileges.
However, the recommended method is to actually trigger the scheduled task to
mimick a "
*real-life*
" run as closely as possible. This is doable using the
GUI (e.g. by launching
`compmgmt.msc`
and clicking all your way through the
"Task Scheduler" tree jungle). A much easier approach is to use the command line
again to run the job. Unfortunately there is no
*straightforward*
way to launch
a registered job on Windows 7 (on Windows 10 there is the
`Start-ScheduledTask`
cmdlet), so you have to take a little detour. First of all make sure to have a
PowerShell session running with
*elevated privileges*
(i.e. it is
**not enough**
to run it with an administrator account, you explicitly need to start it with
the "Run as Administrator" option), then issue this command:
```
PowerShell
(Get-ScheduledJob -Name "AutoTx-Updater").StartJob()
```
This should trigger a run of the updater, any actions will be recorded to the
Windows Event Log. In case the service was running before, it will be restarted
and show its related messages in the service log file.
## Coding Conventions
As mentioned above, the
**C#**
style used throughout the project differs from
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment