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

Updating Sauce Labs tunnel instructions #58833

Merged
merged 4 commits into from
May 24, 2024
Merged

Conversation

daynew
Copy link
Member

@daynew daynew commented May 22, 2024

I wanted to setup Sauce Labs tunnel for the first time on my laptop but I ran into problems because the commands didn't match what we have documented. It looks like the sc Sauce Connect Proxy CLI has been updated to require more arguments:

  • region e.g. "us-west"
  • tunnel-name e.g. "dayne_localhost"
    • The important part of the tunnel name is that it has to matches what you use when running sc run --tunnel-name

This PR:

  • Creates a new config value CDO.saucelabs_tunnel_name so the UI tests can find the tunnel sc has started.
  • Update the README file related to running the Sauce Labs tunnel.

An alternative to creating the config property CDO.saucelabs_tunnel_name is to set CDO.circle_run_identifier in your locals.yml. However, I think creating a new config value is more readable.

Testing story

  • Started the tunnel and successfully ran UI tests.

PR Checklist:

  • Tests provide adequate coverage
  • Privacy and Security impacts have been assessed
  • Code is well-commented
  • New features are translatable or updates will not break translations
  • Relevant documentation has been added or updated
  • User impact is well-understood and desirable
  • Pull Request is labeled appropriately
  • Follow-up work items (including potential tech debt) are tracked and linked

@daynew daynew requested a review from a team May 24, 2024 00:28
Copy link
Contributor

@Hamms Hamms left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One comment requested, but otherwise this looks good to me! I'm looking forward to not getting confused about the discrepancy regarding tunnel names between official docs and our docs the next time I need to use local sauceconnect; thank you! 😄

dashboard/test/ui/features/support/connect.rb Show resolved Hide resolved
Copy link
Member

@breville breville left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking the time to do this!

@daynew daynew merged commit 2f80e5e into staging May 24, 2024
2 checks passed
@daynew daynew deleted the update-sauce-labs-docs branch May 24, 2024 06:19
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.

None yet

3 participants