Skip to content

Commit 5042fd3

Browse files
committed
Document spring-website-project-version-update action
* Fix `README` for actual `spring-find-release-version` reusable workflow
1 parent e162746 commit 5042fd3

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,16 +68,18 @@ Otherwise, release workflow will be cancelled with a warning that nothing to rel
6868
The logic of this release workflow:
6969

7070
- Take a SNAPSHOT version from a dispatched branch (Maven `help:evaluate -Dexpression="project.version"` and Gradle `gradle properties | grep "^version:"`, respectively).
71-
The composite internal [extract-release-version](.github/actions/extract-release-version/action.yml) action is implemented for this goal
72-
- List GitHub milestones matching the candidate version and select the closest one by due on date
71+
- List GitHub milestones matching the candidate version and select the closest one by due on date.
72+
(The [spring-find-release-version](.github/workflows/spring-find-release-version.yml) reusable workflow is implemented for this goal)
7373
- Cancel workflow if no scheduled Milestone
7474
- Call Maven or Gradle (according to the workflow choice for the project in the repository) with the release version extracted from the previous job.
7575
This job stages released artifacts using JFrog Artifactory plugin into `libs-staging-local` repository on Spring Artifactory and commits `Next development version` to the branch we are releasing against
7676
- The next job is to [verify staged artifacts](#verify-staged-artifacts)
7777
- When verification is successful, next job promotes release from staging either to `libs-milestone-local` or `libs-release-local` (by default) (and optional to Maven Central: if `OSSRH_STAGING_PROFILE_NAME` secret is provided) according to the releasing version schema
78-
- Then [spring-finalize-release.yml](.github/workflows/spring-finalize-release.yml) job is executed, which generates release notes using [Spring Changelog Generator](https://github.com/spring-io/github-changelog-generator) excluding repository admins from `Contributors` section.
78+
- Then [spring-finalize-release.yml](.github/workflows/spring-finalize-release.yml) job is executed, which tags release into GitHub, commits next development version, generates release notes using [Spring Changelog Generator](https://github.com/spring-io/github-changelog-generator) excluding repository admins from `Contributors` section.
7979
The `gh release create` command is performed on a tag for just released version.
80-
And in the end the milestone is closed and specific Google Space is notified about release (if `SPRING_RELEASE_CHAT_WEBHOOK_URL` secret is present in the repository).
80+
Then spring.io project page is updated for newly released version.
81+
(The [spring-website-project-version-update](.github/actions/spring-website-project-version-update) local action is implemented for this goal).
82+
And in the end the milestone closed and specific Google Space notified about release (if `SPRING_RELEASE_CHAT_WEBHOOK_URL` secret is present in the repository).
8183

8284
#### Example of Release caller workflow:
8385
https://github.com/spring-io/spring-github-workflows/blob/78b29123a17655f019d800690cc906d692f836a9/samples/release.yml#L1-L25

0 commit comments

Comments
 (0)