Skip to content

Commit

Permalink
docs(release.sh): add explanation to release script
Browse files Browse the repository at this point in the history
  • Loading branch information
spotify-kai committed Jul 16, 2021
1 parent 9f78685 commit 8ebf914
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions release.sh
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
# This release script determines if a publish should happen using a dry run of semantic release to determine if the
# commits contain publishable changes (feat, bug, breaking change). If so, lerna will be used to perform the actual
# publish, however, lerna also has its own logic for determining whether to publish. Specifically, it will run git diff
# in each package, excluding markdown files, tests, etc. So any attempt to force a version bump with an empty commit or
# readme tweak will fail. To get around this, we pass the `force-publish` option to lerna, skipping the git diff for
# changed packages. This allows the semantic release dry run check to be the deciding factor for publishing.

# this message is logged by semantic-release when one of the commits found by web-scripts should trigger a release
expected_release_message="The release type for the commit is"

Expand Down

0 comments on commit 8ebf914

Please sign in to comment.