Skip to content

Commit 55c1269

Browse files
Copilot8enSmith
andcommitted
fix: address PR feedback - remove CHANGELOG.md from gitignore and document required secrets
Co-authored-by: 8enSmith <798183+8enSmith@users.noreply.github.com>
1 parent 322cb6e commit 55c1269

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

.gitignore

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
node_modules/
22
build/
3-
mcp-open-library-*.tgz
4-
CHANGELOG.md
3+
mcp-open-library-*.tgz

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,15 @@ npm test
266266

267267
This project uses [semantic-release](https://semantic-release.gitbook.io/) for automated versioning and publishing. Releases are automatically created when commits are pushed to the `main` branch using [conventional commit messages](https://www.conventionalcommits.org/).
268268

269-
Commit message format:
269+
#### Required Secrets
270+
271+
For the automated release workflow to function, the following secrets must be configured in the GitHub repository:
272+
273+
- `GITHUB_TOKEN` - Automatically provided by GitHub Actions for creating releases and updating the repository
274+
- `NPM_TOKEN` - Required for publishing packages to npm. Generate this token from your npm account with publish permissions
275+
276+
#### Commit Message Format
277+
270278
- `feat:` - new features (triggers minor version bump)
271279
- `fix:` - bug fixes (triggers patch version bump)
272280
- `feat!:` or `fix!:` - breaking changes (triggers major version bump)

0 commit comments

Comments
 (0)