Skip to content
This repository was archived by the owner on Sep 21, 2021. It is now read-only.

Commit 6cba5f1

Browse files
committed
Fix devtools-reps release documentation
1 parent c63a534 commit 6cba5f1

File tree

1 file changed

+34
-40
lines changed

1 file changed

+34
-40
lines changed

packages/devtools-reps/RELEASE.md

Lines changed: 34 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,47 @@
11
### How to create a new Reps release for mozilla-central.
22

3-
Before you get started, you will need clones of devtools-reps and mozilla-central, as well as
3+
Before you get started, you will need clones of devtools-core and mozilla-central, as well as
44
a Bugzilla account.
55

6-
```
7-
1. Prepare reps release
8-
a. create a release branch on github
9-
b. update minor version in package.json, reset build version:
10-
v0.N.X -> v0.N+1.0
11-
 c. commit `release: bump version to v0.N+1.0`
12-
 d. create a PR on Github for this release
13-
 e. make sure you have a configs/local.json file, with `firefox.mcPath` pointing to your mozilla-central clone
14-
15-
2. Copy to mozilla central
16-
a. update your mozilla-central clone to the latest
17-
 b. in reps, run node bin/copy-assets.js`
18-
 c. create a new bug in Developer Tools: Shared Components [1]
19-
 d. commit 'Bug XXXXXXX - reps v0.N+1.0: update reps bundle from GitHub;r=reviewer'
20-
21-
3. Validate & cleanup
22-
a. push to try, test locally, submit for review etc ...
23-
b. while try fails or some problem is detected, go back to devtools-reps, fix the issue,
24-
create a new bundle and go back to 2.a
25-
c. when everything is fine and the patch is r+, land on autoland/inbound
26-
d. merge the PR on github
27-
e. create a tag for v0.N+1.0 on github
28-
```
29-
30-
After that any issue with the bundle should be addressed with a new build version.
6+
1. **Prepare devtools-reps release**
7+
1. Create a release branch on github
8+
2. Update minor version in package.json, reset build version: devtools-reps-X.N.Y -> devtools-reps-X.N+1.0
9+
3. Commit `release: bump version to devtools-reps-X.N+1.0`
10+
4. Create a PR on Github for this release
11+
5. Make sure you have a `packages/devtools-reps/configs/local.json` file, with `firefox.mcPath` pointing to your mozilla-central clone
12+
13+
2. **Copy to mozilla central**
14+
1. Update your mozilla-central clone to the latest
15+
2. Create a new mercurial bookmark (or a local branch if you use git-cinnabar)
16+
3. Navigate to the reps folder: `cd packages/devtools-reps`
17+
4. And run `yarn copy-assets`
18+
5. Create a new bug in [Developer Tools: Shared Components](https://bugzilla.mozilla.org/enter_bug.cgi?product=Firefox&component=Developer%20Tools%3A%20Shared%20Components)
19+
6. Commit 'Bug XXX - devtools-reps v0.N+1.0: update reps bundle from GitHub;r=reviewer', where XXX is the number of the bug you created in `2.v.`.
20+
21+
3. **Validate & cleanup**
22+
1. Push to try, test locally, submit for review etc ...
23+
2. While try fails or some problem is detected, go back to devtools-reps, fix the issue, create a new bundle and go back to `2.i.`
24+
3. When everything is fine and the patch is r+, land on autoland/inbound
25+
4. Merge the PR on github
26+
5. Create a tag for devtools-reps-X.N+1.0 on github
27+
28+
After that any issue with the bundle should be addressed with a new build version.
3129
Ideally, if the bundle has to be updated in mozilla-central for a bugfix, a corresponding
3230
tag should be created on GitHub.
3331

34-
[1] https://bugzilla.mozilla.org/enter_bug.cgi?product=Firefox&component=Developer%20Tools%3A%20Shared%20Components
35-
36-
3732
### How to publish a new Reps release to npm.
3833

39-
Steps to publish to npm :
40-
```
41-
1. Checkout the latest release tag
42-
a. git fetch --tags # get new tags from remote
43-
b. git checkout tags/v0.N+1.0 # checkout the tag created for the release
44-
2. npm login # Might ask your npm username and password
45-
3. npm publish
46-
```
34+
**Steps to publish to npm** :
35+
36+
1. Get new tags from remote: `git fetch --tags`
37+
2. Checkout the tag created for the release: `git checkout tags/devtools-reps-X.N+1.0`
38+
3. Navigate to the reps folder: `cd packages/devtools-reps`
39+
4. Log in nom (Might ask your npm username and password): `npm login`
40+
5. Publish the package: `npm publish`
4741

48-
To publish a new version of the package on npm, you need to :
42+
To be able to publish a new version of the package on npm, you need to :
4943

50-
1. have an npm account and
51-
2. be a collaborator on the package.
44+
- have an npm account and
45+
- be a collaborator on the package.
5246

5347
If you want to become a collaborator on the Reps package, please ask the other collaborators, either through IRC or Slack, or by filing an issue in this repo.

0 commit comments

Comments
 (0)