|
1 | 1 | # @sect/webpack-sweet-entry |
2 | | -[](https://github.com/sectsect/webpack-sweet-entry/actions/workflows/test.yml) [](https://codecov.io/gh/sectsect/webpack-sweet-entry) [](https://github.com/sectsect/webpack-sweet-entry/actions/workflows/github-code-scanning/codeql) |
| 2 | +[](https://github.com/sectsect/webpack-sweet-entry/actions/workflows/release.yml) [](https://codecov.io/gh/sectsect/webpack-sweet-entry) [](https://github.com/sectsect/webpack-sweet-entry/actions/workflows/github-code-scanning/codeql) |
3 | 3 |
|
4 | 4 | Multiple entry points with glob pattern / Ignore files and directories with leading underscore `_` / Preserve directory structure |
5 | 5 |
|
@@ -222,7 +222,50 @@ $ npm install --save-dev @sect/webpack-sweet-entry |
222 | 222 | + const { WebpackSweetEntry } = require('@sect/webpack-sweet-entry'); |
223 | 223 | ``` |
224 | 224 |
|
225 | | -## Changelog |
| 225 | +## Development |
| 226 | +
|
| 227 | +### Making Changes |
| 228 | +
|
| 229 | +When you make a change that should be included in the next release: |
| 230 | +
|
| 231 | +1. Create a feature branch |
| 232 | +2. Make your changes |
| 233 | +3. Add a changeset: `npm run changeset` |
| 234 | + - Select the type of change (patch/minor/major) |
| 235 | + - Provide a description of the change |
| 236 | +4. Commit the changeset file along with your changes |
| 237 | +5. Create a pull request |
| 238 | +
|
| 239 | +### Release Process |
| 240 | +
|
| 241 | +This project uses [changesets](https://github.com/changesets/changesets) for version management and releases. |
| 242 | +
|
| 243 | +**Automated Release Workflow:** |
| 244 | +1. When a PR with changesets is merged to master, a "Version Packages" PR is automatically created |
| 245 | +2. The Version Packages PR includes: |
| 246 | + - Updated version numbers in package.json |
| 247 | + - Updated CHANGELOG.md |
| 248 | + - Removed changeset files |
| 249 | +3. When the Version Packages PR is merged: |
| 250 | + - The package is automatically built |
| 251 | + - Published to npm with provenance |
| 252 | + - A GitHub release is created |
| 253 | +
|
| 254 | +**Manual Testing:** |
| 255 | +```bash |
| 256 | +# Create a test changeset |
| 257 | +npm run changeset |
| 258 | + |
| 259 | +# Preview version bump (without publishing) |
| 260 | +npm run version-packages |
| 261 | + |
| 262 | +# Build and test before release |
| 263 | +npm run build |
| 264 | +npm test |
| 265 | +npm run lint |
| 266 | +``` |
| 267 | +
|
| 268 | +## Changelog |
226 | 269 |
|
227 | 270 | See [CHANGELOG](https://github.com/sectsect/webpack-sweet-entry/blob/master/CHANGELOG.md) file. |
228 | 271 |
|
|
0 commit comments