FormidableLabs/builder-docs-archetype

Name: builder-docs-archetype

Owner: Formidable

Description: An archetype for building static landing/documentation pages for our projects.

Created: 2016-03-23 22:28:18.0

Updated: 2017-05-21 21:44:32.0

Pushed: 2018-01-09 18:59:49.0

Homepage: null

Size: 65

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Builder Docs Archetype

A Builder archetype for Formidable static React landers.

Landers

Integration

1. In the root, you need to create a ./static-routes.js file that exports an array of all the routes your heart desires.

le.exports = [
",
about",
pineapples"

Lander Release

To release a project controlled by this archetype (e.g., victory-docs), use the following guide:

IMPORTANT - NPM: To correctly run preversion your first step is to make sure that you have a very modern npm binary:

m install -g npm

Built files in build/ should not be committed during development or PRs. Instead we only build and commit them for published, tagged releases. So the basic workflow is:

ke sure you have a clean, up-to-date `master`
t pull
t status # (should be no changes)

oose a semantic update for the new version.
 you're unsure, read about semantic versioning at http://semver.org/
m version major|minor|patch -m "Version %s - INSERT_REASONS"

sh the `build/` directory, version commits, and tag:
t push --follow-tags

d finally publish to `npm`!
m publish

And you've published!

For a reliable systems of releases, the landers should aim for versioning along these lines:

• Patch: Typos, missing assets, broken styles, very minor copyedits.
• Minor: Add a new blog post, change styles.
• Major: Rearchitect how the lander works, remove pages, or something else huge.

For additional information on the underlying NPM technologies and approaches, please review:

• npm version: Runs verification, builds build/ via scripts commands.
• npm publish: Uploads to NPM.

Archetype

This section applies to the archetype itself (builder-docs-archetype).

Builder Dependencies

You can read the Builder docs for the full story. Here is an overview of the Builder three-way dependency scheme:

• package.json:dependencies: Production dependencies for the archetype installed in a project.
• dev/package.json:dependencies: Development dependencies for the archetype installed in a project.
• package.json:devDependencies: The development dependencies used internally for the this archetype during development (self tests, checks, etc.) that are not part of the overall archetype outside workflow.

Checks, Tests

Run npm run builder:check

Archetype Release

For tagged official releases only of the archetype, make sure to:

1. Bump package.json version
2. Generate a new ARCHETYPE-dev package.json
3. Add to git, tag, and publish

m package.json            # Bump version
m CHANGELOG.md            # Add version notes
ilder-support gen-dev     # Generate `dev/*` files
m run builder:check       # Last check!
t add package.json dev
t commit -m "Version bump"
t tag -a "vNUMBER" -m "vNUMBER - INSERT_REASONS" # Create tag
t push --follow-tags
m publish                 # Publish main project
 dev && npm publish       # Publish dev project