Skip to content

ci: Don't --focus install JS deps#11267

Merged
johncowen merged 1 commit into
mainfrom
ui/bugfix/ci-unfocus
Oct 11, 2021
Merged

ci: Don't --focus install JS deps#11267
johncowen merged 1 commit into
mainfrom
ui/bugfix/ci-unfocus

Conversation

@johncowen
Copy link
Copy Markdown
Contributor

In #9049 we tried out storybook for cataloging and documenting our component files. One of the problems with that was that storybook has oodles of dependencies that we didn't really want to have folks have to download/install if they only wanted to build the production application.

The JS community/ecosystem gets around this problem by having separate dependencies for developer tooling in the devDependencies property of the package.json file. Conversely, conventional ember development dictates you should also use this devDependency property for your shipped project dependencies also. Back in #5992 we tried a different more JS traditional convention to work around this, but that was never approved.

When started depending on storybook we tried using yarn install with the --focus flag to as another attempt to prevent folks from having to install the 'kitchen sink' when all they wanted was a production UI. Unfortunately this didn't quite work out either, but the --focus flag in our build script has stuck around for one reason or another.

Since then, we've uninstalled storybook and used the marvellous docfy to catalog and document our components, plus other things. An additional benefit of this has been far less dependencies for our documentation, so the 'please don't download so much stuff' problem has pretty much just gone away.

Unfortunately, the left over yarn --focus flag has caused a few issues in CI, as CI generally installs from the root of the workspace whereas engineers generally install from the consul-ui root.

This PR brings everything together and reverts everything to just using make (with no --focus), which will do the right thing where-ever you are ( 🤞 ).

@johncowen johncowen added theme/ui Anything related to the UI type/ci Relating to continuous integration (CI) tooling for testing or releases labels Oct 11, 2021
@johncowen johncowen requested a review from kaxcode October 11, 2021 09:44
@johncowen johncowen added the pr/no-changelog PR does not need a corresponding .changelog entry label Oct 11, 2021
Copy link
Copy Markdown
Contributor

@kaxcode kaxcode left a comment

Choose a reason for hiding this comment

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

:shipit:

@johncowen johncowen merged commit e5a15fd into main Oct 11, 2021
@johncowen johncowen deleted the ui/bugfix/ci-unfocus branch October 11, 2021 13:37
@hc-github-team-consul-core
Copy link
Copy Markdown
Collaborator

🍒 If backport labels were added before merging, cherry-picking will start automatically.

To retroactively trigger a backport after merging, add backport labels and re-run https://circleci.com/gh/hashicorp/consul/468276.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr/no-changelog PR does not need a corresponding .changelog entry theme/ui Anything related to the UI type/ci Relating to continuous integration (CI) tooling for testing or releases

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants