Skip to content

Commit eebfad3

Browse files
committed
docs: update release instructions and readme badges
1 parent 3985b3b commit eebfad3

File tree

4 files changed

+41
-13
lines changed

4 files changed

+41
-13
lines changed

.github/workflows/npm-publish.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
22
# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
33

4-
name: upload-npm
4+
name: Publish to npm
55

66
on:
77
release:

.github/workflows/test.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
# - https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow
66
# - https://help.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions
77

8-
name: test
8+
name: Test
99

1010
on:
1111
- push

README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
# [configurable-http-proxy](https://github.com/jupyterhub/configurable-http-proxy)
22

3-
[![TravisCI Build status](https://img.shields.io/travis/com/jupyterhub/configurable-http-proxy?logo=travis)](https://travis-ci.com/jupyterhub/configurable-http-proxy)
4-
[![Docker Build status](https://img.shields.io/docker/build/jupyterhub/configurable-http-proxy?logo=docker&label=build)](https://hub.docker.com/r/jupyterhub/configurable-http-proxy/tags)
53
[![npm](https://img.shields.io/npm/v/configurable-http-proxy.svg?logo=npm)](https://www.npmjs.com/package/configurable-http-proxy)
4+
[![Docker Build status](https://img.shields.io/docker/cloud/build/jupyterhub/configurable-http-proxy?logo=docker&label=build)](https://hub.docker.com/r/jupyterhub/configurable-http-proxy/tags)
5+
[![GitHub Workflow Status - Test](https://img.shields.io/github/workflow/status/jupyterhub/configurable-http-proxy/Test%20chart?logo=github&label=tests)](https://github.com/jupyterhub/configurable-http-proxy/actions)
6+
[![GitHub](https://img.shields.io/badge/issue_tracking-github-blue?logo=github)](https://github.com/jupyterhub/configurable-http-proxy/issues)
7+
[![Discourse](https://img.shields.io/badge/help_forum-discourse-blue?logo=discourse)](https://discourse.jupyter.org/c/jupyterhub/z2jh-k8s)
8+
[![Gitter](https://img.shields.io/badge/social_chat-gitter-blue?logo=gitter)](https://gitter.im/jupyterhub/jupyterhub)
69

710
**configurable-http-proxy** (CHP) provides you with a way to update and manage
811
a proxy table using a command line interface or REST API.

RELEASE.md

+34-9
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ repository as is configured
1010

1111
To make a tagged release follow the instructions below, but first make sure you
1212
meet the prerequisites:
13-
- To be a collaborator of the [npmjs
14-
project](https://www.npmjs.com/package/configurable-http-proxy).
1513
- To have push rights to the [configurable-http-proxy GitHub
1614
repository](https://github.com/jupyterhub/configurable-http-proxy).
1715
- To have [`bump2version`](https://github.com/c4urself/bump2version) installed
@@ -49,13 +47,6 @@ meet the prerequisites:
4947
git diff HEAD~1
5048
```
5149

52-
1. Publish to NPM.
53-
54-
```bash
55-
npm login
56-
npm publish
57-
```
58-
5950
1. Reset the version to the next development version with `bump2version`.
6051

6152
```bash
@@ -71,3 +62,37 @@ meet the prerequisites:
7162
```
7263
git push --follow-tags $ORIGIN master
7364
```
65+
66+
1. Visit [GitHub: create new
67+
release](https://github.com/jupyterhub/configurable-http-proxy/releases/new)
68+
and reference your tag.
69+
70+
This will trigger a workflow to publish the NPM package.
71+
72+
1. Verify [the automated
73+
workflow](https://github.com/jupyterhub/configurable-http-proxy/actions?query=workflow%3Aupload-npm)
74+
succeeded.
75+
76+
## Manual release to npm
77+
78+
1. Verify you are a collaborator of the [npmjs
79+
project](https://www.npmjs.com/package/configurable-http-proxy).
80+
81+
1. Checkout the git tag.
82+
83+
```
84+
git checkout <tag>
85+
```
86+
87+
1. Cleanup old node_modules etc.
88+
89+
```
90+
git clean -xfd
91+
```
92+
93+
1. Publish to NPM.
94+
95+
```bash
96+
npm login
97+
npm publish
98+
```

0 commit comments

Comments
 (0)