Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update RELEASE_PROCEDURE.md #2719

Merged
merged 2 commits into from
Nov 29, 2023
Merged

Update RELEASE_PROCEDURE.md #2719

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d8d7df
Update RELEASE_PROCEDURE.md
JuditKnoll Nov 28, 2023
69bc65d
Update RELEASE_PROCEDURE.md
JuditKnoll Nov 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 8 additions & 10 deletions RELEASE_PROCEDURE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,31 +11,29 @@ When you release fixed version of SpotBugs, please follow these procedures.
## Release to Maven Central

When we push a tag, the build result on GitHub Actions will be deployed to the [SonaType Nexus](https://oss.sonatype.org/), and published to the Maven Central automatically by [Gradle Nexus Publish Plugin](https://github.com/gradle-nexus/publish-plugin). Then we can find [artifacts in the Maven Central](https://repo1.maven.org/maven2/com/github/spotbugs/) after several hours.
See the `build` phase in `.github/workflows/release.yml` calling the `publishToSonatype` and `closeSonatypeStagingRepository` gradle tasks.

## Release to Eclipse Update Site

It's automated by Github CI.
It's automated by GitHub CI.

When we push tag, the build result will be deployed to [eclipse-candidate repository](https://github.com/spotbugs/eclipse-candidate).
When we push tag and its name doesn't contain `_RC`, the build result will be deployed to [eclipse repository](https://github.com/spotbugs/eclipse).

See `deploy` phase in `.github/workflows/release.yml` for detail.
See `Deploy eclipse`, `Deploy eclipse-candidate` and `Deploy eclipse-latest` phases in `.github/workflows/release.yml` for detail.

## Release to Eclipse Marketplace

Update version in [Eclipse Marketplace page](https://marketplace.eclipse.org/content/spotbugs-eclipse-plugin). If you have no permission, please contact with @KengoTODA or @iloveeclipse.

## Release to Gradle Plugin Portal
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this part is done by the spotbugs-gradle-plugin, but I'm not sure. Can someone please verify it?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes that is the gradle plugin, it releases far more frequently.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mean this project, spotbugs/spotbugs does not release anything to the gradle plugin portal, neither manually or automatically, right? I found com.github.spotbugs at the gradle plugin portal, but this is the one released by the spotbugs-gradle-plugin.
However, this project does release to the maven portal, but the maven plugin itself is released by the spotbugs-maven-plugin.
If this is true, I will modify the release procedure file to reflect this.


No action necessary. When we push tag, the build result on Github CI will be deployed to Gradle Plugin Portal.

See `deploy` phase in `.github/workflows/release.yml` for detail.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no deploy phase in .github/workflows/release.yml, so this one is definitely not true. There was one in the travis.yml earlier.


## Update installation manual
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This part was modified in #451. There is no need to modify anything in connection with this.


`docs/installing.rst` includes link to released binaries, update them.
It is also necessary to change filename in command line example.
No action necessary. When we push tag, the build result on GitHub CI will be deployed to Gradle Plugin Portal.

## Release to ReadTheDocs

See [docs/README.md](docs/README.md) for detail.

## Update the Changelog at GitHub Release

The `CHANGELOG` on the [GitHub release page](https://github.com/spotbugs/spotbugs/releases) only contains a link to the correct version of the `CHANGELOG.md` file (see `createReleaseBody` task in `build.gradle`). It needs to be manually updated after the new GitHub release is created.