From 5e851ce7d3ad4e4473fb4782ebfecb6b1290bd81 Mon Sep 17 00:00:00 2001 From: Saihajpreet Singh Date: Tue, 3 Dec 2024 18:25:31 +0000 Subject: [PATCH] chore: update release instructions --- .github/workflows/release.yml | 17 ----------------- CONTRIBUTING.md | 6 ++++++ 2 files changed, 6 insertions(+), 17 deletions(-) delete mode 100644 .github/workflows/release.yml diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index 641a92a..0000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,17 +0,0 @@ -name: Release - -on: - push: - branches: - - "main" - -jobs: - release: - name: Release - uses: the-guild-org/shared-config/.github/workflows/release-stable.yml@main - with: - releaseScript: release - nodeVersion: 16 - secrets: - githubToken: ${{ secrets.GITHUB_TOKEN }} - npmToken: ${{ secrets.NPM_TOKEN }} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9e4afcc..7a71476 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,6 +20,12 @@ We actively welcome your pull requests for documentation and code. 7. Run `yarn changeset` and describe the change you're proposing. Commit the file it creates in `.changeset` to the repo. [You can read more about changeset here.](https://github.com/changesets/changesets) 8. Open a Pull Request so we can review and incorporate your change. +## Releases + +To release a new version: +1. Run `yarn changeset version` to bump the version of the package. +2. Run `yarn release` this will create a new release on GitHub and publish the package to NPM. + ## Issues We use GitHub issues to track public bugs. Please ensure your description is