-
Notifications
You must be signed in to change notification settings - Fork 378
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
Add the steps for safety in the release procedure #1195
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1195 +/- ##
=======================================
Coverage 72.22% 72.22%
=======================================
Files 17 17
Lines 1433 1433
Branches 430 430
=======================================
Hits 1035 1035
Misses 322 322
Partials 76 76 Continue to review full report at Codecov.
|
@@ -4,10 +4,11 @@ | |||
|
|||
# build products | |||
/dist | |||
*.tgz |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
npm pack
generates tgz files
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ooooof, good catch.
+1000000 on automating publishing via CI. Most other open source projects I work on do automated releasing when a git tag
is pushed up to the GitHub repository. I am happy to assist with that!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for adding these precautionary steps to the maintainer's guides. It is new to me that npm link
might screw with the package generated, but it does make a lot of sense (TIL).
+1 to automated release management and I'd be interested in learning what it takes to set it up. I don't know if there's enough work involved to go around @filmaj but happy to help out in this effort!
Co-authored-by: Fil Maj <maj.fil@gmail.com>
Summary
This is related to #1194
As you may notice, version 3.8.0 did not go well. The published package file included only
package.json
and a few text files.To deal with the situation, I went with the following actions:
npm pack
in the local machine and found that the generated file is still invalidpackage.json
and build-related files since v3.7.0 but there are no related changesnpm pack
after deletingdist
andnode_modules
directoriesnpm publish
with a new patch version (3.8.1)@slack/bolt@3.8.1
in an example app project and confirmed that the issue no longer existsI am not yet 100% confident about the direct reason of this situation. That being said, I'm guessing that utilizing
npm link
for local development might affect the build process. If this is true, that explains why deleting directories helped.Not to repeat this error in the future, I propose to add a few steps before
npm publish
command. Ideally, we may want to do releases from the CI runtime (at least, somewhere without any person's local environment). But, for now, we can make the current operation safer.Requirements (place an
x
in each[ ]
)