Merge pull request #1 from Bernardo-MG/develop

v1.0.0

action.yml

@@ -5,28 +5,9 @@ branding:
   icon: 'book-open'
   color: 'green'
 inputs:
-  environment:
-    description: 'Github environment to use'
-    default: 'deployment_site'
-    required: false
-  branch:
-    description: 'Branch on which the site will be deployed'
-    required: true
-  profile:
-    description: 'Maven profile for site deployment'
-    default: 'deployment-site'
-    required: false
-  configFile:
-    description: 'Maven configuration file for site deployment'
-    default: 'site_settings.xml'
-    required: false
   host:
     description: 'Host where the site will be deployed'
     required: true
-  jdk:
-    description: 'JDK version to use'
-    default: '11'
-    required: false
   url:
     description: 'URL to deploy the site'
     required: true
@@ -36,6 +17,14 @@ inputs:
   password:
     description: 'Password for deploying'
     required: true
+  jdk:
+    description: 'JDK version to use'
+    default: '11'
+    required: false
+  profile:
+    description: 'Maven profile for site deployment'
+    default: 'deployment-site'
+    required: false
 runs:
     using: 'composite'
     steps:
@@ -56,13 +45,13 @@ runs:
     - name: Set up Maven settings for site deployment
       uses: bernardo-mg/maven-site-deployment-settings-action@v1
       with:
-        username: ${{ secrets.username }}
-        password: ${{ secrets.password }}
-        siteUrl: ${{ secrets.url }}
-        fileName: ${{ inputs.configFile }}
+        username: ${{ inputs.username }}
+        password: ${{ inputs.password }}
+        siteUrl: ${{ inputs.url }}
+        fileName: site_settings.xml
     - name: Generate docs
       run: mvn verify site -B -P ${{ inputs.profile }}
       shell: bash
     - name: Deploy docs
-      run: mvn site:deploy -B -P ${{ inputs.profile }} -DskipTests --settings ${{ inputs.configFile }}
+      run: mvn site:deploy -B -P ${{ inputs.profile }} -DskipTests --settings site_settings.xml
       shell: bash

readme.md

@@ -0,0 +1,56 @@
+# Maven Site Deployment Action
+
+Builds and deploys a Maven site.
+
+## Inputs
+
+| Input    | Description                               | Required                             |
+|----------|-------------------------------------------|--------------------------------------|
+| host     | Host where the site will be deployed.     | True                                 |
+| url      | URL to deploy the site.                   | True                                 |
+| username | Username for the deployment server.       | True                                 |
+| password | Password for the deployment server.       | True                                 |
+| jdk      | JDK version to use.                       | False, defaults to '11'              |
+| profile  | Maven profile for site deployment.        | False, defaults to 'deployment-site' |
+
+## Usage
+
+This builds and deploys the Maven site.
+
+```yaml
+jobs:
+  deploy:
+    name: Deployment
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Deploy site
+      uses: bernardo-mg/maven-site-deployment-action@v1
+      with:
+        host: ${{ inputs.host }}
+        url: ${{ secrets.url }}
+        username: ${{ secrets.username }}
+        password: ${{ secrets.password }}
+```
+
+## Collaborate
+
+Any kind of help with the project will be well received, and there are two main ways to give such help:
+
+- Reporting errors and asking for extensions through the issues management
+- or forking the repository and extending the project
+
+### Issues management
+
+Issues are managed at the GitHub [project issues tracker][issues], where any Github user may report bugs or ask for new features.
+
+### Getting the code
+
+If you wish to fork or modify the code, visit the [GitHub project page][scm], where the latest versions are always kept. Check the 'master' branch for the latest release, and the 'develop' for the current, and stable, development version.
+
+## License
+The project has been released under the [MIT License][license].
+
+[issues]: https://github.com/Bernardo-MG/maven-site-deployment-action/issues
+[license]: https://www.opensource.org/licenses/mit-license.php
+[scm]: https://github.com/Bernardo-MG/maven-site-deployment-action