Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(release): separate docs search index generation #1884

Merged
merged 1 commit into from
Sep 7, 2024
Merged

fix(release): separate docs search index generation #1884

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion .github/workflows/dco.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
if:
(github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the
DCO document and I hereby sign the DCO.') || github.event_name == 'pull_request_target'
uses: contributor-assistant/github-action@v2.4.0
uses: contributor-assistant/github-action@v2.5.0
env:
GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
PERSONAL_ACCESS_TOKEN: ${{ secrets.DCO_PERSONAL_ACCESS_TOKEN }}
Expand Down
41 changes: 18 additions & 23 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ on:
push:
branches:
- master

jobs:
build:
if: github.actor != 'carbon-bot' && !startsWith(github.event.head_commit.message, 'skip-release')
name: Create release - Node.js v20.17.0
name: Create release
runs-on: ubuntu-latest

steps:
Expand All @@ -16,44 +17,38 @@ jobs:
with:
token: ${{ secrets.GH_TOKEN }}

- name: Use Node.js 20.17.0
- name: Set git user to carbon-bot
run: |
git config --global user.email "carbon@us.ibm.com"
git config --global user.name "carbon-bot"
Comment on lines +20 to +23
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved these up closer to the checkout.


- name: Use Node.js 20.x LTS
uses: actions/setup-node@v4
with:
node-version: '20.17.0'
node-version: '20.x'
cache: 'yarn'
registry-url: 'https://registry.npmjs.org/'
always-auth: true
auth-token: ${{ secrets.NPM_TOKEN }}
Comment on lines +28 to +32
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Eliminate need for explicit minor versions, set yarn cache and npmjs authentication here instead of below.


- name: Install dependencies 🔧
run: yarn install --immutable --check-cache

- name: Set git user and get git into the right state
run: |
git config --global user.email "carbon@us.ibm.com"
git config --global user.name "carbon-bot"
git checkout master
- name: Generate search index for docs website
run: lerna run build:search --scope @carbon/charts-docs # should be committed in next step
Comment on lines +37 to +38
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Separated this from docs package build.


- name: Create version and change logs
- name: Create version and change logs and commit to master
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As this commits the new version numbers to master, it can also commit the rebuilt search index for the docs website.

env:
GH_TOKEN: ${{ secrets.GH_TOKEN }}
run: npx lerna version --yes --force-publish --conventional-commits --create-release github

- name: Rebuild packages and documentation 🔧
- name: Build latest version's packages (including angular/dist) 🔧
run: |
yarn build
node scripts/update-angular-dependency-version.mjs

- name: Commit and push changes (if there are any)
run: |
git add .
if ! git diff-index --quiet HEAD; then
git commit -m "skip-release - chore(build): updated search index for docs"
git push origin master
fi
env:
GH_TOKEN: ${{ secrets.GH_TOKEN }}

- name: Publish to npmjs registry and Github
run: |
npm config set //registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }} -q
npx lerna publish from-git --yes --force-publish
Comment on lines -43 to -56
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Already handled above.

run: npx lerna publish from-git --yes --force-publish

- name: Deploy documentation to Github Pages 🚀
uses: JamesIves/github-pages-deploy-action@v4
Expand Down
14 changes: 7 additions & 7 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,19 @@
"@commitlint/cli": "^19.4.1",
"@commitlint/config-conventional": "^19.4.1",
"@eslint/compat": "^1.1.1",
"@eslint/js": "^9.9.1",
"@playwright/test": "^1.46.1",
"@types/node": "^22.5.2",
"@eslint/js": "^9.10.0",
"@playwright/test": "^1.47.0",
"@types/node": "^22.5.4",
"@vue/eslint-config-prettier": "^9.0.0",
"@vue/eslint-config-typescript": "^13.0.0",
"eslint": "^9.9.1",
"eslint": "^9.10.0",
"eslint-config-prettier": "^9.1.0",
"eslint-plugin-jsdoc": "^50.2.2",
"eslint-plugin-prettier": "^5.2.1",
"eslint-plugin-react": "^7.35.0",
"eslint-plugin-react": "^7.35.2",
"eslint-plugin-react-hooks": "next",
"eslint-plugin-svelte": "^2.43.0",
"eslint-plugin-vue": "^9.27.0",
"eslint-plugin-vue": "^9.28.0",
"globals": "^15.9.0",
"husky": "^9.1.5",
"lerna": "^8.1.8",
Expand All @@ -46,7 +46,7 @@
"svelte": "^4.2.19",
"svelte-eslint-parser": "^0.41.0",
"typescript": "^5.5.4",
"typescript-eslint": "^8.3.0",
"typescript-eslint": "^8.4.0",
"vue-eslint-parser": "^9.4.3"
},
"release": {
Expand Down
22 changes: 11 additions & 11 deletions packages/angular/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,23 +32,23 @@
"tslib": "^2.7.0"
},
"devDependencies": {
"@angular-devkit/build-angular": "^18.2.2",
"@angular/cli": "^18.2.2",
"@angular/common": "^18.2.2",
"@angular/compiler": "^18.2.2",
"@angular/compiler-cli": "^18.2.2",
"@angular/core": "^18.2.2",
"@angular/platform-browser": "^18.2.2",
"@angular/platform-browser-dynamic": "^18.2.2",
"@angular-devkit/build-angular": "^18.2.3",
"@angular/cli": "^18.2.3",
"@angular/common": "^18.2.3",
"@angular/compiler": "^18.2.3",
"@angular/compiler-cli": "^18.2.3",
"@angular/core": "^18.2.3",
"@angular/platform-browser": "^18.2.3",
"@angular/platform-browser-dynamic": "^18.2.3",
"@carbon/icons": "^11.48.0",
"@playwright/test": "^1.46.1",
"@playwright/test": "^1.47.0",
"angular-eslint": "^18.3.0",
"concurrently": "^8.2.2",
"eslint": "^9.9.1",
"eslint": "^9.10.0",
"ng-packagr": "^18.2.1",
"prettier": "^3.3.3",
"typescript": "~5.5.4",
"typescript-eslint": "^8.3.0",
"typescript-eslint": "^8.4.0",
"zone.js": "~0.15.0"
},
"publishConfig": {
Expand Down
12 changes: 6 additions & 6 deletions packages/core/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,22 +93,22 @@
"@carbon/layout": "^11.25.0",
"@carbon/styles": "^1.64.0",
"@carbon/themes": "^11.39.0",
"@playwright/test": "^1.46.1",
"@playwright/test": "^1.47.0",
"@rollup/plugin-replace": "^5.0.7",
"@types/dompurify": "^3.0.5",
"@types/lodash-es": "^4.17.12",
"@types/node": "^22.5.2",
"@types/node": "^22.5.4",
"concurrently": "^8.2.2",
"downlevel-dts": "^0.11.0",
"eslint": "^9.9.1",
"eslint": "^9.10.0",
"jsdom": "^25.0.0",
"prettier": "^3.3.3",
"publint": "^0.2.10",
"resize-observer-polyfill": "^1.5.1",
"sass": "^1.77.8",
"sass": "^1.78.0",
"typescript": "^5.5.4",
"vite": "^5.4.2",
"vite-plugin-dts": "^4.1.0",
"vite": "^5.4.3",
"vite-plugin-dts": "^4.1.1",
"vitest": "^2.0.5"
},
"publishConfig": {
Expand Down
10 changes: 5 additions & 5 deletions packages/docs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
"build:search": "node generateSearchIndex.mjs",
"build:netlify-dp": "vite build --emptyOutDir --outDir dist && typedoc --tsconfig ../core/tsconfig.json ../core/src/index.ts --out dist/api",
"files:pages": "touch ../../pages/.nojekyll && echo 'charts.carbondesignsystem.com' > ../../pages/CNAME",
"build": "yarn build:search && yarn build:docs && yarn files:pages && yarn build:api:docs",
"dev": "vite --port 3000",
"build": "yarn build:docs && yarn files:pages && yarn build:api:docs",
"dev": "yarn build:search && vite --port 3000",
Comment on lines -16 to +17
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed building of search index from docs package build. Ensure index is rebuilt before previewing site.

"lint": "eslint",
"format": "prettier . --write --ignore-path ../../.prettierignore"
},
Expand All @@ -36,13 +36,13 @@
"@types/react-dom": "^18.3.0",
"@types/topojson-specification": "^1.0.5",
"@vitejs/plugin-react-swc": "^3.7.0",
"eslint": "^9.9.1",
"eslint": "^9.10.0",
"jsdom": "^25.0.0",
"prettier": "^3.3.3",
"sass": "^1.77.8",
"sass": "^1.78.0",
"typedoc": "^0.26.6",
"typescript": "^5.5.4",
"vite": "^5.4.2"
"vite": "^5.4.3"
},
"publishConfig": {
"access": "restricted"
Expand Down
8 changes: 4 additions & 4 deletions packages/react/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,20 +47,20 @@
"react-dom": "^16.8.6 || ^17.0.1 || ^18.2.0"
},
"devDependencies": {
"@playwright/test": "^1.46.1",
"@playwright/test": "^1.47.0",
"@types/react": "^18.3.5",
"@types/react-dom": "^18.3.0",
"@vitejs/plugin-react-swc": "^3.7.0",
"classnames": "^2.5.1",
"concurrently": "^8.2.2",
"downlevel-dts": "^0.11.0",
"eslint": "^9.9.1",
"eslint": "^9.10.0",
"prettier": "^3.3.3",
"react": "^18.3.1",
"react-dom": "^18.3.1",
"typescript": "^5.5.4",
"vite": "^5.4.2",
"vite-plugin-dts": "^4.1.0"
"vite": "^5.4.3",
"vite-plugin-dts": "^4.1.1"
},
"publishConfig": {
"access": "public"
Expand Down
10 changes: 5 additions & 5 deletions packages/svelte/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,19 +40,19 @@
"@ibm/telemetry-js": "^1.6.1"
},
"devDependencies": {
"@playwright/test": "^1.46.1",
"@playwright/test": "^1.47.0",
"@sveltejs/adapter-static": "^3.0.4",
"@sveltejs/kit": "^2.5.25",
"@sveltejs/kit": "^2.5.26",
"@sveltejs/package": "^2.3.4",
"@sveltejs/vite-plugin-svelte": "^3.1.2",
"eslint": "^9.9.1",
"eslint": "^9.10.0",
"prettier": "^3.3.3",
"publint": "^0.2.10",
"svelte": "^4.2.19",
"svelte-check": "^4.0.0",
"svelte-check": "^4.0.1",
"tslib": "^2.7.0",
"typescript": "^5.5.4",
"vite": "^5.4.2"
"vite": "^5.4.3"
},
"publishConfig": {
"access": "public"
Expand Down
12 changes: 6 additions & 6 deletions packages/vue/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,15 @@
"@ibm/telemetry-js": "^1.6.1"
},
"devDependencies": {
"@playwright/test": "^1.46.1",
"@playwright/test": "^1.47.0",
"@vitejs/plugin-vue": "^5.1.3",
"eslint": "^9.9.1",
"eslint": "^9.10.0",
"prettier": "^3.3.3",
"typescript": "^5.5.4",
"vite": "^5.4.2",
"vite-plugin-dts": "^4.1.0",
"vue": "^3.4.38",
"vue-tsc": "^2.1.4"
"vite": "^5.4.3",
"vite-plugin-dts": "^4.1.1",
"vue": "^3.5.3",
"vue-tsc": "^2.1.6"
},
"publishConfig": {
"access": "public",
Expand Down
Loading
Loading