-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from MyUNiDAYS/initial
Added properties + scripts
- Loading branch information
Showing
22 changed files
with
2,778 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
|
||
--- | ||
|
||
_When issuing a bug report please include as many of the below details as possible. If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one._ | ||
|
||
### Describe the bug | ||
|
||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
|
||
Steps to reproduce the behaviour: | ||
1. Go to '...' | ||
2. Click on '...' | ||
3. Scroll down to '...' | ||
4. See error | ||
|
||
**Reproduces how often:** | ||
|
||
What percentage of the time does it reproduce, if you know? | ||
|
||
**Expected behaviour** | ||
|
||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
|
||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Additional context** | ||
|
||
Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
|
||
--- | ||
|
||
### Describe the feature | ||
|
||
A clear and concise description of what the feature is. | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
|
||
- A clear and concise description of what the problem is. E.g. I'm always frustrated when [...] | ||
- If applicable describe the current behaviour and explain which behaviour you expected to see instead. | ||
|
||
**Describe the solution you'd like and why** | ||
|
||
- A short but clear and concise description of what you want to happen. | ||
- Why would this change be beneficial and for who? | ||
|
||
**Prerequisites** | ||
|
||
Is there anything required that might block the progress of this feature | ||
|
||
**Examples of similar work** | ||
|
||
If applicable, give examples where you have seen this feature before. | ||
|
||
**Describe alternatives you've considered** | ||
|
||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
|
||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
# UNiDAYS Contributors Guide | ||
|
||
:star: Thanks for taking the time to contribute :star: | ||
|
||
This document outlines the different ways you can contribute to the UNiDAYS repositories, guidelines on how to do it and some of our standardisations. Everything is open to improvement and all of these are guidelines. If you can think of something we can change or are missing in this doc - you can even open a pull request for making that kind of change. | ||
|
||
[Code of Conduct](CODE_OF_CONDUCT.md) | ||
|
||
[What should I know before I get started?](#what-should-i-know-before-i-get-started) | ||
|
||
[How Can I Contribute?](#how-can-i-contribute) | ||
* [Reporting Bugs](#reporting-bugs) | ||
* [Suggesting Enhancements](#suggesting-enhancements) | ||
* [Labels For Issues](#labels-for-issues) | ||
* [Pull Requests](#pull-requests) | ||
* [Your First Code Contribution](#your-first-code-contribution) | ||
|
||
[Style Guides](#style-guides) | ||
* [Documentation Style Guide](#documentation-style-guide) | ||
|
||
## How Can I Contribute? | ||
|
||
### Reporting Bugs | ||
|
||
When issuing a bug report please include as many of details on [the bug report template](./ISSUE_TEMPLATE/bug_report.md) as possible. If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one. Please label the any bug report issues with `bug`. | ||
|
||
### Suggesting Enhancements | ||
|
||
Enhancements may include completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions. | ||
|
||
First of all please do a search on the issues already present to see if it's an enhancement that hasn't previously been suggested. If it has, maybe join the discussion on the pre-existing issue. This is to help reduce duplication of issues. If it hasn't been raised previously, please include as many details as you can using [the feature request template](./ISSUE_TEMPLATE/feature_request.md). Label the raised feature request as `enhancement` | ||
|
||
### Labels For Issues | ||
|
||
| Label | Purpose | | ||
| --- |--- | | ||
| up-for-grabs | An issue that is ready and has enough information to be picked up | | ||
| docs | An issue that only relates to writing docs | | ||
| easy | Difficulty level: any level of experience can pick this issue up | | ||
| medium | Difficulty level: some experience of the domain or language will be needed to pick this issue up | | ||
| hard |Difficulty level: a lot of experience of the domain or language will be needed to pick this issue up | | ||
| insane | Difficulty level: you need to be a total wizard to figure this out | | ||
| enhancement | Making things better but without fixing an issue | | ||
| fix | Fixing a pre-existing problem with the code | | ||
|
||
### Pull Requests | ||
|
||
* Create branch. If there is an issue, have the branch name related to the linked issue, otherwise give it a descriptive name relating to what the work covers. See some examples below. | ||
|
||
| PR-prefix | Purpose | Example | | ||
| --- | --- | --- | | ||
| issuenumber_ | When it relating to a pre-existing issues | issuenumber_583 | | ||
| enhancement | Making things _better_ but without fixing an issue | enhancement_improveperformanceofquery | | ||
| fix | Fixing a pre-existing problem with the code that isn't an issue | fix_acceptnullsforinput | | ||
|
||
* Open a Pull Request with the details listed in the [pull request template](../pull_request_template.md). The sections of this template should show in the body of any new pull request automatically. | ||
|
||
* Please ensure that any changes you make comply with our [style guides](#style-guides). | ||
|
||
* Include screenshots and animated GIFs in your pull request whenever possible. | ||
|
||
* Make a comment with the pull request in any issues it relates to. | ||
|
||
### Your First Code Contribution? | ||
|
||
We will make efforts to label issues with `beginner` if we think they should only require a few lines of code, and a test or two. This is in order to help those who want to contribute but don't necessarily have much experience in doing so. | ||
|
||
## Documentation Style Guide | ||
|
||
For anything changing the user experience or externally visible implementation, please update the README.md as part of your pull request. | ||
|
||
## Licencing | ||
|
||
If it's something cool, new and funky that you are contributing, please ensure it's covered with an MIT licence. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
name: Pull-Request | ||
|
||
on: | ||
pull_request: | ||
branches: [ master ] | ||
|
||
jobs: | ||
build: | ||
runs-on: macos-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- uses: actions/setup-java@v1 | ||
with: | ||
java-version: 11 | ||
- name: Setup cocoapods | ||
run: gem install cocoapods-generate | ||
- name: Static Analysis | ||
run: ./gradlew detekt | ||
- name: Verify Tests Coverage | ||
run: ./gradlew koverVerify | ||
- name: Build | ||
run: ./gradlew build |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
name: Release | ||
|
||
on: | ||
release: | ||
types: [released] | ||
|
||
jobs: | ||
build: | ||
runs-on: macos-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- uses: actions/setup-java@v1 | ||
with: | ||
java-version: 11 | ||
- name: Update version property | ||
uses: Reedyuk/[email protected] | ||
with: | ||
path: 'gradle.properties' | ||
property: 'MODULE_VERSION_NUMBER' | ||
value: ${{ github.ref_name }} | ||
- name: Setup cocoapods | ||
run: gem install cocoapods-generate | ||
- name: Static Analysis | ||
run: ./gradlew detekt | ||
- name: Verify Tests Coverage | ||
run: ./gradlew koverVerify | ||
- name: Build | ||
run: ./gradlew build | ||
- name: Run create xcframework | ||
run: ./gradlew assembleLibraryXCFramework | ||
- name: Run publish | ||
run: ./gradlew publish | ||
env: | ||
sonatypeUsernameEnv: ${{ secrets.SONATYPEUSERNAME }} | ||
sonatypePasswordEnv: ${{ secrets.SONATYPEPASSWORD }} | ||
ORG_GRADLE_PROJECT_signingKey: ${{ secrets.GPG_KEY }} | ||
ORG_GRADLE_PROJECT_signingPassword: ${{ secrets.GPG_KEY_PASS }} | ||
- name: Get last release | ||
id: lastRelease | ||
uses: InsonusK/[email protected] | ||
with: | ||
myToken: ${{ github.token }} | ||
exclude_types: draft|prerelease | ||
view_top: 1 | ||
- uses: vimtor/action-zip@v1 | ||
with: | ||
files: build/XCFrameworks/release/ | ||
dest: build/${{ github.ref_name }}.zip | ||
- name: upload iOS artifact to release | ||
uses: actions/upload-release-asset@v1 | ||
env: | ||
GITHUB_TOKEN: ${{ github.token }} | ||
with: | ||
upload_url: https://uploads.github.com/repos/MyUNiDAYS/libraryname/releases/${{ steps.lastRelease.outputs.id }}/assets?name=${{ github.ref_name }}.zip | ||
asset_path: build/${{ github.ref_name }}.zip | ||
asset_name: ${{ github.ref_name }}.zip | ||
asset_content_type: application/zip |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
name: Update-From-Template | ||
|
||
on: | ||
pull_request: | ||
branches: [ master ] | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- name: Run Update Script | ||
run: ./scripts/update-from-template.sh | ||
shell: bash | ||
env: | ||
GITHUB_TOKEN: ${{ github.token }} |
Oops, something went wrong.