Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JamesMc86 authored Mar 1, 2023
1 parent 91bfc45 commit ce763a5
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,23 @@ To build the installer you must install cargo wix. This is done as part of the C

The LabVIEW library is maintained in LabVIEW 2015 32-bit and the source is in the LabVIEW Source subfolder.

VI Tester is used for unit testing in LabVIEW>
VI Tester is used for unit testing in LabVIEW.

As LabVIEW for Linux 2015 is not readily accessible all development changes need to be done on Windows then tested on Linux.

### Distributing

There is a vipc file next to the project for building the output package.

## Integration Testing
## Just Command Runner

This project uses the Just Command Runner (https://github.com/casey/just/tree/master) to help automate some of the tasks. I recommend you follow the installation instructions there.

The integration tests folder contains a bat file to run a number of tests against LabVIEW VIs and built EXEs. Please run this with your new EXE to test the integration still works.
The current commands are:

To update and run the tests:
* **just unit-test**: Run the unit tests through VI Tester
* **just integration-test**: Probably the most useful. Run the integration test against the existing builds.
* **just integration-test-with-build**: Runs the build for the integration tests then runs them. Not tested across all platforms.

1. Build and install your updates as a vipb. The tests run against the installed version.
2. Open "Integration Tests/CLI Integration Tests.lvproj" and rebuild all the exes.
3. Close LabVIEW and then run "Integration Tests/Run Integration Tests.bat"
4. The bat file should provide feedback if any tests fail.

For a complete release test this should be tested with LabVIEW's allowMultipleInstances flag true and false. For a quick test just false is required.

0 comments on commit ce763a5

Please sign in to comment.