Skip to content

Document package publishing process #127

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
francinelucca merged 1 commit into from
Aug 4, 2026
Merged

Document package publishing process #127

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
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,26 @@ npm install
npm test
```

## Publishing

To publish a new version:

1. Run `npm version <version> --no-git-tag-version` (for example, `npm version 4.10.0 --no-git-tag-version`) to update the version in `package.json` and `package-lock.json`.
2. Open a pull request with the version change and merge it into `main`.
3. Create a GitHub release from `main` with a tag that exactly matches the new version (for example, `4.10.0`).

Creating the release triggers the [Publish workflow](https://github.com/github/tab-container-element/actions/workflows/publish.yml), which tests the tagged commit and publishes the package to npm automatically.

### Publishing manually

To publish an existing version tag manually:

1. Open the [Publish workflow](https://github.com/github/tab-container-element/actions/workflows/publish.yml).
2. Select **Run workflow**.
3. Enter the existing version tag to publish and run the workflow.

The manual workflow run validates and checks out the tag before testing and publishing it to npm.

## License

Distributed under the MIT license. See LICENSE for details.
Loading