Skip to content

docs: update RELEASE.md with publishing workflow#890

Open
chmjkb wants to merge 1 commit intomainfrom
@chmjkb/add-oidc-publishing-docs
Open

docs: update RELEASE.md with publishing workflow#890
chmjkb wants to merge 1 commit intomainfrom
@chmjkb/add-oidc-publishing-docs

Conversation

@chmjkb
Copy link
Collaborator

@chmjkb chmjkb commented Feb 27, 2026

Description

Introduces a breaking change?

  • Yes
  • No

Type of change

  • Bug fix (change which fixes an issue)
  • New feature (change which adds functionality)
  • Documentation update (improves or adds clarity to existing documentation)
  • Other (chores, tests, code style improvements etc.)

Tested on

  • iOS
  • Android

Testing instructions

Screenshots

Related issues

Checklist

  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have updated the documentation accordingly
  • My changes generate no new warnings

Additional notes

@chmjkb chmjkb requested a review from msluszniak February 27, 2026 19:18
@chmjkb chmjkb marked this pull request as ready for review February 27, 2026 19:18
2. Once the PR is merged, `cherry-pick` the commit to the release branch.
3. Bump version in `package.json` to the new version `v{MAJOR}.{MINOR}.{REVISION}`.
Commit with a message 'Release v{MAJOR}.{MINOR}.0'.
4. Tag release branch with proper version tag `v{MAJOR}.{MINOR}.{REVISION}` and run `npm publish`.
Copy link
Member

@msluszniak msluszniak Feb 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same mention about workflow should go here


The release process of new minor version consists of the following steps:

1. Bump version in `package.json` to the new version `v{MAJOR}.{MINOR}.0`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bumping package.json should be done after merging and publishing the current version, so it shouldn't be placed as the first step, right?


1. Create a PR to the main branch.
2. Once the PR is merged, `cherry-pick` the commit to the release branch.
3. Bump version in `package.json` to the new version `v{MAJOR}.{MINOR}.{REVISION}`.
Copy link
Member

@msluszniak msluszniak Feb 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this commit should not go directly from release branch, but rather goes from private branch into release branch via PR, so we can review these changes before merging into release branch.

2. Once the PR is merged, `cherry-pick` the commit to the release branch.
3. Bump version in `package.json` to the new version `v{MAJOR}.{MINOR}.{REVISION}`.
Commit with a message 'Release v{MAJOR}.{MINOR}.0'.
4. Tag release branch with proper version tag `v{MAJOR}.{MINOR}.{REVISION}` and run `npm publish`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
4. Tag release branch with proper version tag, namely: `git tag v{MAJOR}.{MINOR}.{REVISION} && git push origin v{MAJOR}.{MINOR}.{REVISION}` and run `npm publish`.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we shouldnt run npm publish

Copy link
Member

@msluszniak msluszniak Feb 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't updated this npm publish here since my very first comment from this review addresses it :) But yes

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Im not sure which comment you're refering to

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants