diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..9254d4c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,61 @@ +--- +name: "๐Ÿ› Bug Report" +description: Create a report to help us improve +labels: [ bug ] +assignees: [ ] +body: + - type: textarea + id: description + attributes: + label: Describe the bug + description: What is the problem? A clear and concise description of the bug. + validations: + required: true + + - type: textarea + id: current + attributes: + label: Current behavior + description: | + Please include full errors, uncaught exceptions, screenshots, and relevant logs. + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: Reproduction steps + description: | + Provide steps to reproduce the behavior. + validations: + required: false + + - type: textarea + id: expected + attributes: + label: Expected behavior + description: | + What did you expect to happen? + validations: + required: false + + - type: input + id: open-interactive-simulation-deployer-version + attributes: + label: OIS deployer version + validations: + required: true + + - type: input + id: os-version + attributes: + label: Operating system type and version + validations: + required: true + + - type: input + id: gradle-version + attributes: + label: Gradle version + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..44a327b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,37 @@ +--- +name: "โญ๏ธ Feature request" +description: Suggest an idea for this project +labels: [ new feature ] +assignees: [ ] +body: + - type: textarea + id: description + attributes: + label: Is your feature request related to a problem? Please describe. + description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like to see + description: A clear and concise description of the new feature. + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Describe alternatives you've considered + description: If applicable, a clear and concise description of any alternative solutions or features you've considered. + validations: + required: false + + - type: textarea + id: extras + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here. + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 0000000..df7b2a6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,12 @@ +--- +name: "โ“ Question" +description: Ask a question +labels: [ question ] +assignees: [ ] +body: + - type: textarea + id: question + attributes: + label: How can we help? + validations: + required: true \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..ff9a73f --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,5 @@ +- [ ] I read the [contribution](../CONTRIBUTING.md) notes. + +- [ ] All [tests](../CONTRIBUTING.md) passed. If this feature is not already covered by the tests, I added new + tests. +----- \ No newline at end of file diff --git a/.github/release.yml b/.github/release.yml new file mode 100644 index 0000000..b5ce22d --- /dev/null +++ b/.github/release.yml @@ -0,0 +1,20 @@ +changelog: + exclude: + labels: + - ignore for release + categories: + - title: Breaking Changes ๐Ÿšจ + labels: + - breaking change + - title: Exciting New Features ๐ŸŽ‰ + labels: + - new feature + - title: Improvements ๐ŸŒฑ + labels: + - improvement + - title: Bug Fixes ๐Ÿ›  + labels: + - bug + - title: Other Changes ๐Ÿ“š + labels: + - "*" \ No newline at end of file diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..808e99f --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,36 @@ +name: Test + +on: push + +jobs: + test: + runs-on: ${{ matrix.os }} + strategy: + fail-fast: false + matrix: + os: [ ubuntu-latest, windows-latest, macOS-latest ] + steps: + - name: Checkout + uses: actions/checkout@v3 + with: + submodules: true + ref: ${{ github.event.pull_request.head.sha }} + + # Install required tools + - name: Set up Java + uses: actions/setup-java@v3 + with: + distribution: "temurin" + java-version: "11" + + # Run tests + - name: Tests on macOS, Linux + run: ./gradlew clean check + if: runner.os != 'Windows' + - name: Tests on Windows + run: ./gradlew.bat clean check + if: runner.os == 'Windows' + + # Stop Gradle daemon + - name: Stop Gradle + run: ./gradlew --stop \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..778ad2f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,26 @@ +# ๐Ÿ“– Guidelines + +- If the existing tests do not already cover your changes, please add tests. + +--- + +# โš’๏ธ Building the plugin + +To build the library sources, please follow these steps: + +1. Clone the code from Git. +2. Build the plugin by running the following Gradle command: + ``` + gradlew clean build + ``` + +To build the library sources and publish it locally, run the following Gradle command: +``` + gradlew publishToMavenLocal +``` + +--- + +# ๐Ÿงช Testing the plugin + +To test the library sources, please follow these steps: diff --git a/README.md b/README.md index 527ee50..2a80c6c 100644 --- a/README.md +++ b/README.md @@ -1 +1,30 @@ -# open-interactive-simulation-deployer \ No newline at end of file +
+ +# open-interactive-simulation-deployer + +
+ +--- + +## Table of Contents +- [๐Ÿ“š Overview](#-overview) +- [๐Ÿ“ฆ Installation](#-installation) +- [๐Ÿž Reporting Issues](#-reporting-issues) +- [๐Ÿค Contributions](#-contributions) + +## ๐Ÿ“š Overview + +## ๐Ÿ“ฆ Installation + +## ๐Ÿž Reporting Issues + +We highly recommend running Gradle with the ```-d``` +option to get useful and readable debug information if something goes wrong with your build. + +Please help us improve the library +by [reporting any issues](https://github.com/jfrog/artifactory-gradle-plugin/issues/new/choose) you encounter. + +## ๐Ÿค Contributions + +We welcome pull requests from the community. To help us improve this project, please read +our [Contribution](./CONTRIBUTING.md#-guidelines) guide. \ No newline at end of file diff --git a/gradlew b/gradlew old mode 100644 new mode 100755