Skip to content

Commit 23e845f

Browse files
committed
docs: modernize building and releasing instructions
1 parent bfc3a6e commit 23e845f

1 file changed

Lines changed: 20 additions & 9 deletions

File tree

README.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -132,25 +132,36 @@ job.run();
132132

133133
## Building & Releasing
134134

135-
If you wish to make changes, then building and releasing is simple:
135+
If you wish to make changes, then building and testing is simple:
136136

137137
```bash
138138
# To build
139-
mvn
139+
mvn compile
140140

141141
# To test
142142
mvn test
143143

144-
# To release (pushing jar to maven central)
145-
# (don't forget to set up your ~/.m2/settings.xml)
146-
mvn release:prepare
147-
mvn release:perform
144+
# To test across all supported JDKs (11, 17, 21)
145+
make test
146+
```
147+
148+
### Releasing
149+
150+
Releasing is automated via GitHub Actions. To trigger a release to Maven Central:
148151

149-
# To publish javadoc
150-
git checkout ffmpeg-0.x
151-
mvn clean javadoc:aggregate scm-publish:publish-scm
152+
1. Update the version in `pom.xml` (remove `-SNAPSHOT`).
153+
2. Commit and push the change.
154+
3. Create and push a tag:
155+
```bash
156+
git tag ffmpeg-0.9.0
157+
git push origin ffmpeg-0.9.0
152158
```
153159

160+
The GitHub Action will:
161+
1. Run the full test matrix across all supported JDKs.
162+
2. If successful, sign and publish the artifacts to the Sonatype Central Portal.
163+
3. Create a GitHub Release with automatically generated release notes.
164+
154165
## Bumpings Deps
155166

156167
```bash

0 commit comments

Comments
 (0)