Skip to content

Commit 1be7dc2

Browse files
committed
Merge branch 'main' of https://github.com/slackapi/java-slack-sdk into feat-work-objects
2 parents 74cffd4 + e3f79e0 commit 1be7dc2

File tree

3 files changed

+60
-8
lines changed

3 files changed

+60
-8
lines changed

.github/maintainers_guide.md

Lines changed: 37 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,33 @@ By installing App(2) and App(3), you get the followings. Set them as env variabl
7676
|SLACK_SDK_TEST_GRID_SHARED_CHANNEL_ID|A shared channel's ID `SLACK_SDK_TEST_GRID_WORKSPACE_ADMIN_USER_TOKEN` can manage.|
7777
|SLACK_SDK_TEST_EMAIL_ADDRESS|An email address to invite.|
7878

79+
### Installing JAR files locally for development
80+
81+
To use the JAR files from each subproject in your local development environment, you can install them to your local Maven repository:
82+
83+
1. Build and install all modules locally:
84+
* Run `scripts/install_local.sh`
85+
* Note: This command skips running unit tests for faster installation
86+
2. Use in your project:
87+
Once installed locally, you can reference these artifacts in your project's `pom.xml`:
88+
89+
```xml
90+
<dependency>
91+
<groupId>com.slack.api</groupId>
92+
<artifactId>bolt</artifactId>
93+
<version>1.0.1-SNAPSHOT</version>
94+
</dependency>
95+
96+
<dependency>
97+
<groupId>com.slack.api</groupId>
98+
<artifactId>slack-api-client</artifactId>
99+
<version>1.0.1-SNAPSHOT</version>
100+
</dependency>
101+
```
102+
79103
### Generating Documentation
80104

81-
Refer to the [README](https://github.com/slackapi/java-slack-sdk/blob/main/docs/README.md) for details on editing documentation.
105+
Refer to the [README](https://github.com/slackapi/java-slack-sdk/blob/main/docs/README.md) for details on editing documentation.
82106

83107
### Releasing
84108

@@ -88,19 +112,24 @@ Refer to the [README](https://github.com/slackapi/java-slack-sdk/blob/main/docs/
88112
* Make sure you've set up your key https://central.sonatype.org/publish/requirements/gpg/
89113
* Make sure the account you are using has the permission to make releases [under com.slack groupId](https://central.sonatype.com/publishing/com.slack/users)
90114

91-
Place `$HOME/.m2/settings.xml` with your Sonatype account information.
115+
Place `$HOME/.m2/settings.xml` with your Sonatype account information.
92116
* Generate user token: https://central.sonatype.org/publish/generate-portal-token/
93117
* Set the user token id/password: https://central.sonatype.org/publish/publish-portal-maven/#credentials
94118

95119
```xml
96120
<settings>
97121
<localRepository>/${your-home-dir}/.m2/repository</localRepository>
98122
<servers>
99-
<server>
100-
<username>${your-username}</username>
101-
<password>${your-password}</password>
102-
<id>central</id>
103-
</server>
123+
<server>
124+
<id>central</id>
125+
<username>${your-username}</username>
126+
<password>${your-password}</password>
127+
</server>
128+
<server>
129+
<id>central-snapshots</id>
130+
<username>${your-username}</username>
131+
<password>${your-password}</password>
132+
</server>
104133
</servers>
105134
<pluginGroups>
106135
<pluginGroup>org.apache.maven.plugins</pluginGroup>
@@ -116,7 +145,7 @@ To learn more about snapshot releases in maven central repository check out [pub
116145

117146
* From the upstream repository
118147
* Preparation
119-
* `git switch main && git pull origin main`
148+
* `git switch main && git pull origin main` (or the branch you want to release from)
120149
* Make sure there are no build failures at https://github.com/slackapi/java-slack-sdk/actions
121150
* Set a new version
122151
* It is **critical** that the version ends with `-SNAPSHOT`. This is how [central-publishing-maven-plugin](https://central.sonatype.org/publish/publish-portal-snapshots/#publishing-with-the-central-publishing-maven-plugin) automatically recognizes snapshot releases and uploads them the right location.

pom.xml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,19 @@
113113
</repository>
114114
</repositories>
115115

116+
<distributionManagement>
117+
<repository>
118+
<id>central</id>
119+
<name>Sonatype Central Releases</name>
120+
<url>https://central.sonatype.com/repository/maven-releases/</url>
121+
</repository>
122+
<snapshotRepository>
123+
<id>central-snapshots</id>
124+
<name>Sonatype Central Snapshots</name>
125+
<url>https://central.sonatype.com/repository/maven-snapshots/</url>
126+
</snapshotRepository>
127+
</distributionManagement>
128+
116129
<licenses>
117130
<license>
118131
<name>The Apache Software License, Version 2.0</name>

scripts/install_local.sh

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
#!/bin/bash
2+
is_jdk_8=`echo $JAVA_HOME | grep 8.`
3+
is_travis_jdk_8=`echo $TRAVIS_JDK | grep openjdk8`
4+
if [[ "${is_jdk_8}" != "" && "${is_travis_jdk_8}" != "" ]];
5+
then
6+
echo "Please use OpenJDK 11."
7+
exit 1
8+
fi
9+
10+
./mvnw install -Dmaven.test.skip=true

0 commit comments

Comments
 (0)