Skip to content

Commit

Permalink
fix formatting and ensure nested bullets are actually nested
Browse files Browse the repository at this point in the history
  • Loading branch information
@dgtized
dgtized committed Jan 21, 2024
1 parent dbab224 commit d976ae8
Showing 1 changed file with 25 additions and 24 deletions.
49 changes: 25 additions & 24 deletions docs/release.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,12 @@ is only enabled on tests as it has too many failures in `src`.
These are run in CI with github actions, but have frequent SEGV flakes, so it's useful to verify locally. See [testing](docs/testing.md) documentation. The minimum to run here is:

```
$ clojure -M:dev:kaocha unit clj-snippets # clj unit and snapshot tests
$ clojure -Mfig:cljs-test # cljs unit tests
$ clojure -M:dev:fig:kaocha cljs-snippets # cljs snapshot tests
# clj unit and snapshot tests
$ clojure -M:dev:kaocha unit clj-snippets
# cljs unit tests
$ clojure -Mfig:cljs-test
# cljs snapshot tests
$ clojure -M:dev:fig:kaocha cljs-snippets
```

## Run manual tests
Expand Down Expand Up @@ -69,27 +72,25 @@ As they use bindings that verify that JOGL is bundled correctly.
## Release Steps

1. Create a new branch for release
1. Update `RELEASE-NOTES.md`, to reflect all the changes which went into the current release (including this PR!)
2. (optional) Consider doing a [snapshot release](https://github.com/quil/quil/actions/workflows/clojars_snapshot_release.yaml), selecting "Run workflow" from branch "master". This will push a snapshot jar to Clojars that can be tested with other projects.
3. Calculate the build version, which incorporates the number of commits to the `master` branch. Either read it from the github UI showing the latest commit, or use `git rev-list master --count` locally. Remember that since there are locally committed changes this number will likely be higher once the commits are pushed to github or the PR is merged, so adjust accordingly. The release should be in form of `v4.3.1234` where `4.3` tracks the upstream processing release version, and `1234` is the build number just calculated.
4. Update Quil version in the `README.md`, for `deps.edn` and Leiningen coordinates, and any other references. Update version in `project.clj`.
5. Push, review, and merge the release PR, making sure the version matches the build count of the merged PR.
6. [tag a release](https://github.com/quil/quil/releases/new) by creating a new tag matching the version above, ie `v4.3.1234`. Select the previous release and use generate release notes and adjust that text for the release. Leave `set as the latest release` checked.
7. Click `Publish release`. The [release action](https://github.com/quil/quil/actions/workflows/clojars_release.yaml) is configured to upload a JAR to Clojars whenever a tag is created starting with `v`. This will upload a jar to Clojars versioned as the release version ie `v4.3.1234`.
8. Monitor the [release action](https://github.com/quil/quil/actions/workflows/clojars_release.yaml) to ensure it completes correctly.
9. Update the lein and deps-new templates to reference the new Clojars release

* https://github.com/quil/quil-templates (requires separate release for clj template)
* https://github.com/quil/sketchbook-template
* https://github.com/quil/clj-sketch-template

10. Update external references to the release version

* https://github.com/quil/quil-examples
* https://github.com/quil/quil/wiki/Runnable-jar

11. (optional) Update quil.info website. Use [generate docs](https://github.com/quil/quil/wiki/Snippets#generate-documention) steps, but requires permission to update the quil-site page.
12. Announce the Quil release on [Clojureverse](https://clojureverse.org/), [r/clojure](https://www.reddit.com/r/Clojure/), and the Clojurians slack (both in #announcements and in #quil). Previously this also included clj-processing and clojure google groups.
2. Update `RELEASE-NOTES.md`, to reflect all the changes which went into the current release (including this PR!)
3. (optional) Consider doing a [snapshot release](https://github.com/quil/quil/actions/workflows/clojars_snapshot_release.yaml), selecting "Run workflow" from branch "master". This will push a snapshot jar to Clojars that can be tested with other projects.
4. Calculate the build version, which incorporates the number of commits to the `master` branch. Either read it from the github UI showing the latest commit, or use `git rev-list master --count` locally. Remember that since there are locally committed changes this number will likely be higher once the commits are pushed to github or the PR is merged, so adjust accordingly. The release should be in form of `v4.3.1234` where `4.3` tracks the upstream processing release version, and `1234` is the build number just calculated.
5. Update Quil version in the `README.md`, for `deps.edn` and Leiningen coordinates, and any other references. Update version in `project.clj`.
6. Push, review, and merge the release PR, making sure the version matches the build count of the merged PR.
7. [tag a release](https://github.com/quil/quil/releases/new) by creating a new tag matching the version above, ie `v4.3.1234`. Select the previous release and use generate release notes and adjust that text for the release. Leave `set as the latest release` checked.
8. Click `Publish release`. The [release action](https://github.com/quil/quil/actions/workflows/clojars_release.yaml) is configured to upload a JAR to Clojars whenever a tag is created starting with `v`. This will upload a jar to Clojars versioned as the release version ie `v4.3.1234`.
9. Monitor the [release action](https://github.com/quil/quil/actions/workflows/clojars_release.yaml) to ensure it completes correctly.
10. Update the lein and deps-new templates to reference the new Clojars release
* https://github.com/quil/quil-templates (requires separate release for clj template)
* https://github.com/quil/sketchbook-template
* https://github.com/quil/clj-sketch-template

11. Update external references to the release version
* https://github.com/quil/quil-examples
* https://github.com/quil/quil/wiki/Runnable-jar

12. (optional) Update quil.info website. Use [generate docs](https://github.com/quil/quil/wiki/Snippets#generate-documention) steps, but requires permission to update the quil-site page.
13. Announce the Quil release on [Clojureverse](https://clojureverse.org/), [r/clojure](https://www.reddit.com/r/Clojure/), and the Clojurians slack (both in #announcements and in #quil). Previously this also included clj-processing and clojure google groups.

### Announcement Template

Expand Down

0 comments on commit d976ae8

Please sign in to comment.