Home

This project uses an unconventional deploy process.

Please read the the Making Changes section below to ensure that you understand the process before proceeding to make changes.

Making Changes

All edits should be made in the develop branch.

The master branch is used for publishing the compiled end product. The gh-pages branch is used for QA.

1. Middleman

Make sure you are able to run middleman on your system.

EXECJS_RUNTIME=Node bundle exec middleman server

If you are unable to run middleman, you will not be able to view your changes locally and builds will fail when attempting to publish.

2. Remotes

Set up your remotes for QA and Production. QA uses a separate repo from Production.

• QA: https://github.com/moxiworks/moxiworks-platform.github.io
• Production: https://github.com/moxiworks-platform/moxiworks-platform.github.io

The scripts that publish to QA and Production use the qa and upstream remotes to publish to the respective environments.

Using these specific names for remotes are necessary in order for the scripts to run correctly.

git remote add qa https://github.com/moxiworks/moxiworks-platform.github.io

Note: if you have not worked on this project before you will likely need to request access to the repo.

3. Check remote branches

Make sure qa develop is not ahead of upstream develop branch.

If qa develop is ahead of upstream develop, check with committer to see if the changes are ready to be published. If they are, either the committer will need to run the publish script or you will need to pull changes from qa develop and run the publish script.

If changes are not ready to be published to Prod, you will need to make arrangements with committer to determine next steps.

4. Sync local develop branch

Make sure your local develop is up to date with upstream develop branch.

5. Make changes

Make your changes and preview locally.

All documents are in the partials directory.

Start middleman server to view changes locally.

EXECJS_RUNTIME=Node bundle exec middleman server

6. Commit changes

Commit your changes to local develop branch.

7. Publish to QA

When ready to publish to QA, run the QA publish script

./qa_publish.sh

8. Verify QA

Review your changes in QA to ensure builds ran correctly and no conflicts occurred

9. Publish to Production

When ready to publish to Production, run the Production publish script

./publish.sh

The build can take a few minutes. Once complete you should see the changes in the production environment.