Skip to content

Commit

Permalink
Snapshot release 0.2.22 # 2 (#512)
Browse files Browse the repository at this point in the history
* Removed Anieri as sponsor. Thank you for the time you sponsored Polylith!
* Simplify how we set the version in the doc, when making a release.
* 0.2.22-SNAPSHOT # 2
  • Loading branch information
tengstrand authored Sep 29, 2024
1 parent 27877e5 commit e249197
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 25 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
(def minor 2)
(def patch 22)
(def revision SNAPSHOT) ;; Set to SNAPSHOT or RELEASE.
(def snapshot 1) ;; Increase by one for every snapshot release, or set to 0 if a release.
(def snapshot 2) ;; Increase by one for every snapshot release, or set to 0 if a release.
;; Also update :snapshot-version: at the top of readme.adoc.
(def snapshot? (= SNAPSHOT revision))

Expand All @@ -37,7 +37,7 @@

(def tool (if system/extended? "polyx" "poly"))

(def date "2024-08-23")
(def date "2024-09-29")

;; Execute 'poly doc page:versions' to see when different changes was introduced.
(def api-version {:breaking 1, :non-breaking 0})
Expand Down
36 changes: 18 additions & 18 deletions doc/developing-poly.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -467,9 +467,9 @@ Make a `0.2.20-SNAPSHOT #34` release:
- https://github.com/polyfy/polylith/blob/87aeb2ce093f31449827fb19d189e4ad0f80859d/components/version/src/polylith/clj/core/version/interface.clj#L28[snapshot] is set to `34`.
- https://github.com/polyfy/polylith/blob/87aeb2ce093f31449827fb19d189e4ad0f80859d/components/version/src/polylith/clj/core/version/interface.clj#L40[date] is set to today's date (yyyy-mm-dd).
2. Ensure the versions are correctly specified in `readme.adoc`:
- https://github.com/polyfy/polylith/blob/87aeb2ce093f31449827fb19d189e4ad0f80859d/readme.adoc?plain=1#L2[snapshot-version] is set to `34`.
- https://github.com/polyfy/polylith/blob/87aeb2ce093f31449827fb19d189e4ad0f80859d/readme.adoc?plain=1#L5[stable] version is set to current stable version, `0.2.19`.
- https://github.com/polyfy/polylith/blob/87aeb2ce093f31449827fb19d189e4ad0f80859d/readme.adoc?plain=1#L7[snapshot] version is set to `0.2.20-SNAPSHOT`.
- `:snapshot-number:` is set to `34`.
- `:snapshot-version:` is set to `0.2.20`.
- `:stable-version:` is set to `0.2.19`.
3. Verify that we have included everything in https://github.com/polyfy/polylith/blob/master/next-release.md[next-release.md].
4. Commit and push your changes.
5. Go to the https://github.com/polyfy/polylith[polylith repo] and prepare to merge the `snapshot-022034` branch into `master`, by clicking the "Compare & pull requests" button at the top.
Expand Down Expand Up @@ -515,29 +515,29 @@ Make a `0.2.20` release:
- https://github.com/polyfy/polylith/blob/87aeb2ce093f31449827fb19d189e4ad0f80859d/components/version/src/polylith/clj/core/version/interface.clj#L28[snapshot] is set to `0`.
- https://github.com/polyfy/polylith/blob/87aeb2ce093f31449827fb19d189e4ad0f80859d/components/version/src/polylith/clj/core/version/interface.clj#L40[date] is set to today's date (yyyy-mm-dd).
4. Ensure the versions are correctly specified in `readme.adoc`:
- https://github.com/polyfy/polylith/blob/87aeb2ce093f31449827fb19d189e4ad0f80859d/readme.adoc?plain=1#L2[snapshot-version] is set to `0`.
- https://github.com/polyfy/polylith/blob/87aeb2ce093f31449827fb19d189e4ad0f80859d/readme.adoc?plain=1#L5[stable] version is set to current stable version, `0.2.20`.
- https://github.com/polyfy/polylith/blob/87aeb2ce093f31449827fb19d189e4ad0f80859d/readme.adoc?plain=1#L7[snapshot] version is set to `0.2.20-SNAPSHOT`.
5. Update the doc and its navigation:
- `:snapshot-number:` is set to `0`.
- `:stable-version:` is set to `0.2.20`.
5. Ensure that `readme.adoc` lists the correct sponsors by cross-checking it against the https://github.com/sponsors/polyfy/dashboard/your_sponsors[actual] sponsors.
6. Update the doc and its navigation:
- If a page has been added to the link:../doc[doc] directory, also add it to link:/{docdir}/cljdoc.edn[cljdoc.edn] and execute https://github.com/polyfy/polylith/blob/205210dee83c7837be9546e12aa08707eecdd919/bases/nav-generator/src/polylith/clj/core/nav_generator/main.clj#L30[this] function to generate the doc navigation.
- If a xref:blog-posts[blog post], xref:videos[video] or xref:high-level[high-level doc] page has been added, then update link:../components/doc/src/polylith/clj/core/doc/navigation/more.clj[more.clj].
- If any doc content has been added, make sure to update corresponding examples in the doc, e.g. what xref:more[more] outputs.
6. Search for occurrences of `:poly-version:` constants, and set the version to `0.2.20` wherever it appears (at the top of .adoc files).
7. Commit and push your changes.
8. Build a xref:#local-cljdoc[local version] of Cljdoc:
7. Search for occurrences of `:poly-version:` constants, and set the version to `0.2.20` wherever it appears (at the top of .adoc files).
8. Commit and push your changes.
9. Build a xref:#local-cljdoc[local version] of Cljdoc:
- Check that new content looks correct.
- Verify that we have included everything in https://github.com/polyfy/polylith/blob/master/next-release.md[next-release.md].
- Check that the badges at the top and the API at the bottom left are displayed correctly (most namespaces should begin with a `^:no-doc` tag, to exclude them from the API doc).
9. Go to the https://github.com/polyfy/polylith[polylith repo] and prepare to merge the `release-0220` branch into `master`, by clicking the "Compare & pull requests" button at the top.
10. Go to the https://github.com/polyfy/polylith[polylith repo] and prepare to merge the `release-0220` branch into `master`, by clicking the "Compare & pull requests" button at the top.
- Add a comment indicating that this is release 0.2.20.
- If the https://app.circleci.com/pipelines/github/polyfy[circlci pipeline] is green, merge it into the `master` branch.
- Ensure that the https://cljdoc.org/d/polylith/clj-poly/0.2.20/doc/readme[poly-clj] documentation has been built, and verify that the badges at the top and the API at the bottom left are displayed correctly.
10. Update the https://github.com/polyfy/polylith/releases/tag/v0.2.20[release notes] for the 0.2.20 release:
11. Update the https://github.com/polyfy/polylith/releases/tag/v0.2.20[release notes] for the 0.2.20 release:
- Summarize the release in the introduction.
- Copy the content from https://github.com/polyfy/polylith/blob/master/next-release.md[next-release.md] into the release notes.
11. Execute `git switch master` followed by `git pull` to get the latest from master.
12. Execute `git switch -c snapshot-032101` to create a first snapshot branch for the next release (here we imagine that the next release is 0.3.21).
13. Create a `0.3.21-SNAPSHOT #1` release, see xref:#create-a-snapshot-release[make a snapshot release for instructions].
14. Announce in https://clojurians.slack.com/archives/C015AL9QYH1[#releases] in clojurians in Slack, by summarizing the most important changes + the included issues and PRs + add a link to the #polylith channel.
15. Announce on X (Twitter) and maybe other places.
16. Archive the Done column on the https://github.com/orgs/polyfy/projects/1[KanBan board].
12. Execute `git switch master` followed by `git pull` to get the latest from master.
13. Execute `git switch -c snapshot-032101` to create a first snapshot branch for the next release (here we imagine that the next release is 0.3.21).
14. Create a `0.3.21-SNAPSHOT #1` release, see xref:#create-a-snapshot-release[make a snapshot release for instructions].
15. Announce in https://clojurians.slack.com/archives/C015AL9QYH1[#releases] in clojurians in Slack, by summarizing the most important changes + the included issues and PRs + add a link to the #polylith channel.
16. Announce on X (Twitter) and maybe other places.
17. Archive the Done column on the https://github.com/orgs/polyfy/projects/1[KanBan board].
11 changes: 6 additions & 5 deletions readme.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
image::doc/images/logo.png[width=400]
:snapshot-version: 1
:snapshot-number: 2
:snapshot-version: 0.2.22
:stable-version: 0.2.21
:cljdoc-doc-url: https://cljdoc.org/d/polylith/clj-poly/CURRENT/doc

https://cljdoc.org/d/polylith/clj-poly/0.2.21/doc/readme[image:https://badgen.net/badge/doc/0.2.21/blue[]]
ifeval::[{snapshot-version} > 0 && env-cljdoc]
https://cljdoc.org/d/polylith/clj-poly/0.2.22-SNAPSHOT[image:https://badgen.net/badge/doc/0.2.22-SNAPSHOT%20%23{snapshot-version}/cyan[]]
https://cljdoc.org/d/polylith/clj-poly/{stable-version}/doc/readme[image:https://badgen.net/badge/doc/{stable-version}/blue[]]
ifeval::[{snapshot-number} > 0 && env-cljdoc]
https://cljdoc.org/d/polylith/clj-poly/{snapshot-version}-SNAPSHOT[image:https://badgen.net/badge/doc/{snapshot-version}-SNAPSHOT%20%23{snapshot-number}/cyan[]]
endif::[]
https://clojurians.slack.com/messages/C013B7MQHJQ[image:https://badgen.net/badge/slack/join chat/green[]]

Expand Down Expand Up @@ -52,7 +54,6 @@ image:doc/images/sponsors/taehee-sp.png[link=https://github.com/taehee-sp,width=

image:https://avatars.githubusercontent.com/u/18068051[link=https://github.com/yyna,alt="Jungin Kwon",width=32,role="left"]
image:https://avatars.githubusercontent.com/u/59614667[link=https://github.com/fluent-development,alt="Multiply",width=32,role="left"]
image:https://avatars.githubusercontent.com/u/6353427[link=https://github.com/anieri,alt="Anieri",width=32,role="left"]
image:https://avatars.githubusercontent.com/u/53870456[link=https://github.com/john-shaffer,alt="John Shaffer",width=32,role="left"]
image:https://avatars.githubusercontent.com/u/47784846?v=4[link=https://github.com/tlonist-sang,alt="Sanghyun Kim",width=32,role="left"]

Expand Down

0 comments on commit e249197

Please sign in to comment.