diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index a39041e2..96022fdd 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -16,6 +16,23 @@ jobs: PRE_RELEASE: 'false' CHANGELOG_FILE: 'CHANGELOG.md' ALLOW_EMPTY_CHANGELOG: 'false' + docs: + name: Documentation + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-node@v3 + with: + node-version: '18' + - run: npm install --global npm@8 + - run: npm ci + - run: npm run docs + - uses: devops-infra/action-commit-push@v0.9.2 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + commit_prefix: '[DOCS] ' + commit_message: ${{ github.ref_name }} + target_branch: 'master' publish: name: NPM Publish runs-on: ubuntu-latest diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index f5014f5d..85be67c4 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,6 +1,11 @@ name: Test -on: [push] +on: + push: + branches-ignore: + - 'master' + tags-ignore: + - '**' jobs: Test: diff --git a/CHANGELOG.md b/CHANGELOG.md index 26ae71bf..d7845a2e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ## [Unreleased] +### Added + +- CI job for building docs + ## [4.1.0] - 2023-08-29 ### Added diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c974eaf2..25c1c169 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,10 +30,10 @@ This code base is written in [TypeScript](https://www.typescriptlang.org/) so it ## Release Process -1. Checkout `main` +1. Checkout `master` ``` - git checkout main + git checkout master ``` 1. Get the latest code diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 6665b885..1d247503 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -2,7 +2,7 @@ ## Requirements -- [Node.js](https://nodejs.org/) 12.0 or newer +- [Node.js](https://nodejs.org/) 16.0 or newer - NPM 8.0 or newer ## Installation diff --git a/package-lock.json b/package-lock.json index 9a7051ec..64a146b0 100644 --- a/package-lock.json +++ b/package-lock.json @@ -10,7 +10,7 @@ "license": "GPL-3.0-only", "devDependencies": { "@microsoft/eslint-plugin-sdl": "^0.2.0", - "@oneblink/release-cli": "^2.0.2", + "@oneblink/release-cli": "^2.0.3", "@oneblink/types": "github:oneblink/types", "@types/jest": "^29.5.0", "@typescript-eslint/eslint-plugin": "^5.58.0", @@ -1631,9 +1631,9 @@ } }, "node_modules/@oneblink/release-cli": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/@oneblink/release-cli/-/release-cli-2.0.2.tgz", - "integrity": "sha512-WQ2+vjG1oV3/YBzNL7+/tD1Xt9kgje1hc044cn+9F6rZMjZdZOQZePVOuR4DRCJEc9Dqe4MX/qPRMfAZ1IkcSg==", + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/@oneblink/release-cli/-/release-cli-2.0.3.tgz", + "integrity": "sha512-UcRLgccA9RkCyHL0xWkN8eJ5dit1ue6N2f/zgqXnxN4R0r+lD2YMDERIU4Xb9vd411aqWmiIapgax6EJUltPSA==", "bundleDependencies": [ "changelog-parser" ], @@ -12918,9 +12918,9 @@ } }, "@oneblink/release-cli": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/@oneblink/release-cli/-/release-cli-2.0.2.tgz", - "integrity": "sha512-WQ2+vjG1oV3/YBzNL7+/tD1Xt9kgje1hc044cn+9F6rZMjZdZOQZePVOuR4DRCJEc9Dqe4MX/qPRMfAZ1IkcSg==", + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/@oneblink/release-cli/-/release-cli-2.0.3.tgz", + "integrity": "sha512-UcRLgccA9RkCyHL0xWkN8eJ5dit1ue6N2f/zgqXnxN4R0r+lD2YMDERIU4Xb9vd411aqWmiIapgax6EJUltPSA==", "dev": true, "requires": { "changelog-parser": "^2.8.0", diff --git a/package.json b/package.json index 598ae2fc..a7fed773 100644 --- a/package.json +++ b/package.json @@ -8,7 +8,7 @@ }, "devDependencies": { "@microsoft/eslint-plugin-sdl": "^0.2.0", - "@oneblink/release-cli": "^2.0.2", + "@oneblink/release-cli": "^2.0.3", "@oneblink/types": "github:oneblink/types", "@types/jest": "^29.5.0", "@typescript-eslint/eslint-plugin": "^5.58.0", @@ -56,10 +56,10 @@ "format": "prettier --write .", "prepare": "npm run build", "pretest": "npm run fixpack && npm run eslint", - "release": "typedoc && oneblink-release --no-name", + "release": "oneblink-release --no-name", "start": "tsc-watch", "test": "jest", "types": "npm install --save-dev github:oneblink/types", "typescript": "tsc --noEmit" } -} +} \ No newline at end of file