styleguide-starter-gutenberg-blocks-wordpress v0.2.2
Styleguide Template - React, Storybook, Cypress, Jest, SCSS Modules, Styled Components
Available Scripts
In the project directory, you can run:
yarn start
Runs the app in the development mode. Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits. You will also see any lint errors in the console.
yarn test
Launches the test runner in the interactive watch mode. See the section about running tests for more information.
yarn build
Builds the app for production to the build
folder. It correctly bundles
React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes. Your app is ready to be deployed!
See the section about deployment for more information.
yarn eject
Note: this is a one-way operation. Once you eject
, you can’t go back!
If you aren’t satisfied with the build tool and configuration choices, you can
eject
at any time. This command will remove the single build dependency from
your project.
Instead, it will copy all the configuration files and the transitive
dependencies (webpack, Babel, ESLint, etc) right into your project so you have
full control over them. All of the commands except eject
will still work, but
they will point to the copied scripts so you can tweak them. At this point
you’re on your own.
You don’t have to ever use eject
. The curated feature set is suitable for
small and middle deployments, and you shouldn’t feel obligated to use this
feature. However we understand that this tool wouldn’t be useful if you couldn’t
customize it when you are ready for it.
cypress open
Cypress End-to-End Testing Suite
./generate_component
To generate components with test and Storybook stories
Release management with Auto
To publish releases to npm, we’ll use a process that also updates a changelog describing changes, sets a sensible version number, and creates git tag linking that version number to a commit in our repository. To help with all those things, we’ll use an open-source tool called Auto, designed for this very purpose.
Let’s install Auto:
yarn add --dev auto
Auto is a command line tool we can use for various common tasks around release management. You can learn more about Auto on their documentation site.
Getting a GitHub and npm token
For the next few steps, Auto is going to talk to GitHub and npm. In order for that to work correctly, we’ll need a personal access token. You can get one of those on this page for GitHub. The token will need the repo
scope.
For npm, you can create a token at the URL: https://www.npmjs.com/settings/<your-username>/tokens.
You’ll need a token with “Read and Publish” permissions.
Let’s add that token to a file called .env
in our project:
GH_TOKEN=<value you just got from GitHub>
NPM_TOKEN=<value you just got from npm>
By adding the file to .gitignore
we’ll be sure that we don’t accidentally push this value to an open-source repository that all our users can see! This is crucial. If other maintainers need to publish the package from locally (later we’ll set things up to auto publish when PRs are merged to master) they should set up their own .env
file following this process:
storybook-static
dist
.env
Create labels on GitHub
The first thing we need to do with Auto is to create a set of labels in GitHub. We’ll use these labels in the future when making changes to the package (see the next chapter) and that’ll allow auto
to update the package version sensibly and create a changelog and release notes.
yarn auto create-labels
If you check on GitHub, you’ll now see a set of labels that auto
would like us to use:
We should tag all future PRs with one of the labels: major
, minor
, patch
, skip-release
, prerelease
, internal
, documentation
before merging them.
Publish our first release with Auto manually
In the future, we’ll calculate new version numbers with auto
via scripts, but for the first release, let’s run the commands manually to understand what they do. Let’s generate our first changelog entry:
yarn auto changelog
This will generate a long changelog entry with every commit we’ve created so far (and a warning we’ve been pushing to master, which we should stop doing soon).
4 years ago