diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 97a6a72..3208b5b 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -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 @@ -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 diff --git a/README.md b/README.md index b49ef4e..8b3ddf0 100644 --- a/README.md +++ b/README.md @@ -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 \ No newline at end of file