docs: Include tips for running alongside Test Suite when maintaining #216
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lukehesluke
commented
Sep 20, 2023
Comment on lines
-9
to
-17
| 1. In Visual Studio, run the BookingSystem.AspNetCore project | ||
|
|
||
| When it's finished building, it will open a page in your browser with a randomly assigned port e.g. http://localhost:55603/. Make note of this port. | ||
|
|
||
| Head to `http://localhost:{PORT}/openactive` to check that the project is running correctly. You should see an Open Data landing page. | ||
| 2. Head to BookingSystem.AspNetCore project options and add an env var using the port you made note of earlier: | ||
|
|
||
| `ApplicationHostBaseUrl: http://localhost:{PORT}` | ||
| 3. Now, re-run the project. You're good to go 👍 |
There was a problem hiding this comment.
This is now obsolete.
lukehesluke
commented
Sep 20, 2023
|
|
||
| `ApplicationHostBaseUrl: http://localhost:{PORT}` | ||
| 3. Now, re-run the project. You're good to go 👍 | ||
| See the [project contribution documentation](/CONTRIBUTING.md) for details on how to run BookingSystem.AspNetCore locally. |
There was a problem hiding this comment.
I've put this info in the project-wide CONTRIBUTING because 1). it also incorporates running of IdentityServer (in most cases) 2). to allow it to more easily tie in with the discussion about Test Suite
lukehesluke
commented
Sep 20, 2023
| ``` | ||
| * **Test Suite**: To run this locally, follow the guidelines in its [project's contribution documentation](https://github.com/openactive/openactive-test-suite/blob/master/CONTRIBUTING.md). | ||
|
|
||
| ### Optimizing for controlled mode |
There was a problem hiding this comment.
This heading is referenced by openactive/openactive-test-suite#586
civsiv
reviewed
Sep 20, 2023
|
|
||
| ## Pull Request Process | ||
|
|
||
| Changes to [OpenActive.Server.Net](.) should be tested with the [Test Suite](#test-suite) before a Pull Request is submitted, to ensure that the reference implementation remains conformant. If changes are also required to Test Suite in order to properly test the new changes, then `coverage/*` branches should be used for both repositories, as documented in Test Suite's [Pull Request Process](https://github.com/openactive/openactive-test-suite/blob/master/CONTRIBUTING.md#pull-request-process) documentation. |
There was a problem hiding this comment.
There was a problem hiding this comment.
Thanks @civsiv . Totally agreed. I wasn't sure how to do it so I created a new draft issue for now: https://github.com/orgs/openactive/projects/17/views/8?pane=issue&itemId=39372185 and linked it to the issue for that Gitbook PR
civsiv
approved these changes
Sep 20, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #214