Browse Source

Update RELEASING.md with the latest.

Flynn 1 month ago
parent
commit
31f4f6987d
No account linked to committer's email address
1 changed files with 23 additions and 8 deletions
  1. 23
    8
      RELEASING.md

+ 23
- 8
RELEASING.md View File

@@ -17,21 +17,30 @@ If you're still reading, you must be at Datawire. Congrats, you picked a fine pl
17 17
 
18 18
 4. The RC build will be available as e.g. `quay.io/datawire/ambassador:0.77.0-rc1` and also as e.g. `quay.io/datawire/ambassador:0.77.0-rc-latest`. Any other testing you want to do against this image, rock on.
19 19
 
20
-5. When you're happy with everything, sync up the docs!
20
+5. When you're happy that the RC is ready for GA, **first** assemble the list of changes that you'll put into CHANGELOG.md:
21
+   - We always call out things contributed by the community, including who committed it
22
+     - you can mention the contributor with a link back to their GitHub page
23
+   - We always call out features and major bugfixes
24
+   - We always include links to GitHub issues where we can
25
+   - We rarely include fixes to the tests, build infrastructure, etc.
26
+
27
+6. Once the change list is assembled, hand it to Marketing so they can either write a blog post or tell you it's not needed.
28
+
29
+6. While the blog post is being written, sync up the docs!
21 30
    - `make pull-docs` to pull updates from the docs repo
22 31
    - Handle conflicts as needed.
23 32
    - Commit any conflict-resolution changes to `master`.
24 33
 
25
-6. After the docs are synced, use `make release-prep` to update `CHANGELOG.md` and `docs/versions.yml`.
34
+7. After the docs are synced, use `make release-prep` to update `CHANGELOG.md` and `docs/versions.yml`.
26 35
    - It will _commit_, but not _push_, the updated files. Make sure the diffs it shows you look correct!
27 36
    - Do a manual `git push` to update the world with your new files.
28 37
    - It is *critical* to update `docs/versions.yml` so that everyone gets the new version.
29 38
 
30
-7. Now for the time-critical bit.
39
+8. Now for the time-critical bit.
31 40
    - Tag `master` with a GA tag like `v0.77.0` and let CI do its thing. **This version tag must start with a 'v'.**
32 41
    - CI will retag the latest RC image as the GA image.
33 42
 
34
-8. _After the CI run finishes_:
43
+9. _After the CI run finishes_:
35 44
    - `make push-docs` _after the retag_ to push new docs out to the website.
36 45
    - Go to https://github.com/datawire/ambassador/releases and create a new release.
37 46
       - `make release-prep` should've output the text to paste into the release description.
@@ -40,7 +49,7 @@ If you're still reading, you must be at Datawire. Congrats, you picked a fine pl
40 49
 
41 50
    **Note also** that even though the version _tag_ starts with a 'v', the version _number_ displayed by the diag UI will _not_ start with a 'v'.**
42 51
 
43
-9. Submit a PR into the `helm/charts` repo to update things in `stable/ambassador`. You may be able to ask Support to do this, but if not:
52
+10. Submit a PR into the `helm/charts` repo to update things in `stable/ambassador`:
44 53
    - in `Chart.yaml`, update `appVersion` with the new Ambassador version, and bump `version`.
45 54
    - in `README.md`, update the default value of `image.tag`.
46 55
    - in `values.yaml`, update `tag`.
@@ -57,6 +66,12 @@ If you're still reading, you must be at Datawire. Congrats, you picked a fine pl
57 66
       - open a PR
58 67
     - Once your PR is merged, _delete the feature branch without merging it back to origin/master_.
59 68
 
60
-10. Additional updates, which you may be able to ask Marketing to do:
61
-   - Submit a PR to https://github.com/datawire/pro-ref-arch that updates the `env.sh.example` versions.
62
-   - Submit a PR to the Ambassador website repository to update the version on the homepage.
69
+11. Update the getambassador.io website by submitting a PR to the `datawire/getambassador.io` repo.
70
+   - `src/releaseInfo.js` is the only file you should need to touch:
71
+      - `ReleaseType` comes from Marketing, usually "Feature Release", "Maintenance Release", or "Security Update"
72
+      - `CurrentVersion` is e.g. "0.78.0" -- no leading 'v' here
73
+      - `BlogLink` is the full URL of the blog post (from Marketing), or "" if there is no blog post
74
+   - Make your edits, submit a PR, get it merged. Done.
75
+      - If you want to test before submitting, use `npm install && npm start` and point a web browser to `localhost:8000`
76
+
77
+   Submit a PR to the Ambassador website repository to update the version on the homepage.

Loading…
Cancel
Save