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

chore: Update README and test scripts #148

Merged
merged 3 commits into from
Sep 21, 2023
Merged

chore: Update README and test scripts #148

merged 3 commits into from
Sep 21, 2023

Conversation

ctlong
Copy link
Member

@ctlong ctlong commented Sep 8, 2023

What is this change about?

Updates README with latest information and refactors test scripts slightly.

Please provide contextual information.

None

Please check all that apply for this PR:

  • introduces a new test (see *Note below)
  • changes an existing test
  • introduces a breaking change (other users will need to make manual changes when this change is released)
  • documentation change

Did you update the README as appropriate for this change?

  • YES
  • N/A

What is the level of urgency for publishing this change?

  • Urgent - unblocks current or future work
  • Slightly Less than Urgent

Tag your pair, your PM, and/or team!

None

- No longer need to use `go get` to get cf-smoke-tests, as Golang has
  moved toward modules instead. Should use `git` to get the repo
  instead.
- The recommended windows stack should be `windows` rather than
  `windows2012R2`, which I think might be deprecated (?). `windows` is
  the default for the `smoke_tests_windows` job in `cf-smoke-tests-release`.
- Fix up some wrapping.
- Other general updates for clarity.
- Don't print out commands run, as it adds unnecessary output. We
  already have error checking in the script.
- No need to check for $GOPATH presence anymore.
- Remove `CF_DIAL_TIMEOUT` export, as it was added 6 years ago and is
  probably outdated. I checked CATs and it's not used there anymore,
  which was the original impetus for adding it here.
- Ensure that `ginkgo run` is executed in the right directory, removing
  the need to run `./bin/test` from the repo root.
This export was added ~6 years ago because it solved some issues in
CATs, but it's no longer used in CATs.

Besides, this script is used directly by the `smoke_test_windows` job in
`cf-smoke-tests-release`, which allows for this env var to be set to a
BOSH property. We shouldn't override that property here.
@ctlong
Copy link
Member Author

ctlong commented Sep 8, 2023

Pls ignore the CodeQL workflow for now. See #147 for more info.

@ctlong ctlong requested a review from a team September 20, 2023 15:58
@ctlong ctlong merged commit 8349d95 into main Sep 21, 2023
@ctlong ctlong deleted the chore/readme branch September 21, 2023 17:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants