Skip to content

Commit ac4b049

Browse files
committed
Fix doc for Google Space instead of Slack
* Bring back Slack action as commented block in the `spring-finalize-release.yml` as an example * Clean up `dependabot.yml` for readability
1 parent 5092049 commit ac4b049

File tree

3 files changed

+22
-10
lines changed

3 files changed

+22
-10
lines changed

.github/dependabot.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
version: 2
22
updates:
3-
- package-ecosystem: "github-actions"
4-
directory: "/"
3+
- package-ecosystem: github-actions
4+
directory: /
55
schedule:
6-
interval: "weekly"
7-
day: "sunday"
6+
interval: weekly
7+
day: sunday

.github/workflows/spring-finalize-release.yml

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,4 +70,16 @@ jobs:
7070
message: "${{ github.event.repository.name }}-announcing `${{ env.MILESTONE }}`"
7171
gchat_webhook_url: ${{ secrets.SPRING_RELEASE_CHAT_WEBHOOK_URL }}
7272
env:
73-
CHAT_WEBHOOK_URL: ${{ secrets.SPRING_RELEASE_CHAT_WEBHOOK_URL }}
73+
CHAT_WEBHOOK_URL: ${{ secrets.SPRING_RELEASE_CHAT_WEBHOOK_URL }}
74+
75+
# - name: Announce Release on Slack
76+
# uses: slackapi/[email protected]
77+
# if: env.SLACK_WEBHOOK_URL
78+
# env:
79+
# SLACK_WEBHOOK_URL: ${{ secrets.SPRING_RELEASE_SLACK_WEBHOOK_URL }}
80+
# SLACK_WEBHOOK_TYPE: INCOMING_WEBHOOK
81+
# with:
82+
# payload: |
83+
# {
84+
# "text": "${{ github.event.repository.name }}-announcing `${{ env.MILESTONE }}`"
85+
# }

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ GRADLE_ENTERPRISE_SECRET_ACCESS_KEY
1313
JF_ARTIFACTORY_SPRING
1414
ARTIFACTORY_USERNAME
1515
ARTIFACTORY_PASSWORD
16-
SPRING_RELEASE_SLACK_WEBHOOK_URL
16+
SPRING_RELEASE_CHAT_WEBHOOK_URL
1717
OSSRH_URL
1818
OSSRH_S01_TOKEN_USERNAME
1919
OSSRH_S01_TOKEN_PASSWORD
@@ -23,7 +23,7 @@ GPG_PRIVATE_KEY
2323
```
2424

2525
The Gradle Enterprise secrets are optional: not used by Maven and Gradle project might not be enrolled for the service.
26-
The `SPRING_RELEASE_SLACK_WEBHOOK_URL` secret is also optional: probably you don't want to notify Slack about your release, or it is not available for GitHub organization.
26+
The `SPRING_RELEASE_CHAT_WEBHOOK_URL` secret is also optional: probably you don't want to notify Google Space about your release, or it is not available for GitHub organization.
2727

2828
The mentioned secrets must be passed explicitly since these reusable workflows might be in different GitHub org than target project.
2929

@@ -44,7 +44,7 @@ https://github.com/spring-io/spring-github-workflows/blob/78b29123a17655f019d800
4444
You can add more branches to react for pull request events.
4545

4646
The SNAPSHOT workflows ([spring-artifactory-gradle-snapshot.yml](.github/workflows/spring-artifactory-gradle-snapshot.yml) and [spring-artifactory-maven-snapshot.yml](.github/workflows/spring-artifactory-maven-snapshot.yml), respectively) are also that simple.
47-
They use JFrog Artifactory plugin to be able to publish artifacts into `libs-snapshot-local` repository.
47+
They use JFrog Artifactory plugin to be able to publish artifacts into `libs-snapshot-local` (by default) repository.
4848
The Gradle workflow can be supplied with Gradle Enterprise secrets.
4949

5050
#### Gradle SNAPSHOT caller workflow:
@@ -75,10 +75,10 @@ The composite internal [extract-release-version](.github/actions/extract-release
7575
- Call Maven or Gradle (according to the workflow choice for the project in the repository) with the release version extracted from the previous job.
7676
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
7777
- The next job is to [verify staged artifacts](#verify-staged-artifacts)
78-
- When verification is successful, next job promotes release from staging either to `libs-milestone-local` or `libs-release-local`(and Maven Central) according to the releasing version schema
78+
- When verification is successful, next job promotes release from staging either to `libs-milestone-local` or `libs-release-local` (by default) (and Maven Central) according to the releasing version schema
7979
- 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.
8080
The `gh release create` command is performed on a tag for just released version.
81-
And in the end the milestone is closed and specific Slack channel is notified about release (if `SPRING_RELEASE_SLACK_WEBHOOK_URL` secret is present in the repository).
81+
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).
8282

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

0 commit comments

Comments
 (0)