Merge e518b2fd8d into bcfbca5b71

Merge pull request #684 from actions/Jcambass-patch-1
Add workflow file for publishing releases to immutable action package
2024-11-12 04:48:03 +00:00 · 2024-09-16 20:36:59 +02:00 · 2024-09-11 09:54:38 +02:00 · 2024-09-11 09:48:56 +02:00 · 2024-03-13 09:50:09 +01:00 · 2024-03-13 09:45:33 +01:00
2 changed files with 24 additions and 22 deletions
--- a/.github/workflows/publish-immutable-actions.yml
+++ b/.github/workflows/publish-immutable-actions.yml
@ -0,0 +1,22 @@
+name: 'Publish Immutable Action Version'
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+      packages: write
+
+    steps:
+      - name: Checking out
+        uses: actions/checkout@v4
+      - name: Publish
+        id: publish
+        uses: actions/publish-immutable-action@0.0.1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
--- a/docs/advanced-usage.md
+++ b/docs/advanced-usage.md
@ -296,14 +296,13 @@ jobs:
        server-id: maven # Value of the distributionManagement/repository/id field of the pom.xml
        server-username: MAVEN_USERNAME # env variable for username in deploy
        server-password: MAVEN_CENTRAL_TOKEN # env variable for token in deploy
-        gpg-private-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }} # Value of the GPG private key to import
-        gpg-passphrase: MAVEN_GPG_PASSPHRASE # env variable for GPG private key passphrase

    - name: Publish to Apache Maven Central
-      run: mvn deploy
+      run: mvn deploy -Dgpg.signer=bc
      env:
        MAVEN_USERNAME: maven_username123
        MAVEN_CENTRAL_TOKEN: ${{ secrets.MAVEN_CENTRAL_TOKEN }}
+        MAVEN_GPG_KEY: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }}
        MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }}
 ```

@ -339,10 +338,6 @@ The two `settings.xml` files created from the above example look like the follow
      <username>${env.MAVEN_USERNAME}</username>
      <password>${env.MAVEN_CENTRAL_TOKEN}</password>
    </server>
-    <server>
-      <id>gpg.passphrase</id>
-      <passphrase>${env.MAVEN_GPG_PASSPHRASE}</passphrase>
-    </server>
  </servers>
 </settings>
 ```
@ -351,21 +346,6 @@ The two `settings.xml` files created from the above example look like the follow

 If you don't want to overwrite the `settings.xml` file, you can set `overwrite-settings: false`

-### Extra setup for pom.xml:
-
-The Maven GPG Plugin configuration in the pom.xml file should contain the following structure to avoid possible issues like `Inappropriate ioctl for device` or `gpg: signing failed: No such file or directory`:
-
-```xml
-<configuration>
-  <!-- Prevent gpg from using pinentry programs -->
-  <gpgArguments>
-    <arg>--pinentry-mode</arg>
-    <arg>loopback</arg>
-  </gpgArguments>
-</configuration>
-```
-GPG 2.1 requires `--pinentry-mode` to be set to `loopback` in order to pick up the `gpg.passphrase` value defined in Maven `settings.xml`.
-
 ### GPG

 If `gpg-private-key` input is provided, the private key will be written to a file in the runner's temp directory, the private key file will be imported into the GPG keychain, and then the file will be promptly removed before proceeding with the rest of the setup process. A cleanup step will remove the imported private key from the GPG keychain after the job completes regardless of the job status. This ensures that the private key is no longer accessible on self-hosted runners and cannot "leak" between jobs (hosted runners are always clean instances).
Author	SHA1	Message	Date
Antonin Delpeuch	45e37e51c1	Merge `e518b2fd8d` into `bcfbca5b71`	2024-09-16 20:36:59 +02:00
Joel Ambass	bcfbca5b71	Merge pull request #684 from actions/Jcambass-patch-1 Add workflow file for publishing releases to immutable action package	2024-09-11 09:54:38 +02:00
Joel Ambass	78eae7945c	Add workflow file for publishing releases to immutable action package This workflow file publishes new action releases to the immutable action package of the same name as this repo. This is part of the Immutable Actions project which is not yet fully released to the public. First party actions like this one are part of our initial testing of this feature.	2024-09-11 09:48:56 +02:00
Antonin Delpeuch	e518b2fd8d	Remove unnecessary comment	2024-03-13 09:50:09 +01:00
Antonin Delpeuch	58d36cecb0	Update recommended configuration for GPG signing This attempts to document the new recommended configuration to sign artifacts with the maven-gpg-plugin as part of the deploy process. It imitates this PR from the maintainer of the maven-gpg-plugin: https://github.com/xerial/sqlite-jdbc/pull/1082/files Notes that this requires the maven-gpg-plugin version 3.2.0 or above, not sure if this is worth adding to the documentation as I expect this guide will mostly be followed by people setting up a new project (hopefully using the latest version of the plugin by default). @cstamas I hope I got it right, feel free to suggest any improvements	2024-03-13 09:45:33 +01:00