Merge pull request #80 from GatorEducator/develop

Release merge for v1.0.0-rc1

.github/workflows/main.yml

@@ -0,0 +1,37 @@
+name: build
+
+on: [push, pull_request]
+
+jobs:
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+      - name: Run MDL
+        uses: actionshub/markdownlint@main
+
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        java-version: [8, 11, 14]
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+        with:
+          # Fetch entire repository
+          fetch-depth: 0
+      - name: Set up JDK ${{ matrix.java-version }}
+        uses: actions/setup-java@v1
+        with:
+          java-version: ${{ matrix.java-version }}
+      - name: Run Gradle
+        uses: burrunan/gradle-cache-action@v1
+        with:
+          job-id: ${{ matrix.java-version }}
+          gradle-version: 7.4.2
+          arguments: check build

.github/workflows/publish.yml

@@ -0,0 +1,26 @@
+name: Publish
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+      - name: Set up JDK 8
+        uses: actions/setup-java@v1
+        with:
+          java-version: 8
+      - name: Build
+        run: gradle clean build check
+      - name: Publish Plugin
+        run: gradle publishPlugins
+        env:
+          GRADLE_PUBLISH_KEY: ${{ secrets.GRADLE_PUBLISH_KEY }}
+          GRADLE_PUBLISH_SECRET: ${{ secrets.GRADLE_PUBLISH_SECRET }}
+      - name: Publish Javadoc
+        run: gradle publishJavadocs

.gitignore

@@ -1,8 +1,7 @@
-.gradle
+.gradle/
 /build/
 /docs/
 
-
 /_site/
 /vendor/
 

.mdl.rb

@@ -0,0 +1,2 @@
+all
+rule 'MD013', :code_blocks => false, :tables => false

.mdlrc

@@ -1 +1 @@
-style "gradle/config/mdl/style.rb"
+style '.mdl.rb'

.pmdrules.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0"?>
+<ruleset name="PMD Rules"
+    xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
+
+<description>
+    Looks for unused code and bad programming practices
+</description>
+
+
+<rule ref="category/java/errorprone.xml/EmptyCatchBlock" />
+<rule ref="category/java/codestyle.xml/UnnecessaryImport" />
+<rule ref="category/java/bestpractices.xml/UnusedFormalParameter" />
+<rule ref="category/java/bestpractices.xml/UnusedPrivateMethod" />
+<rule ref="category/java/bestpractices.xml/LooseCoupling" />
+<rule ref="category/java/bestpractices.xml/UseCollectionIsEmpty" />
+<rule ref="category/java/bestpractices.xml/AvoidPrintStackTrace" />
+<rule ref="category/java/bestpractices.xml/SwitchStmtsShouldHaveDefault" />
+<rule ref="category/java/bestpractices.xml/DefaultLabelNotLastInSwitchStmt" />
+<rule ref="category/java/bestpractices.xml/ForLoopCanBeForeach" />
+<rule ref="category/java/bestpractices.xml/MissingOverride" />
+<rule ref="category/java/bestpractices.xml/PreserveStackTrace" />
+</ruleset>

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and
+expression, level of experience, education, socio-economic status, nationality,
+personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, or to ban temporarily or permanently any
+contributor for other behaviors that they deem inappropriate, threatening,
+offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an
+incident. Further details of specific enforcement policies may be posted
+separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor
+Covenant](https://www.contributor-covenant.org), version 1.4, available
+[here](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html).
+
+For answers to common questions about this code of conduct, see the
+[FAQ](https://www.contributor-covenant.org/faq).

CONTRIBUTING.md

@@ -0,0 +1,40 @@
+# How to Contribute
+
+Thank you for taking time to contribute to GatorGradle! This guide will help you
+to effectively contribute to the project.
+
+## Table of Contents
+
+* [Code of Conduct](#code-of-conduct)
+* [Raising an Issue](#raising-an-issue)
+* [Making a Pull Request](#making-a-pull-request)
+
+## Code of Conduct
+
+We ask that everyone contributing to this project follow the [code of
+conduct](CODE_OF_CONDUCT.md). Please report any violations to
+[@gkapfham](https://github.com/gkapfham).
+
+## Raising an Issue
+
+First, check the [Issue
+Tracker](https://github.com/GatorEducator/gatorgradle/issues) to make sure that
+someone has not already raised your issue. If you have a new issue to raise, go
+ahead and [raise
+it](https://github.com/GatorEducator/gatorgrader/issues/new/choose)! At this
+point you should decide if your issue is a "Bug report" or a "Feature request"
+and then click the green "Get started" button. Please follow the provided
+template when you are describing your issue.
+
+## Making a Pull Request
+
+The development team uses the [GitHub Flow
+Model](https://guides.github.com/introduction/flow/) to guide our engineering of
+this tool and we invite you to also follow it as you make a contribution. If you
+have a new feature or bug fix that you want the project maintainers to merge
+into GatorGradle, then you should make a [pull
+request](https://github.com/GatorEducator/gatorgradle/pulls) against the
+`develop` branch. Please follow the provided template when you are describing
+your pull request, bearing in mind that the project maintainers will not merge
+any pull requests that either do not adhere to the template or break any aspects
+of the automated build.