mirror of
https://github.com/waku-org/waku.org.git
synced 2025-02-21 18:28:18 +00:00
057b1512ab
The current implementation of the site builder requires content
repo to be submited as a zip file for production using env vars
`CONTENT_SOURCE_TYPE=git` and `CONTENT_SOURCE_URL=repo-link.zip`
which is not considered a best practice. Due to this, a race
condition may occur during the build process if another commit
is made while the build is in progress which may lead a security
flow. To work around this,first, we checkout into `src` using
`checkoutToSubdirectory('src')`. Then, we use `local_folder`
mode using `CONTENT_SOURCE_TYPE=local_folder` and
`CONTENT_SOURCE_URL=..src` env vars, just like a local develop.
`local_folder` mode copies the website files from `src` into
`docs` because the site builder is incapable of copying it.
We checkout the builder into the `builder` directory and run
the `install` and `build` commands inside of that directory.
Finally, for publish stages, we copy the `out` directory into
the site repo, since the out directory is in the wrong repo.
Waku.org
Description
Content of https://waku.org website.
Practical notes
- Please keep this repo clean and for markdown content ONLY
- In case you have any issue with rendering, how website looks, etc, please file an issue on logos website builder.
Continuous Integration
masterbranch is deployed to https://waku.org by CI.developbranch is deployed to https:/dev.waku.org by CI.
Format & spelling checks
Format and spelling checks are done via npm commands.
Installation:
yarn
This will automatically install a git hook to format and check spelling at commit time. You can also trigger the commands manually:
Fix format:
yarn fix
Check spelling and format:
yarn check
Change Process
- Create a new working branch from
develop:git checkout develop; git checkout -b my-changes, - Proceed with changes, push to
originand open a Pull Request againstdevelop, - Once approved, merge pull request, check changes on dev.waku.org,
- Once ready to promote to live website, rebase master on develop:
git checkout master; git pull master; git rebase origin/develop; git push.