Merge pull request #5 from maxkratz/feature/prepare-first-release

Prepare first release (v1.0.0): documentation, version number, license, etc.

Author: maxkratz

.github/workflows/build-ci.yml

@@ -57,10 +57,6 @@ jobs:
         uses: docker/setup-qemu-action@v3
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
-      # - name: Download executable JAR
-      #     uses: actions/download-artifact@v4
-      #     with:
-      #       name: release-to-issue-jar-with-dependencies.jar
 
       # Build Docker image
       - name: Build Docker image

LICENSE

@@ -1 +1,50 @@
 # Release to issue GitHub Action
+
+[![Build CI](https://github.com/maxkratz/release-to-issue-docker-action/actions/workflows/build-ci.yml/badge.svg)](https://github.com/maxkratz/release-to-issue-docker-action/actions/workflows/build-ci.yml)
+
+This GitHub Action can be used to automatically check a GitHub repository for new releases and, in case a new release was found, automatically open a new issue in a third repository.
+The newly created issue contains a link to the release, a link to the tag, and a nice title mentioning the repositories name as well as the version.
+This GitHub Action also assignes a user and the tag `enhancement` to the newly created issue.
+
+## Inputs
+
+- `source-repo`: Which repo to check for new releases
+    - Required: yes
+- `target-repo`: Which repo to create new issues in
+    - Required: yes
+- `start-date`: Date limit to ignore older releases
+    - Required: yes
+- `assignee-name`: Which GitHub user should be assigned to newly created issues
+    - Required: yes
+- `github-username`: Which GitHub user should be used to query the GitHub API
+    - Required: yes
+- `github-token`: Which GitHub token should be used to query the GitHub API
+    - Required: yes
+- `dry-run`: If true, the Action will not create any issues but just simulate them
+    - Required: no
+
+## Outputs
+
+None.
+
+## Example usage
+
+- Create a new classic access token in your GitHub preferences.
+- Inside your GitHub repository (that will use this Action) create a new secret `USER_TOKEN` that contains your access token.
+- Add the following snippet to your GitHub Actions configuration file:
+
+```
+uses: maxkratz/[email protected]
+with:
+    source-repo: 'lectureStudio/lectureStudio'  # the repo that should be checked for new releases
+    target-repo: 'maxkratz/github-api-testing'  # the repo in which you want to open an issue
+    start-date: '2023-01-01'                    # all releases older than this date will be ignored
+    assignee-name: 'maxkratz'                   # can be different than your username
+    github-username: 'maxkratz'                 # your username (in whose name the issues will be opened)
+    github-token: ${{ secrets.USER_TOKEN }}     # your secret GitHub access token
+    dry-run: false                              # if set to true, no actual issues will be opened
+```
+
+## License
+
+This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for more details.

README.md

@@ -7,7 +7,7 @@ inputs:
     required: true
     default: 'maxkratz/release-to-issue-docker-action'
   target-repo:
-    description: 'Which repo to check for new releases'
+    description: 'Which repo to create new issues in'
     required: true
   start-date:
     description: 'Date limit to ignore older releases'

action.yml

@@ -5,7 +5,7 @@
 
     <groupId>org.maxkratz</groupId>
     <artifactId>release-to-issue-java</artifactId>
-    <version>0.0.1-SNAPSHOT</version>
+    <version>1.0.0</version>
 
     <properties>
         <maven.compiler.source>17</maven.compiler.source>