name: build-check
on:
# trigger on PRs.
# `opened` is when the PR is opend
# `synchronize` is when any additional pushes are made to the PR
pull_request:
types: [opened, synchronize]
# trigger on branch push
# only trigger on pushes to the `master` and `develop` branches (this also means PR merges)
# we can also ignore them if they only contain documentation changes
push:
branches:
- master
- develop
paths-ignore:
- 'docs/**'
- '**.md'
jobs:
# If the job does NOT have any `needs` jobs, then they are ran in parallel
# Run ESLint over the code base
lint:
runs-on: ubuntu-latest
steps:
- name: Git Checkout
uses: actions/checkout@v1
- name: Setup Node
uses: actions/setup-node@v1
with:
node-version: 10
- name: Install Packages
run: npm ci
- name: Run Linter
run: npm run lint
# Run all of the unit tests
test:
runs-on: ubuntu-latest
steps:
- name: Git Checkout
uses: actions/checkout@v1
- name: Setup Node
uses: actions/setup-node@v1
with:
node-version: 10
- name: Install Packages
run: npm ci
- name: Run Unit Tests
run: npm run coverage
# If `lint` and `test` pass (this is the `needs` line)
# then check the actual compiling
build:
needs: [test, lint]
runs-on: ubuntu-latest
steps:
- name: Git Checkout
uses: actions/checkout@v1
- name: Setup Node
uses: actions/setup-node@v1
with:
node-version: 10
- name: Install Packages
run: npm ci
- name: Run Build
run: npm run buildname: publish
# Trigger the publish on tag pushes
# You can also use
# release:
# types: [published]
# But this requires you to make a new release from Github
on:
push:
tags:
- v*.*.*
jobs:
# Run ESLint over the code base
lint:
runs-on: ubuntu-latest
steps:
- name: Git Checkout
uses: actions/checkout@v1
- name: Setup Node
uses: actions/setup-node@v1
with:
node-version: 10
- name: Install Packages
run: npm ci
- name: Run Linter
run: npm run lint
# Run all of the unit tests
test:
runs-on: ubuntu-latest
steps:
- name: Git Checkout
uses: actions/checkout@v1
- name: Setup Node
uses: actions/setup-node@v1
with:
node-version: 10
- name: Install Packages
run: npm ci
- name: Run Unit Tests
run: npm run test:cov
# If `lint` and `test` pass, build and publish to Github Pkg Reg
publish-gpr:
needs: [test, lint]
runs-on: ubuntu-latest
steps:
- name: Git Checkout
uses: actions/checkout@v1
- name: Setup Node
uses: actions/setup-node@v1
with:
node-version: 10
registry-url: https://npm.pkg.github.com/
scope: '@belsrc'
- name: Install Packages
run: npm ci
- name: Run Build
run: npm run build
- name: Publish Package @ Github
run: npm publish
env:
NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
- name: Create Release
uses: softprops/action-gh-release@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# # Publish to NPM Pkg Reg
# publish-npm:
# needs: [test, lint]
# runs-on: ubuntu-latest
# steps:
# - name: Git Checkout
# uses: actions/checkout@v1
#
# - name: Setup Node
# uses: actions/setup-node@v1
# with:
# node-version: 10
# registry-url: https://npm.pkg.github.com/
# scope: '@belsrc'
#
# - name: Install Packages
# run: npm ci
#
# - name: Run Build
# run: npm run build
#
# - name: Publish Package @ NPM
# run: npm publish
# env:
# NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
#
# - name: Create Release
# uses: softprops/action-gh-release@v1
# env:
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}- name: Upload coverage to Codecov
uses: codecov/[email protected]
with:
token: ${{secrets.CODECOV_TOKEN}}- name: Upload coverage to CodeClimate
run: |
export GIT_BRANCH="${GITHUB_REF/refs\/heads\//}"
curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
chmod +x ./cc-test-reporter
./cc-test-reporter format-coverage -t lcov coverage/lcov.info
./cc-test-reporter upload-coverage
env:
CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}For Yarn you will need to use an Action from the marketplace, Borales/actions-yarn.
- name: Install Packages
uses: Borales/[email protected]
with:
cmd: install
- name: Run Linter
uses: Borales/[email protected]
with:
cmd: run lintThough, admittedly, I've found it easier to just use npm for most of the actions.
Edit: It's actually easier, with less odd behavior, to just use an explicit approach instead of the above Yarn action.
lint:
runs-on: ubuntu-latest
steps:
- name: Git Checkout
uses: actions/checkout@v1
- name: Setup Node
uses: actions/setup-node@v1
with:
node-version: 10
- name: Install Yarn
run: npm i -g yarn
- name: Install Packages
run: yarn install
- name: Run Linter
run: yarn run lintIf you want to back commit any changes that occured in the actions (linting/prettier) you can use the ad-m/github-push-action action.
In order to use it on branches dynamically, you will also need to pull out the branch name from the ref.
It would probably also be a good idea to check to see if any files were actually modified in the previous step.
This will avoid the "nothing to commit, working tree clean" if you try to commit nothing.
If it doesn't need to be dynamic, you can remove the Extract Branch Name step and hard code the branch in the Push Changes step.
Action Ouput With Change Files
Action Output When Theres Nothing Changed
clean:
runs-on: ubuntu-latest
steps:
- name: Git Checkout
uses: actions/checkout@v1
- name: Setup Node
uses: actions/setup-node@v1
with:
node-version: 10
- name: Install Packages
run: npm ci
- name: Run Prettier
run: npm run prettier
- name: Run Linter
run: npm run lint
- name: Extract Branch Name
shell: bash
run: |
echo ${GITHUB_REF#refs/heads/}
echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
id: extract_branch
- name: Count Changed Files
shell: bash
run: |
git status -s -uno | wc -l
echo "##[set-output name=count;]$(git status -s -uno | wc -l)"
id: changed_count
- name: Commit Files
if: steps.changed_count.outputs.count > 0
run: |
git config --local user.email "[email protected]"
git config --local user.name "GitHub Action"
git commit -m "style: prettier & eslint changes" -a --no-verify
- name: Push Changes
if: steps.changed_count.outputs.count > 0
uses: ad-m/github-push-action@master
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
branch: ${{ steps.extract_branch.outputs.branch }}As there's not currently a specific action for Blob transfers, you'll need to use the azure/cli action. You'll need deployment credentials for the log in (Noted here and addditional info here. Can use the "Try It" shell there too)
env:
ACCOUNT_NAME: <storage account name>
SOURCE_DIR: dist/
DEST_DIR: <path/in/storage>
# No trailing slash
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Git Checkout
uses: actions/checkout@v1
- name: Setup Node
uses: actions/setup-node@v1
with:
node-version: 10
- name: Install Packages
run: npm ci
- name: Run Build
run: npm run build
# Branch name so if can be used as a sub-directory
# Replace some annoying characters, for various reasons
- name: Extract Branch Name
shell: bash
run: |
echo ${GITHUB_REF#refs/heads/} | sed "s/[\.\/\\:]/_/g"
echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/} | sed "s/[\.\/\\:]/_/g")"
id: extract_branch
- name: Azure Login
uses: azure/login@v1
with:
creds: ${{ secrets.AZURE_CREDENTIALS }}
# Use the DEST_DIR + branch name to make complete path
- name: Azure CLI Copy Artifacts
uses: azure/CLI@v1
with:
azcliversion: latest
inlineScript: |
az storage blob upload-batch --account-name ${{ env.ACCOUNT_NAME }} -s ${{ env.SOURCE_DIR }} -d '${{ env.DEST_DIR }}/${{ steps.extract_branch.outputs.branch }}'