Skip to content

SETUP.md and TESTING.md updates for first-time success - #51089

Merged
snickell merged 14 commits into
stagingfrom
fix-setup.md-on-macos
Apr 19, 2023
Merged

SETUP.md and TESTING.md updates for first-time success#51089
snickell merged 14 commits into
stagingfrom
fix-setup.md-on-macos

Conversation

@snickell

@snickell snickell commented Apr 4, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor

Patchups to SETUP.md and TESTING.md to make the instructions work for first-timers, particularly on macOS Monterey.

Links

Testing story

Deployment strategy

Follow-up work

Privacy

Security

Caching

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

snickell added 2 commits April 3, 2023 16:12
@snickell
Explicit bundle config w/o non-dev groups
11ee3c1 
Add explicit step in setup.md to exclude staging, test, production
and levelbuilder groups from Gemfile.
@snickell
Update setup.md for macOS monterey
2b3d0d3
@snickell snickell changed the title Update SETUP.md to fix ordering issue and for macOS Monterey Update SETUP.md for first-time setup on macOS Monterey Apr 4, 2023
mgc1194
mgc1194 reviewed Apr 4, 2023
View reviewed changes
Comment thread SETUP.md Outdated
davidsbailey
davidsbailey reviewed Apr 4, 2023
View reviewed changes
Comment thread SETUP.md
davidsbailey
davidsbailey approved these changes Apr 4, 2023
View reviewed changes

@davidsbailey davidsbailey left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for making this improvement, Seth! The scenario of installing from scratch definitely slipped through the cracks when we looked at this last.

snickell added 5 commits April 4, 2023 09:33
@snickell
Promote "request aws creds" to a step
4cc0727 
Currently listed as a response to an error message, a little buried.
Promoted to an early step so request is made early and other work can continue while waiting.
@snickell
Suggest making AWS request first
8378e6d
@snickell
open source contributors will need local secrets
3ac9bd2
@snickell
Collapse duplicate AWS account steps
07752c0
@snickell
Undo automatic renumbering infliced by vscode
93e4637
@snickell
snickell requested a review from mgc1194 April 5, 2023 22:57
@snickell

snickell commented Apr 6, 2023

Copy link
Copy Markdown
Contributor Author

TY for help getting my build going 🎉

I’ve moved on to TESTING.md. It appears that the dashboard tests require mini_racer, so if a working dev setup for dashboard entails running tests (probably? lmk if not), working around installing mini_racer on mac may not get us/me all the way.

Long-term:
@davidsbailey has a jira issue open for the “install node on prod” long-term fix: see https://codedotorg.atlassian.net/browse/INF-708 and #47788

Short-term:
Perhaps the easiest workaround for SETUP.md, pending resolution of the jira issue, would be to suggest mac devs maintain an unstaged change bumping the mini_racer version in Gemfile.lock to 0.5.0? Its ugly, but its probably (?) better to acknowledge ugly and have setup instructions that get new devs all the way.

Thoughts?

@snickell snickell changed the title Update SETUP.md for first-time setup on macOS Monterey SETUP.md and TESTING.md updates for first-time success Apr 6, 2023
snickell added 4 commits April 5, 2023 14:27
@snickell
Remove more duplicate refs to "from the dash dir"
e3433a0
@snickell
Add bundle exec to TESTING.md rake test cmds
b35a576 
For consistency, some commands were prefixed, some weren't. All need it.
@snickell
Document running dash tests from top-level
368ebfd 
Include link to initial seeding required for dash tests.
@snickell
More correct wording
683f557
mgc1194
mgc1194 approved these changes Apr 7, 2023
View reviewed changes

@mgc1194 mgc1194 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks Great, less confusing and easier to follow!

@snickell
snickell merged commit 138d08a into staging Apr 19, 2023
@snickell
snickell deleted the fix-setup.md-on-macos branch April 19, 2023 02:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@davidsbailey davidsbailey davidsbailey approved these changes
+1 more reviewer
@mgc1194 mgc1194 mgc1194 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@snickell @davidsbailey @mgc1194