Skip to content

Commit 8a80893

Browse files
authored
docs: add reverting a publish section (#329)
Adds publishing and unpublishing section to contributing section with links/steps.
1 parent 5fb44a2 commit 8a80893

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

CONTRIBUTING.md

+20
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,26 @@ npm link
5151

5252
You can then run the Functions Framework locally using `functions-framework`.
5353

54+
## Publishing (Admins only)
55+
56+
This module is published using Release Please. When you merge a release PR, the npm package will be automatically published.
57+
58+
### Reverting a Publish
59+
60+
If the release process fails, you can revert the publish by running the following (i.e. unpublishing `1.10.0`):
61+
62+
```sh
63+
# Login to the Wombat Dressing Room. Create a 24 hour token. Close the window.
64+
npm login --registry https://wombat-dressing-room.appspot.com
65+
# Unpublish the package (must be done within 72 hours of publishing).
66+
# If >72 hours, deprecate a specific release and publish a newer version.
67+
# i.e. `npm deprecate @google-cloud/[email protected] "Deprecate 1.10.0"
68+
# See https://docs.npmjs.com/policies/unpublish#what-to-do-if-your-package-does-not-meet-the-unpublish-criteria
69+
npm unpublish @google-cloud/[email protected]
70+
# Set the default version to the previous working version.
71+
npm dist-tag add @google-cloud/[email protected] latest --registry=https://wombat-dressing-room.appspot.com
72+
```
73+
5474
## Community Guidelines
5575

5676
This project follows [Google's Open Source Community

0 commit comments

Comments
 (0)