Skip to content

Commit fba5827

Browse files
committed
docs: add publishing instructions for automated releases using GitHub Actions
This update to the README.md includes a new section detailing the steps to publish new versions of the package using GitHub Actions. The instructions outline the process for creating a release, including tagging and verifying the published version on npm. This addition enhances the documentation for contributors and maintainers.
1 parent 1f79139 commit fba5827

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -321,6 +321,24 @@ The subscription string that Redis will receive will be `comments.added.graphql-
321321
This subscription string is much more specific and means the the filtering required for this type of subscription is not needed anymore.
322322
This is one step towards lifting the load off of the GraphQL API server regarding subscriptions.
323323

324+
## Publishing New Versions
325+
326+
This package uses GitHub Actions for automated publishing. To publish a new version:
327+
328+
1. Go to the GitHub repository
329+
2. Click "Releases" in the right sidebar
330+
3. Click "Draft a new release"
331+
4. Choose or create a new tag (e.g., v2.7.1)
332+
5. Fill in the release title and description
333+
6. Click "Publish release"
334+
335+
The GitHub Action will automatically:
336+
- Run tests
337+
- Build the package
338+
- Publish to npm with provenance
339+
340+
You can verify the published version on [npm](https://www.npmjs.com/package/graphql-redis-subscriptions).
341+
324342
## Tests
325343

326344
### Spin a Redis in docker server and cluster

0 commit comments

Comments
 (0)