This is a Gatsby generated site pulling data from:
.nvmrc
(Ideally use nvm
to use the right version)corepack enable
(this allows auto-install of the correct yarn
version)yarn install
to install packages.env.template
- get the values from Keeper (SSW.Rules Environment Variables)Notes:
- If you don't work at SSW or can't get on to the SSW.Rules team you can just add values to GITHUB_API_PAT and CONTENT_BRANCH
- For
GITHUB_API_PAT
, create a PAT on GitHub (remove angle brackets <>)- Set
CONTENT_BRANCH
tosample-content-with-guid
(it's a smaller version of the main content branch which will build much quicker π)- Sometimes you might want to use
main
or create your own branch if you are testing something.
yarn dev
(.env.development is required for this step) it takes a while to build all the rulesyarn clean
then yarn dev
Figure: VS Code recommended extensions notification
As per rule: Done - Do you go beyond 'Done' and follow a 'Definition of Done'?
main
is the main 'dev' branchrelease/xx
is the 'production' one (where xx is the Sprint number)Changes made to http://github.com/SSWConsulting/SSW.Rules.Content (i.e. rule changes) trigger builds that deploy:
Branching off main to release/xx, or making changes to release/xx will build and deploy to the production site: https://www.ssw.com.au/rules
Rules repository lives here: https://github.com/SSWConsulting/SSW.Rules.Content
Merging changes to main on this repo will trigger:
http://localhost:{{ PORT NUMBER }}/rule/
Figure: Sample of the Example Rule
Sometimes you might have to update a rule markdown file to test your latest feature, such as changing the background color of a greybox.
To update specific markdown components, follow these steps:
sample-content
branch:
sample-content
branchsample-content
branchyarn clean
and then yarn dev