Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,15 @@ jobs:
persist-credentials: false

- name: 🧶 Setup Node
id: node_setup
uses: actions/setup-node@v4
with:
node-version-file: 'package.json'
cache: 'npm'

- name: ℹ️ Display Node.js version
run: echo "Node.js version ${{ steps.node_setup.outputs.node-version }}"

- name: 👩‍🔧 Install dependencies
run: npm clean-install

Expand All @@ -50,6 +54,8 @@ jobs:

- name: 📝 Generate workflow summary
run: |
echo "Node.js version: **${{ steps.node_setup.outputs.node-version }}**" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
echo "### 📦 Webpack Build Summary" >> $GITHUB_STEP_SUMMARY
echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
sed -r "s/\x1B\[[0-9;]*[mK]//g" build-output.log >> $GITHUB_STEP_SUMMARY
Expand Down
34 changes: 24 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,37 @@
[![CI Pipeline](https://github.com/cdk/cdk.github.io/actions/workflows/ci.yaml/badge.svg)](https://github.com/cdk/cdk.github.io/actions/workflows/ci.yaml)
[![Deploy to GitHub Pages](https://github.com/cdk/cdk.github.io/actions/workflows/deploy.yaml/badge.svg)](https://github.com/cdk/cdk.github.io/actions/workflows/deploy.yaml)

# Readme

Important! Currently you need to use Node v14.
### Install instructions

#### Install instructions
###### Install all the project dependencies
```>$ npm install ```
#### Install all the project dependencies
```>$ npm clean-install```

###### Create a 'dist/'
#### Create a 'dist/'
```>$ npm run dev```

###### Run a local development server with browser syncing
#### Run a local development server with browser syncing
```>$ npm run watch ```

###### Build the code ('dist/') - Production (Uglify, minimise the code and the images)
#### Build the code (outputs to 'dist/') - Production (Uglify, minimise the code and the images)
```>$ npm run production ```

To test the website it needs to be run on a HTTP server, a quick way of doing this is with python:
To test the website it needs to be run on a HTTP server a quick way of doing this is with python is:

# http://localhost:8000
```
$ python -m SimpleHTTPServer 8000
```

This makes the website available on `http://localhost:8000`.

### Deployment to GitHub Pages

> [!NOTE]
> The default branch of this repository is `source`.
> The branch `source` is used when building the website for deployment to GitHub pages.

Deployment to GitHub Pages can be

###### Copy dist to master/ branch
1. manually run from [this Actions tab](https://github.com/cdk/cdk.github.io/actions/workflows/pages/pages-build-deployment) and
2. runs automatically when a tagged [release](https://github.com/cdk/cdk.github.io/releases) is created on GitHub
Loading