Updated the readme.

matrei · matrei · commit b103833a0d32 · 2022-01-18T11:21:23.000+01:00
Pulled in github workflow files from master.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,28 @@
+# This workflow will build a Java project with Gradle and cache/restore any dependencies to improve the workflow execution time
+# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-gradle
+
+name: Build
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK 8
+        uses: actions/setup-java@v2
+        with:
+          java-version: '8'
+          distribution: 'adopt'
+          cache: gradle
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+      - name: Build with Gradle
+        run: ./gradlew build
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,66 @@
+name: Release
+on:
+  release:
+    types: [ published ]
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    env:
+      GIT_USER_NAME: ${{ secrets.GIT_USER_NAME }}
+      GIT_USER_EMAIL: ${{ secrets.GIT_USER_EMAIL }}
+    steps:
+      -   name: Checkout repository
+          uses: actions/checkout@v2
+          with:
+            token: ${{ secrets.GH_TOKEN }}
+      -   uses: gradle/wrapper-validation-action@v1
+      -   name: Set up JDK
+          uses: actions/setup-java@v1
+          with:
+            java-version: 8
+      -   name: Get latest release version number
+          id: get_version
+          uses: battila7/get-version-action@v2
+      -   name: Run pre-release
+          uses: micronaut-projects/github-actions/pre-release@master
+          with:
+            token: ${{ secrets.GITHUB_TOKEN }}
+      -   name: Publish to Sonatype OSSRH
+          env:
+            SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}
+            SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
+            SONATYPE_STAGING_PROFILE_ID: ${{ secrets.SONATYPE_STAGING_PROFILE_ID }}
+            SIGNING_KEY_ID: ${{ secrets.SIGNING_KEY_ID }}
+            SIGNING_PASSPHRASE: ${{ secrets.SIGNING_PASSPHRASE }}
+            SECRING_FILE: ${{ secrets.SECRING_FILE }}
+            RELEASE_VERSION: ${{ steps.get_version.outputs.version-without-v }}
+          run: |
+            echo "${SECRING_FILE}" | base64 -d > "${GITHUB_WORKSPACE}/secring.gpg"
+            echo "Publishing Artifacts for $RELEASE_VERSION"
+            (set -x; ./gradlew -Pversion="${RELEASE_VERSION}" -Psigning.secretKeyRingFile="${GITHUB_WORKSPACE}/secring.gpg" publishToSonatype closeAndReleaseSonatypeStagingRepository --no-daemon)
+      -   name: Bump patch version by one
+          uses: actions-ecosystem/action-bump-semver@v1
+          id: bump_semver
+          with:
+            current_version: ${{steps.get_version.outputs.version-without-v }}
+            level: patch
+      -   name: Set version in gradle.properties
+          env:
+            NEXT_VERSION: ${{ steps.bump_semver.outputs.new_version }}
+          run: |
+            echo "Preparing next snapshot"
+            ./gradlew snapshotVersion -Pversion="${NEXT_VERSION}"
+      -   name: Commit & Push changes
+          uses: actions-js/push@master
+          with:
+            github_token: ${{ secrets.GITHUB_TOKEN }}
+            author_name: ${{ secrets.GIT_USER_NAME }}
+            author_email: $${ secrets.GIT_USER_EMAIL }}
+            message: 'Set version to next SNAPSHOT'
+      -   name: Export Gradle Properties
+          uses: micronaut-projects/github-actions/export-gradle-properties@master
+      -   name: Run post-release
+          if: success()
+          uses: micronaut-projects/github-actions/post-release@master
+          with:
+            token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml
@@ -0,0 +1,23 @@
+name: Mark stale issues and pull requests
+
+on:
+  schedule:
+    - cron: '00 06 * * 1'
+
+jobs:
+  stale:
+
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+
+    steps:
+      - uses: actions/stale@v3
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          stale-issue-message: 'This issue looks like it is stale and therefor it is in risk of being closed with no further action.'
+          stale-pr-message: 'This pull request looks like it is stale and therefor it is in risk of being closed with no further action.'
+          stale-issue-label: 'no-issue-activity'
+          stale-pr-label: 'no-pr-activity'
+          days-before-stale: 180
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 The Grails Asynchronous Mail plugin
 ====================================
 
-[![Build Status](https://travis-ci.org/kefirfromperm/grails-asynchronous-mail.svg?branch=master)](https://travis-ci.org/kefirfromperm/grails-asynchronous-mail) [![Download](https://api.bintray.com/packages/kefirsf/plugins/asynchronous-mail/images/download.svg) ](https://bintray.com/kefirsf/plugins/asynchronous-mail/_latestVersion) [![OpenHUB](https://openhub.net/p/grails-asynchronous-mail/widgets/project_thin_badge?format=gif)](https://openhub.net/p/grails-asynchronous-mail)
+[![Build](https://github.com/gpc/grails-asynchronous-mail/actions/workflows/build.yml/badge.svg)](https://github.com/gpc/grails-asynchronous-mail/actions/workflows/build.yml)
 
 Description
 -----------
@@ -11,23 +11,23 @@ database with Grails domain classes and sends them by a scheduled Quartz job. Ma
 the `sendAsynchronousMail` (or `sendMail`) method returning instantly, is not waiting for the mail to be actually sent. If
 the SMTP server isn't available, or other errors occur, the plugin can be set to retry later.
 
-The plugin depends on the [quartz](https://grails.org/plugins.html#plugin/quartz) and the [mail](https://grails.org/plugins.html#plugin/mail) plugins. You also need a persistence provider plugin, [hibernate5](https://plugins.grails.org/plugin/grails/hibernate5) and [mongodb](https://plugins.grails.org/plugin/grails/mongodb) are supported.
+The plugin depends on the [quartz](https://plugins.grails.org/plugin/grails/quartz) and the [mail](https://plugins.grails.org/plugin/grails/mail) plugins. You also need a persistence provider plugin, [hibernate5](https://plugins.grails.org/plugin/grails/hibernate5) (or the appropriate version of hibernate for previous grails versions) and [mongodb](https://plugins.grails.org/plugin/grails/mongodb) are supported.
 
 Links
 -----
 
-* The plugin page: <https://plugins.grails.org/plugin/kefirsf/asynchronous-mail>
-* The VCS repository (GitHub): <https://github.com/kefirfromperm/grails-asynchronous-mail>
-* The issue tracker (GitHub): <https://github.com/kefirfromperm/grails-asynchronous-mail/issues>
-* The repository package (BinTray): <https://bintray.com/kefirsf/plugins/asynchronous-mail/>
-* The page at OpenHUB: <https://www.openhub.net/p/grails-asynchronous-mail>
+* The plugin page: <https://plugins.grails.org/plugin/grails/asynchronous-mail>
+* The VCS repository (GitHub): <https://github.com/gpc/grails-asynchronous-mail>
+* The issue tracker (GitHub): <https://github.com/gpc/grails-asynchronous-mail/issues>
 
 Installation
 ------------
 
-To install just add the plugin to the plugins block of `build.gradle`. For Grails 4.0.x
+To install just add the plugin to the plugins block of `build.gradle`:
+
+For grails 4.0.x
 ```groovy
-compile "org.grails.plugins:asynchronous-mail:3.0.0"
+compile "io.github.gpc:asynchronous-mail:3.0.0"
 ```
 
 For Grails 3.3.x
@@ -60,7 +60,7 @@ asynchronous.mail.newSessionOnImmediateSend=false
 asynchronous.mail.taskPoolSize=1
 ```
 
-If you want to change this options just add options which you want to change to your configuration file `/grails-app/conf/application.groovy`.
+If you want to change this options just add options which you want to change to your configuration file `/grails-app/conf/application.groovy` or `/grails-app/conf/application.yml`.
 
 |Option|Default|Description|
 |------|-------|-----------|
@@ -108,22 +108,22 @@ Next, change your sendMail call.
 asyncMailService.sendMail {
     // Mail parameters
     to 'john.smith@example.com'
-    subject 'Test';
-    html '<body><u>Test</u></body>';
-    attachBytes 'test.txt', 'text/plain', byteBuffer;
+    subject 'Test'
+    html '<body><u>Test</u></body>'
+    attachBytes 'test.txt', 'text/plain', byteBuffer
 
     // Additional asynchronous parameters (optional)
     beginDate new Date(System.currentTimeMillis()+60000)    // Starts after one minute, default current date
     endDate new Date(System.currentTimeMillis()+3600000)   // Must be sent in one hour, default infinity
-    maxAttemptsCount 3;   // Max 3 attempts to send, default 1
-    attemptInterval 300000;    // Minimum five minutes between attempts, default 300000 ms
-    delete true;    // Marks the message for deleting after sent
-    immediate true;    // Run the send job after the message was created
-    priority 10;   // If priority is greater then message will be sent faster
+    maxAttemptsCount 3   // Max 3 attempts to send, default 1
+    attemptInterval 300000    // Minimum five minutes between attempts, default 300000 ms
+    delete true    // Marks the message for deleting after sent
+    immediate true    // Run the send job after the message was created
+    priority 10   // If priority is greater then message will be sent faster
 }
 ```
 
-Also see the sample application at <https://github.com/kefirfromperm/grails-asynchronous-mail-sample>.
+Also see the sample application at <https://github.com/kefirfromperm/grails-asynchronous-mail-sample> (Grails 3).
 
 The AsynchronousMailController and views
 ----------------------------------------
@@ -139,45 +139,31 @@ Logging
 
 To enable full logging for the plugin just add the following lines to `/grails-app/conf/logback.groovy`.
 ```groovy
-...
+//...
 // Enable Asynchronous Mail plugin logging
 logger('grails.app.jobs.grails.plugin.asyncmail', TRACE, ['STDOUT'])
 logger('grails.app.services.grails.plugin.asyncmail', TRACE, ['STDOUT'])
 logger('grails.plugin.asyncmail', TRACE, ['STDOUT'])
 
 // Enable Quartz plugin logging
 logger('grails.plugins.quartz', DEBUG, ['STDOUT'])
-...
+//...
 ```
 
 Indexes
 -------
 
-I recommend to create an index on the `async_mail_mess.status` column. It's result of my heuristic observations. Only DBA have to create indexes anyway.
+A recommendation is to create an index on the `async_mail_mess.status` column. It's result of my heuristic observations. Only DBA have to create indexes anyway.
 
 Issue tracking
 --------------
 
-You can report bugs on [GitHub](https://github.com/kefirfromperm/grails-asynchronous-mail/issues?state=open).
-You also can ask me questions by email [kefirfromperm@gmail.com](mailto:kefirfromperm@gmail.com).
+You can report bugs on [GitHub](https://github.com/gpc/grails-asynchronous-mail/issues?state=open).
+You also can ask questions in the [Grails Community Slack Channels](https://slack.grails.org/).
 Please enable logs and attach them to your issue.
 
-Please review this project at [OpenHUB](https://www.openhub.net/p/grails-asynchronous-mail).
-
 Contribution
 ------------
 
 If you want to contribute to the plugin just open a pull request to the repository
-<https://github.com/kefirfromperm/grails-asynchronous-mail>.
-
-Unit tests are very very sweet things. They help us to find bugs and to modify code without adding new bugs. It's very
-interesting to see how they work. I like to see how they work. What is better than unit tests? More unit tests!
-Unit tests are good!
-
-And comments... Comments are good also. They are not as good as unit tests but they are definitely good. If you known
-Chinese or Arabic it's good. Seriously. It's awesome! But I don't speak them. So write comments in English.
-
-Donation
---------
-
-If you want to give me a beer just send some money to <https://www.paypal.me/kefir>
+<https://github.com/gpc/grails-asynchronous-mail>.
