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.

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

Rename release profile #133

Merged
merged 6 commits into from
May 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Releasing Sisu

## Maven

Note: Build uses latest `maven-gpg-plugin` and is getting rid "old bad practices" of storing sensitive information in
any Maven configuration file. Hence, on Workstations, users are recommended to have GPG Agent set up and running,
as plugin will make use of it to get the sensitive information. On unattended releases, the use of
BouncyCastle signer is recommended, and use environment variables `MAVEN_GPG_KEY` and `MAVEN_GPG_PASSPHRASE`
to pass over the key material and the passphrase to `maven-gpg-plugin`.
See [maven-gpg-plugin site](https://maven.apache.org/plugins/maven-gpg-plugin/usage.html) for more information.

### Release steps

The "usual" Maven release:
* `mvn release:prepare`
* `mvn release:perform`
* project uses https://oss.sonatype.org/ to stage (manual step: close and release staging repository)

## Site

TBD
2 changes: 1 addition & 1 deletion org.eclipse.sisu.inject/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -456,7 +456,7 @@

<profiles>
<profile>
<id>sonatype-oss-release</id>
<id>sisu-release</id>
Copy link
Contributor

Choose a reason for hiding this comment

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

Why not the default profile name release?

Copy link
Member Author

Choose a reason for hiding this comment

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

As it may conflict with out of the box profile, and as you see, release plugin explicitly disables it.

Copy link
Member Author

@cstamas cstamas May 30, 2024

Choose a reason for hiding this comment

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

Also, the release profile used by project was not "default" anyway, this PR does not change in this respect, just shortens its name (and aligns it, with other "release profiles" like apache-release or takari-release etc).

Copy link
Contributor

Choose a reason for hiding this comment

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

I still don't get why we need a project-specific prefix. I like to have the same profile name across all projects, therefore I usually pick release. But as it always has been used with some prefix I am fine with keeping it.

<build>
<plugins>
<plugin>
Expand Down
4 changes: 2 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -434,7 +434,7 @@ Bundle-DocURL: http://www.eclipse.org/sisu/
<configuration>
<mavenExecutorId>forked-path</mavenExecutorId>
<useReleaseProfile>false</useReleaseProfile>
<arguments>-Psonatype-oss-release</arguments>
<arguments>-Psisu-release</arguments>
<localCheckout>true</localCheckout>
<pushChanges>false</pushChanges>
<scmCommentPrefix>|</scmCommentPrefix>
Expand Down Expand Up @@ -572,7 +572,7 @@ Bundle-DocURL: http://www.eclipse.org/sisu/
</build>
</profile>
<profile>
<id>sonatype-oss-release</id>
<id>sisu-release</id>
<build>
<plugins>
<plugin>
Expand Down