Skip to content
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.

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

Make an NPM release via GitHub #2942

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Make an NPM release via GitHub #2942

wants to merge 10 commits into from

Conversation

PurpShell
Copy link
Sponsor Collaborator

PR Details

Description

Related Issue

Motivation and Context

How Has This Been Tested

Types of changes

  • Dependency change
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My code follows the code style of this project.
  • I have updated the documentation accordingly (index.d.ts).

Copy link
Owner

@pedroslopez pedroslopez left a comment

Choose a reason for hiding this comment

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

Thanks!

From what I remember, I believe the GitHub release should respect the prerelease flag marked in the output here to make the release correctly

Copy link
Owner

@pedroslopez pedroslopez left a comment

Choose a reason for hiding this comment

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

Ah! I forgot something - another thing that happens as part of the mainline release process is docs generation.

There's a script that does this, npm run generate-docs

This should happen only for main releases, after the version bump (so the docs contain the right version) but before the version is tagged

Comment on lines 69 to +71
npm version $VERSION_ARGS || exit 1

npm run generate-docs
Copy link
Owner

Choose a reason for hiding this comment

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

this still won't be included as part of the commit.

npm version creates a commit and tag:

If run in a git repo, it will also create a version commit and tag. This behavior is controlled by git-tag-version (see below), and can be disabled on the command line by running npm --no-git-tag-version version. It will fail if the working directory is not clean, unless the -f or --force flag is set.

So the docs generation is outside of the bump commit.

To keep this simple, we might be able to just do the docs generation after the git push, and commit/push that separately. It won't be included as part of the tag, but at least we can move forward with this PR and unlock the functionality.

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.

None yet

4 participants