Combine all Slate repos into a single monorepo #212

t-kelly · 2017-08-03T13:04:19Z

What are you trying to accomplish with this PR?

Combines all Slate repos into a monorepo. This will simplify the Slate project by having a single build, test, and release process. It will make creating and managing issues and PRs easier by having them all in one place.

Improvements to the publishing and deployment workflow have also been made, with most the work being handled by a new npm run publish command. Check out the new CONTRIBUTING.md for more details.

Note: All commits in this PR except the last are pulled from the slate-cli and slate-tools repos to preserve git history

After this PR is merged, I will migrate Github issues from slate-tools and slate-cli to this repo.

Checklist

For contributors:

I have updated the docs to reflect these changes, if applicable.

For maintainers:

I have 🎩'd these changes.

* initial yeoman scaffold / generator test * slate cli command scaffolding

… robust

…[--manual] * watch [--nosync] * zip * ------ * update npm shrinkwrap

… in the near future

* install themekit with bin-wrapper * themekit abstraction setup * remove extra rule * remove placeholder bundler installer * refactoring and updating for feedback * EOL gitignore

* generates a new section scaffold in the current theme's `src/sections/` directory * fixed a bug with theme generation when no name was provided.

* improve ThemeKit comments * one more ThemeKit comment

* Clone a repo to your project folder * Changes * changes * Changes * Change * refactor some code * install dependencies * remove random files * git init and replace slate pkg * add git/yeoman tpl files/env questions * finish todos and start commenting code * remove extra logs * update comment on private function * add last private function comment * absolute dep * commit stuff * get generator files from slate repo * pull templates from cache * fix indent

…ort for deploying to multiple environments

* add slate theme as a dependency * remove nodegit * refactor to only slate for now * remove unused dependencies * improve handling of scaffold * re-add git questions on new theme * fix spacing * add gitignore to new theme * ignore npmignore when converting to gitignore * remove scaffold question

* exploring help design pattern * update new mock * add help to commands * update me being silly and forgetting things * remove try catch in favour of lodash * change double space formatting on help messages

…repo)

jonathanmoore · 2017-08-04T01:16:36Z

This looks great! I'm positive this will make maintaining Slate significantly easier.

Hopefully, soon there will be some type of plugin solution for pre/post slate-tools tasks. Right now maintaining a fork of shopify/slate-tools for custom tasks is fairly straightforward, but it will be more complex as a monorepo. I don't see a clear way to with NPM to install a forked monorepo package.

t-kelly · 2017-08-07T19:33:25Z

@jonathanmoore how are you currently NPM installing your forked version of slate-tools? I don't think this should change anything as all the packages are still structured the same.

The only issue I see is that you will now need to merge in updates from all slate repos, not just slate-tools.

bertiful

Minor documentation typos to fix, rest looks good to me.

While I didn't run npm run publish, I ran all other commands and they seems to be working just fine. I'd be good to merge this once @NathanPJF tests on his side.

bertiful · 2017-08-08T19:10:12Z

CONTRIBUTING.md

+
+This repo is a [monorepo](https://github.com/babel/babel/blob/master/doc/design/monorepo.md) consisting of multiple packages and is managed using [Lerna](https://github.com/lerna/lerna).
+
+The `slate-theme` scaffolding is [intentionally barebones](https://shopify.github.io/slate/theme/#intentionally-blank) to provide an unopinionated starting point.  If you're thinking of adding a new feature, consider opening an issue first to discuss it to ensure it aligns to the direction of the project (and potentially save yourself some time!).


The "If you're thinking of adding... sentence is duplicated - once here and once above.

bertiful · 2017-08-08T19:10:37Z

CONTRIBUTING.md

 To start working on the codebase, first fork the repo, then clone it:
 ```
 git clone git@github.com:your-username/slate.git
 ```
 *Note: replace "your-username" with your Github handle*

-Install the project's dependencies:
+Install the all package dependencies and link local packages:


"Install all package dependencies"

bertiful · 2017-08-08T19:12:14Z

CONTRIBUTING.md

- | +-- styles/
- | +-- templates/
+ +-- packages/ ** Contains the different components of the Slate project
+ | +-- slate-cli/ ** A command line interface used to execute slate commands


"execute Slate commands"

bertiful · 2017-08-08T19:12:38Z

CONTRIBUTING.md

- | +-- templates/
+ +-- packages/ ** Contains the different components of the Slate project
+ | +-- slate-cli/ ** A command line interface used to execute slate commands
+ | +-- slate-theme/ ** A boilerplate theme to get started on theme development


"with theme development"

bertiful · 2017-08-08T19:12:55Z

CONTRIBUTING.md


 ## Getting Started
+
 To start working on the codebase, first fork the repo, then clone it:
 ```
 git clone git@github.com:your-username/slate.git
 ```
 *Note: replace "your-username" with your Github handle*


"your GitHub handle"

bertiful · 2017-08-08T19:14:17Z

CONTRIBUTING.md

-The [CHANGELOG.md](https://github.com/Shopify/slate/blob/master/CHANGELOG.md) file is generated by the gem [github_changelog_generator](https://github.com/skywinder/github-changelog-generator).  Changelog will itemize changes between tags on GitHub.
+The changelog is updated by the repo's maintainers since a [personal access token](https://github.com/settings/tokens) with repository access is needed to handle GitHub's API call limits.
+
+If this is your first time generating changelog entries, add your personal access token with `public_repo` privledges to the `GITHUB_AUTH` environment variable by adding the following to your `.bashrc` file:


"privileges to the"

bertiful · 2017-08-08T19:14:58Z

CONTRIBUTING.md

+# Lerna Changelog Personal Access Token for shopify/slate repo
+export GITHUB_AUTH=your_personal_access_token
+```
+*Note: replace "your_personal_access_token" with your Github personal access token*


"GitHub personal access token"

bertiful · 2017-08-08T19:15:35Z

CONTRIBUTING.md

+npm run changelog -- --tag-from=v0.12.0
+```
+
+Copy the generated markdown from your terminal into [CHANGELOG.md](https://github.com/Shopify/slate/blob/master/CHANGELOG.md) and add any additional comments you wish to include. If the title of the autogenerated changelog is `Unreleased`, make sure you change it the new version name.


bertiful · 2017-08-08T19:19:03Z

lerna.json

+      "enhancement": ":rocket: Enhancement",
+      "bug": ":bug: Bug Fix",
+      "documentation": ":memo: Documentation",
+      "internal": ":house: Internal"


What does internal refer to?

Internal refers to behind the scenes changes that don't necessarily change anything for users. This PR is an example of an internal change.

bertiful · 2017-08-08T19:26:27Z

scripts/deploy.js

-  }
+  this.bucket = process.env.AWS_BUCKET;
+  AWS.config.credentials = new AWS.Credentials(process.env.AWS_ACCESS_KEY_ID, process.env.AWS_SECRET_ACCESS_KEY);
+  AWS.config.region = 'us-east-1';


All the updates in this file look good to me - I assume there's really no way to test until we merge the changes?

Yeah. Any changes needed to be done to these files can me committed directly to master.

NathanPJF

A couple of documentation and URLs that will need to be updated.

I spent some time testing this branch and ran into some issues. I'm going to send you a separate note with those because it's a bit much to get into in a GitHub thread.

NathanPJF · 2017-08-10T12:50:47Z

CONTRIBUTING.md

+```
+
+## View changes to `slate-theme` package in a live store
+
 Create a config.yml file with private app settings from your shop. See [config-sample.yml](https://github.com/Shopify/slate/blob/master/config-sample.yml) as an example.


Link to config-sample will have to reflect new repo structure. Worth doing a mass search and replace for that file.

Did a search for all blob/master links

NathanPJF · 2017-08-10T13:22:43Z

packages/slate-cli/README.md

@@ -0,0 +1,214 @@
+# Slate CLI
+[![CircleCI](https://circleci.com/gh/Shopify/slate-cli.svg?style=svg&circle-token=83ed3f203115767f7bc4e6f3be07cb93788f4bd2)](https://circleci.com/gh/Shopify/slate-cli)


Is this still relevant?

NathanPJF · 2017-08-10T13:23:16Z

packages/slate-cli/README.md

+You will need to fill in the required fields for each store / environment. Comment out any environments that you want to set up later or Theme Kit will throw an error.
+
+> _For more details on configuring your environments please see our
+**[Store configuration guide](https://github.com/Shopify/slate-cli/blob/master/store-configuration.md)**._


URL will need to be updated.

NathanPJF · 2017-08-10T13:23:30Z

packages/slate-cli/README.md

+
+## License
+
+MIT, see [LICENSE.md](http://github.com/Shopify/slate-cli/blob/master/LICENSE.md) for details.


URL will need to be updated.

NathanPJF · 2017-08-10T13:24:09Z

packages/slate-cli/store-configuration.md

+
+### Finding your theme_id
+
+_**warning:** some commands ([`start`](https://github.com/Shopify/slate-cli#start), [`deploy`](https://github.com/Shopify/slate-cli#deploy)) will overwrite the existing code on this `theme_id` with empty boilerplate.


URLs will need to be updated.

([`start`](https://github.com/Shopify/slate/packages/slate-cli#start)

and

([`deploy`](https://github.com/Shopify/slate/packages/slate-cli#deploy)

NathanPJF · 2017-08-10T13:25:08Z

packages/slate-tools/README.md

@@ -0,0 +1,29 @@
+# @shopify/slate-tools
+[![CircleCI](https://circleci.com/gh/Shopify/slate-tools.svg?style=svg&circle-token=0b8147527ef88134b4238064a563ceaaae98f06a)](https://circleci.com/gh/Shopify/slate-tools)


Still relevant?

NathanPJF · 2017-08-10T13:25:53Z

packages/slate-tools/README.md

+
+## Contributing
+For help on setting up the repo locally, building, testing, and contributing
+please see [CONTRIBUTING.md](https://github.com/Shopify/slate-tools/blob/master/CONTRIBUTING.md).


URLs will need to be updated. A couple below as well.

NathanPJF

One comment above about updating the URLs. Rest looks good 😎

lock · 2018-10-26T19:36:19Z

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

m-ux and others added 30 commits July 31, 2017 10:33

Initial commit

241dac0

slate-cli core functionality:

21cdca4

* initial yeoman scaffold / generator test * slate cli command scaffolding

shrink-wrap project

d453b51

generates config file using store data provided by user

0147243

updates based on PR Feedback + making solution more full-featured and…

a55c564

… robust

flight of the navigator

c57be5a

learning to count

bc251ed

core CLI theme commands: * start / default * test * build * deploy …

f1c9ad4

…[--manual] * watch [--nosync] * zip * ------ * update npm shrinkwrap

refactor theme task implementation

79cd869

fix scoping of root check * still requires verification at some point…

a8d0faa

… in the near future

Setup ThemeKit locally and add commands for slate gulp tasks (#5)

0fe3b88

* install themekit with bin-wrapper * themekit abstraction setup * remove extra rule * remove placeholder bundler installer * refactoring and updating for feedback * EOL gitignore

slate-cli section generator:

89df7f2

* generates a new section scaffold in the current theme's `src/sections/` directory * fixed a bug with theme generation when no name was provided.

Cleanup function comments on ThemeKit code (#8)

5730f20

* improve ThemeKit comments * one more ThemeKit comment

removed lib and moved the contents down to root

2b02668

missed 1

3551afa

new approach for passing args to nam script (cleans up hackyness) sup…

009d20d

…ort for deploying to multiple environments

add error when themekit isn't setup (#12)

b50c039

Add help command and option (#14)

628f1de

* exploring help design pattern * update new mock * add help to commands * update me being silly and forgetting things * remove try catch in favour of lodash * change double space formatting on help messages

support for overriding active theme prompt (alert-deploy PR on slate …

f0396c4

…repo)

Add new documentation to README.md

1401afe

Add active flag to deploy help

56d1831

silly me...

7bdd366

Remove README section and reformat getting started steps

7ae41d7

Add slate setup step

18b9b72

remove postinstall hook (#19)

97e2e0c

Updates the watch readme to point out a bug.

d93e8a3

burn shrinkwrap (#21)

f648782

Add gulp install to readme

abf3712

t-kelly self-assigned this Aug 3, 2017

t-kelly requested review from bertiful and NathanPJF August 3, 2017 13:04

t-kelly force-pushed the lerna branch 9 times, most recently from d4249a9 to f788cc5 Compare August 3, 2017 19:28

t-kelly changed the base branch from 0.12.0 to master August 7, 2017 18:30

bertiful suggested changes Aug 8, 2017

View reviewed changes

bertiful reviewed Aug 8, 2017

View reviewed changes

NathanPJF suggested changes Aug 10, 2017

View reviewed changes

t-kelly force-pushed the lerna branch 3 times, most recently from 706dce4 to e3a299a Compare August 11, 2017 13:37

bertiful approved these changes Aug 11, 2017

View reviewed changes

NathanPJF approved these changes Aug 11, 2017

View reviewed changes

Combine all Slate repos into a single repo

eeb8c04

t-kelly force-pushed the lerna branch from e3a299a to eeb8c04 Compare August 11, 2017 14:19

t-kelly merged commit 41b3269 into master Aug 11, 2017

t-kelly deleted the lerna branch August 11, 2017 14:19

t-kelly mentioned this pull request Aug 14, 2017

Combine all Slate repos into one but keep individual NPM packages #199

Closed

lock bot locked as resolved and limited conversation to collaborators Oct 26, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Combine all Slate repos into a single monorepo #212

Combine all Slate repos into a single monorepo #212

t-kelly commented Aug 3, 2017 •

edited

Loading

jonathanmoore commented Aug 4, 2017

t-kelly commented Aug 7, 2017

bertiful left a comment

bertiful Aug 8, 2017

bertiful Aug 8, 2017

bertiful Aug 8, 2017

bertiful Aug 8, 2017

bertiful Aug 8, 2017

bertiful Aug 8, 2017

bertiful Aug 8, 2017

bertiful Aug 8, 2017

bertiful Aug 8, 2017

t-kelly Aug 11, 2017

bertiful Aug 8, 2017

t-kelly Aug 8, 2017

NathanPJF left a comment

NathanPJF Aug 10, 2017

t-kelly Aug 11, 2017

NathanPJF Aug 10, 2017

NathanPJF Aug 10, 2017

NathanPJF Aug 10, 2017

NathanPJF Aug 10, 2017

NathanPJF Aug 11, 2017 •

edited

Loading

NathanPJF Aug 10, 2017

NathanPJF Aug 10, 2017

NathanPJF left a comment

lock bot commented Oct 26, 2018


		This repo is a [monorepo](https://github.com/babel/babel/blob/master/doc/design/monorepo.md) consisting of multiple packages and is managed using [Lerna](https://github.com/lerna/lerna).

		The `slate-theme` scaffolding is [intentionally barebones](https://shopify.github.io/slate/theme/#intentionally-blank) to provide an unopinionated starting point. If you're thinking of adding a new feature, consider opening an issue first to discuss it to ensure it aligns to the direction of the project (and potentially save yourself some time!).

		@@ -0,0 +1,214 @@
		# Slate CLI
		[![CircleCI](https://circleci.com/gh/Shopify/slate-cli.svg?style=svg&circle-token=83ed3f203115767f7bc4e6f3be07cb93788f4bd2)](https://circleci.com/gh/Shopify/slate-cli)


		## License

		MIT, see [LICENSE.md](http://github.com/Shopify/slate-cli/blob/master/LICENSE.md) for details.


		### Finding your theme_id

		_warning: some commands ([`start`](https://github.com/Shopify/slate-cli#start), [`deploy`](https://github.com/Shopify/slate-cli#deploy)) will overwrite the existing code on this `theme_id` with empty boilerplate.

		@@ -0,0 +1,29 @@
		# @shopify/slate-tools
		[![CircleCI](https://circleci.com/gh/Shopify/slate-tools.svg?style=svg&circle-token=0b8147527ef88134b4238064a563ceaaae98f06a)](https://circleci.com/gh/Shopify/slate-tools)

Combine all Slate repos into a single monorepo #212

Combine all Slate repos into a single monorepo #212

Conversation

t-kelly commented Aug 3, 2017 • edited Loading

What are you trying to accomplish with this PR?

Checklist

jonathanmoore commented Aug 4, 2017

t-kelly commented Aug 7, 2017

bertiful left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NathanPJF left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NathanPJF Aug 11, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NathanPJF left a comment

Choose a reason for hiding this comment

lock bot commented Oct 26, 2018

t-kelly commented Aug 3, 2017 •

edited

Loading

NathanPJF Aug 11, 2017 •

edited

Loading