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
4 changes: 2 additions & 2 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ on:
paths:
- 'docs/**'
- 'js/**'
- 'less/**'
- 'sass/**'
- 'Gruntfile.js'
- 'rollup.config.js'
- 'scripts/**'
- 'package.json'
- 'package-lock.json'
- '.github/workflows/deploy-docs.yml'
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/docs_validation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ on:
paths:
- 'docs/**'
- 'js/**'
- 'less/**'
- 'sass/**'
- 'Gruntfile.js'
- 'rollup.config.js'
- 'scripts/**'
- 'package.json'
- 'package-lock.json'
- '.github/workflows/docs_validation.yml'
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/linting.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ jobs:
- name: Install dependencies
run: npm ci
- name: Run lint
run: npx grunt lint
run: npm run lint
2 changes: 1 addition & 1 deletion .github/workflows/playwright.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
- name: Install dependencies
run: npm ci
- name: Build
run: npx grunt build
run: npm run build
- name: Install Playwright browsers
run: npx playwright install --with-deps chromium
- name: Run Playwright tests
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/publish_npm_release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ permissions:
jobs:
publish:
runs-on: ubuntu-latest
name: Publish crestapps-bootstrap-select
name: Publish bootstrap-select
outputs:
version: ${{ steps.release_meta.outputs.version }}
docs_version: ${{ steps.release_meta.outputs.docs_version }}
Expand Down
20 changes: 7 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to crestapps-bootstrap-select
# Contributing to bootstrap-select

Thanks for contributing. This repository contains the vanilla JavaScript
CrestApps fork of `bootstrap-select`, the built distribution artifacts, the
Expand All @@ -8,12 +8,12 @@ changes.
## Project layout

- `js/` - source for the plugin runtime
- `less/` and `sass/` - source stylesheets
- `sass/` - source stylesheets
- `dist/` - generated distributable assets
- `docs/` - Docusaurus docs app and hosted standalone examples
- `tests/` - manual HTML fixtures, helpers, and Playwright e2e coverage

Edit the source files in `js/`, `less/`, `sass/`, or `docs/`. Do not hand-edit
Edit the source files in `js/`, `sass/`, or `docs/`. Do not hand-edit
generated files in `dist/`.

## Before you start
Expand All @@ -22,7 +22,7 @@ generated files in `dist/`.
2. For non-trivial changes, open or reference an issue first so the scope is
clear before implementation starts.
3. For bugs, include the browser, OS, Bootstrap version, and
`crestapps-bootstrap-select` version you tested against.
`@crestapps/bootstrap-select` version you tested against.

## Local setup

Expand All @@ -44,22 +44,16 @@ generated files in `dist/`.

## Build and validation workflow

The project uses Grunt for asset generation and Docusaurus for the docs site.
The project uses Rollup and Sass for asset generation and Docusaurus for the docs site.

- `npm run build` - rebuilds `dist/` from the source files
- `npm run lint` - runs the configured ESLint checks
- `npm test` - runs the Playwright suite
- `npm run docs:prepare` - builds the plugin and copies docs assets into
`docs/static/dist/`
- `npm run docs:start` - prepares the docs assets and starts the local docs site
- `npm run docs:build` - creates a production docs build under `docs/build/`

If you prefer Grunt directly, these tasks remain available:

- `grunt build-css`
- `grunt build-js`
- `grunt copy-docs`
- `grunt dev-watch`
- `npm run docs:build` - creates a production docs build under `docs/.pages-build/`
- `npm run watch` - rebuilds the plugin whenever JS or Sass sources change

## Working on docs

Expand Down
Loading