forked from Shopify/slate
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Combine all Slate repos into a single repo
- Loading branch information
Thomas Kelly
committed
Aug 24, 2017
1 parent
d10452e
commit 881abca
Showing
150 changed files
with
12,331 additions
and
8,139 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,8 @@ | ||
src/scripts/vendor/ | ||
src/scripts/**/*.js.liquid | ||
packages/slate-theme/src/scripts/vendor/ | ||
|
||
packages/slate-theme/src/scripts/**/*.js.liquid | ||
package/slate-cli/lib | ||
package/slate-tools/ | ||
node_modules/ | ||
docs/ | ||
ci/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
{ | ||
"extends": [ | ||
"plugin:shopify/esnext", | ||
"plugin:shopify/node" | ||
], | ||
"rules": { | ||
"no-console": 0, | ||
"node/shebang": 0 | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +1,38 @@ | ||
# How to contribute | ||
We ❤️ pull requests. If you'd like to fix a bug, contribute a feature or | ||
just correct a typo, please feel free to do so, as long as you follow | ||
our [Code of Conduct](https://github.com/Shopify/slate/blob/master/CODE_OF_CONDUCT.md). | ||
We ❤️ pull requests. If you'd like to fix a bug, contribute a feature or just correct a typo, please feel free to do so, as long as you follow our [Code of Conduct](https://github.com/Shopify/slate/blob/master/CODE_OF_CONDUCT.md). | ||
|
||
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!). | ||
If you're thinking of adding a big 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!). | ||
|
||
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. | ||
|
||
## Getting Started | ||
|
||
To start working on the codebase, first fork the repo, then clone it: | ||
``` | ||
git clone [email protected]:your-username/slate.git | ||
``` | ||
*Note: replace "your-username" with your Github handle* | ||
*Note: replace "your-username" with your GitHub handle* | ||
|
||
Install the project's dependencies: | ||
Install all package dependencies and link local packages: | ||
``` | ||
npm install | ||
npm run bootstrap | ||
``` | ||
|
||
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. | ||
Write some features. Run the tests with: | ||
``` | ||
npm test | ||
``` | ||
|
||
## 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/packages/slate-theme/config-sample.yml) as an example. | ||
|
||
Go to the `slate-theme` package: | ||
``` | ||
cd packages/slate-theme | ||
``` | ||
|
||
Deploy Slate to your shop and start testing your feature. | ||
``` | ||
|
@@ -33,20 +45,14 @@ The following documents the folder structure for this project and what the purpo | |
``` | ||
+-- docs/ ** API docs that live at https://shopify.github.io/slate | ||
+-- scripts/ ** Scripts used for development such as deployment and CI scripts | ||
+-- src/ ** Contains all theme templates and assets | ||
| +-- assets/ | ||
| +-- config/ | ||
| +-- icons/ | ||
| +-- layout/ | ||
| +-- locales/ | ||
| +-- scripts/ | ||
| +-- sections/ | ||
| +-- snippets/ | ||
| +-- styles/ | ||
| +-- 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 with theme development | ||
| +-- slate-tools/ ** A collection of build tools to help with theme development | ||
``` | ||
|
||
## Documentation | ||
|
||
If your change affects how people use the project (i.e. adding or removing | ||
functionality, changing the return value of a function, etc), | ||
please ensure the documentation is also updated to | ||
|
@@ -70,8 +76,50 @@ The documentation will then be visible at: | |
|
||
## Changelog | ||
|
||
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` privileges to the `GITHUB_AUTH` environment variable by adding the following to your `.bashrc` file: | ||
``` | ||
# 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* | ||
|
||
Run the changelog generator: | ||
``` | ||
npm run changelog | ||
``` | ||
|
||
If nothing appears, you may not have any PRs tagged with appropriate labels in this release or you may have already published those changes. If you just released `v0.12.1` and the previous version was `v0.12.0`, run the following command to get the changes since `v0.12.0`: | ||
``` | ||
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. | ||
|
||
Commit the changes directly to `master` branch, with a commit title of: | ||
``` | ||
Changelog vX.X.X | ||
``` | ||
*Note: replace "X.X.X" with new repo version number* | ||
|
||
Finally, paste the updates you made to the changelog in the release tag notes, see example: [v0.10.0 tag notes](https://github.com/Shopify/slate/releases/tag/v0.10.0). | ||
|
||
|
||
|
||
## Publishing | ||
|
||
1. Merge any changes you want to include in your next release into `master`. | ||
|
||
*Note: If you are merging multiple PRs into `master` with a single PR (e.g. you are merging a working branch called v0.11.0 with multiple fixes made from multiple PRs into `master`), then **do not squash and merge this PR** because you will loose valuable details in the auto generated changelog* | ||
|
||
2. Update the [CHANGELOG.md](https://github.com/Shopify/slate/blob/master/CHANGELOG.md) as described above | ||
|
||
3. To select a new version number, publish packages to NPM, generate and deploy new `slate-theme` zips, run: | ||
``` | ||
npm run publish | ||
``` | ||
|
||
*Note: Make sure you are logged into your Shopify NPM account before publishing* | ||
|
||
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. | ||
|
||
Note to maintainers: To update the changelog, install the gem and run `github_changelog_generator` in the root directory. Paste updates to the changelog in the tag notes, see example: [v0.10.0 tag notes](https://github.com/Shopify/slate/releases/tag/v0.10.0). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,24 @@ | ||
machine: | ||
ruby: | ||
version: 2.3.1 | ||
node: | ||
version: 6.2.2 | ||
|
||
dependencies: | ||
pre: | ||
- 'echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > ~/.npmrc' | ||
- npm set progress=false | ||
- npm install -g @shopify/slate | ||
bundler: | ||
without: | ||
- benchmark | ||
- deploy | ||
- production | ||
- debug | ||
cache_directories: | ||
- .bundle/ | ||
- packages/slate-tools/node_modules | ||
- packages/slate-theme/node_modules | ||
- packages/slate-cli/node_modules | ||
override: | ||
- npm run bootstrap | ||
|
||
deployment: | ||
release: | ||
tag: /v[0-9]+(\.[0-9]+)*/ | ||
owner: Shopify | ||
commands: | ||
- npm run bootstrap | ||
- cd packages/slate-theme && ./node_modules/.bin/slate zip | ||
- node scripts/build | ||
- node scripts/deploy | ||
- curl -X PURGE https://sdks.shopifycdn.com/slate/latest/slate-theme.zip | ||
- curl -X PURGE https://sdks.shopifycdn.com/slate/latest/slate-src.zip | ||
|
||
test: | ||
pre: | ||
- slate build | ||
post: | ||
- slate test |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
{ | ||
"lerna": "2.0.0", | ||
"version": "0.11.0", | ||
"packages": [ | ||
"packages/*" | ||
], | ||
"changelog": { | ||
"repo": "shopify/slate", | ||
"labels": { | ||
"enhancement": ":rocket: Enhancement", | ||
"bug": ":bug: Bug Fix", | ||
"documentation": ":memo: Documentation", | ||
"internal": ":house: Internal" | ||
}, | ||
"cacheDir": ".changelog" | ||
} | ||
} |
Oops, something went wrong.