feat(graphql-java-client-validator-plugin) S3671: added test yaml fil…

.github/pull_request_template.md

@@ -0,0 +1,62 @@
+## Summary
+
+[ a brief summary of your changes ]
+
+[Note that the Title should follow the format **type(scope)[Breaking indicator !]: Ref: Brief Title** ]
+
+[e.g. *feat(orders)!: S1234: investor orders api now structured in hiarachical format to include trading orders*]
+
+[For guidence on the convention please check https://www.conventionalcommits.org/en/v1.0.0/#summary]
+
+### Notes for PR Reviewers
+
+[ What should they be on the lookout for? ]
+
+[ Did you make any notable design decisions as a result of this change that they should know about? ]
+
+## References
+
+[ What Additional Stories/Defects are resolved by this PR (not referenced in title)]
+
+## Limitations
+[ Are there any known limitations? Or aspects of the story(s) that will be delivered in a subsequent PR? ]
+
+# How Has This Been Tested?
+
+Summarize tests added and instructions to run.
+If no new tests were added/required please state why.
+
+[List of tests - or link to test collateral]
+- [ ] Test A
+- [ ] Test B
+
+
+# Checklist:
+
+## To Raise Draft PR
+
+- [ ] My PR Title follows the format type(scope)[!]: Ref: Brief Title
+- [ ] My code meets all style guidelines / linting checks etc.
+- [ ] I have performed a self-review of my code.
+- [ ] I have commented my code and made corresponding changes to the documentation.
+- [ ] My changes generate no new warnings.
+- [ ] I have added tests that prove my fix is effective or that my feature works.
+- [ ] New and existing unit tests pass locally with my changes.
+
+## Before Final Review
+
+- [ ] I have created a draft PR free of merge conflicts and verified behaviour in a review environment.
+- [ ] All errors and warnings in the review environment have been addressed.
+
+## Reviewer Checklist
+
+- [ ] I have been able to build and run the PR locally.*optional*
+- [ ] I have verified that the change works as intended in the review environment
+
+### Shout-outs:
+
+[ @ anyone else here who may not need to be a reviewer, but should be notified. ]
+
+### Support Notes:
+
+[Special instructions for troubleshooting should things go wrong while the author is unavailable]

.github/workflows/build.yaml

@@ -0,0 +1,22 @@
+name: Build and Deploy
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+      - name: Build
+        run: mvn --batch-mode --update-snapshots package
+      - name: Publish
+        run: mvn --batch-mode deploy
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

.github/workflows/test.yaml

@@ -0,0 +1,19 @@
+name: Test
+
+on:
+  push:
+    pull_request:
+      branches:
+        - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+      - name: Test
+        run: mvn --batch-mode --update-snapshots test

README.md

@@ -56,4 +56,11 @@ USAGE :
     </clientClasses>
   </configuration>
  </plugin>
-```
+```
+
+
+MERGING PRs:
+----------------
+After each merge to main, the package is built and an attempt is made to release to the Github Java Repository. This only succeeds where the version does not already exist in the repo.
+
+Please make sure the version is increased in the `pom.xml` file before every merge to main.

pom.xml

@@ -5,7 +5,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.valstro.plugin</groupId>
     <artifactId>graphql-java-client-validator-plugin</artifactId>
-    <version>0.0.1-SNAPSHOT</version>
+    <version>0.0.1</version>
     <name>graphql-java-client-validator-plugin</name>
     <packaging>maven-plugin</packaging>
 
@@ -153,4 +153,12 @@
             </plugin>
         </plugins>
     </reporting>
+
+    <distributionManagement>
+        <repository>
+            <id>github</id>
+            <name>GitHub Packages</name>
+            <url>https://maven.pkg.github.com/valstro/graphql-java-client-validator-plugin</url>
+        </repository>
+    </distributionManagement>
 </project>