Skip to content

docs: update docs to reflect newest publish workflow #16

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

Merged
merged 1 commit into from
Dec 22, 2022
Merged

docs: update docs to reflect newest publish workflow #16

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
9 changes: 1 addition & 8 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,4 @@ We use `jest` tests as well, which should be an equally comfortable development

## Publishing

To publish, merge your work to main (after PR process completed).

Manage version and publish on a new branch, and create a PR to merge these changes into main.

```bash
npm version [major|minor|patch] # alternatively, manage version in package.json
npm run publish
```
The [publish.yml workflow](https://github.com/github/markdownlint-github/actions/workflows/publish.yml) will automatically publish a new release on npm upon creating a [new GitHub release](https://github.com/github/markdownlint-github/releases).