Skip to content

Commit 96722fb

Browse files
hamada147hamada147
authored
build: Documentation & GitHub Actions (#7)
Signed-off-by: Ahmed Moussa <ahmed.moussa@iohk.io>
1 parent 2544187 commit 96722fb

48 files changed

Lines changed: 5677 additions & 1430 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.editorconfig‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
root = true
2+
3+
[*.{kt,kts}]
4+
ktlint_code_style = ktlint_official
5+
ktlint_standard_no_semi = disabled
6+
ktlint_standard_trailing-comma-on-call-site = disabled
7+
ktlint_standard_trailing-comma-on-declaration-site = disabled
8+
ktlint_standard_function-signature = disabled
9+
ktlint_standard_max-line-length = disabled

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
To submit a new issue, please, use one of the following templates:
2+
3+
https://github.com/input-output-hk/atala-prism-didcomm-kmm/issues/new/choose
4+
5+
Thank you!

‎.github/ISSUE_TEMPLATE/1-bug-report.yaml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: Bug Report
3+
description: Report a bug in the Atala PRISM DIDComm
4+
5+
body:
6+
- type: dropdown
7+
id: is-regression
8+
attributes:
9+
label: Is this a regression?
10+
options:
11+
- 'Yes'
12+
- 'No'
13+
validations:
14+
required: true
15+
16+
- type: textarea
17+
id: description
18+
attributes:
19+
label: Description
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: exception-or-error
25+
attributes:
26+
label: Please provide the exception or error you saw
27+
28+
- type: textarea
29+
id: environment
30+
attributes:
31+
label: Please provide the environment you discovered this bug in
32+
33+
- type: textarea
34+
id: other
35+
attributes:
36+
label: Anything else?

‎.github/ISSUE_TEMPLATE/2-feature-request.yaml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: 'Feature Request'
3+
description: Suggest a new feature for Atala PRISM DIDComm
4+
5+
body:
6+
- type: textarea
7+
id: proposed-feature
8+
attributes:
9+
label: Proposed feature
10+
validations:
11+
required: true
12+
13+
- type: textarea
14+
id: description
15+
attributes:
16+
label: Feature description
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: other
22+
attributes:
23+
label: Anything else?

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
---
2+
blank_issues_enabled: false

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Overview
2+
<!-- What this PR does, and why is needed, a useful description is expected, and relevant tickets should be mentioned -->
3+
4+
Fixes #<issue number>
5+
6+
## Checklist
7+
8+
### My PR contains...
9+
* [ ] No code changes (changes to documentation, CI, metadata, etc.)
10+
* [ ] Bug fixes (non-breaking change which fixes an issue)
11+
* [ ] Improvements (misc. changes to existing features)
12+
* [ ] Features (non-breaking change which adds functionality)
13+
14+
### My changes...
15+
* [ ] are breaking changes
16+
* [ ] are not breaking changes
17+
* [ ] If yes to above: I have updated the documentation accordingly
18+
19+
### Documentation
20+
* [ ] My changes do not require a change to the project documentation
21+
* [ ] My changes require a change to the project documentation
22+
* [ ] If yes to above: I have updated the documentation accordingly
23+
24+
### Tests
25+
* [ ] My changes can not or do not need to be tested
26+
* [ ] My changes can and should be tested by unit and/or integration tests
27+
* [ ] If yes to above: I have added tests to cover my changes
28+
* [ ] If yes to above: I have taken care to cover edge cases in my tests

‎.github/workflows/lint-pr.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
# kics-scan ignore
3+
name: "Pull request linter"
4+
5+
on:
6+
pull_request:
7+
8+
jobs:
9+
lint_pr:
10+
name: Validate PR title
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: amannn/action-semantic-pull-request@v5
14+
env:
15+
GITHUB_TOKEN: ${{ secrets.ATALA_GITHUB_TOKEN }}

‎.github/workflows/lint.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
# kics-scan ignore
3+
name: "Linter"
4+
5+
defaults:
6+
run:
7+
shell: bash
8+
9+
on:
10+
pull_request:
11+
12+
jobs:
13+
lint:
14+
name: Lint changes
15+
runs-on: ubuntu-latest
16+
env:
17+
GITHUB_TOKEN: ${{ secrets.ATALA_GITHUB_TOKEN }}
18+
steps:
19+
- name: Checkout Code
20+
uses: actions/checkout@v3
21+
with:
22+
token: ${{ secrets.ATALA_GITHUB_TOKEN }}
23+
fetch-depth: 0
24+
25+
- name: Mega-Linter
26+
id: ml
27+
uses: oxsecurity/megalinter@v7.4.0
28+
29+
- name: Archive production artifacts
30+
uses: actions/upload-artifact@v3
31+
with:
32+
name: Mega-Linter reports
33+
path: |
34+
megalinter-reports
35+
mega-linter.log

‎.github/workflows/pull-request.yml‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
name: Build and Test
3+
4+
defaults:
5+
run:
6+
shell: bash
7+
8+
concurrency:
9+
group: ${{ github.head_ref }}${{ github.ref }}
10+
cancel-in-progress: true
11+
12+
env:
13+
JAVA_VERSION: 11
14+
NODEJS_VERSION: 16.17.0
15+
ATALA_GITHUB_ACTOR: ${{ secrets.ATALA_GITHUB_ACTOR }}
16+
ATALA_GITHUB_TOKEN: ${{ secrets.ATALA_GITHUB_TOKEN }}
17+
18+
on:
19+
push:
20+
branches:
21+
- "main"
22+
pull_request:
23+
24+
jobs:
25+
26+
build:
27+
runs-on: macos-latest
28+
steps:
29+
- name: Checkout the repo
30+
uses: actions/checkout@v3
31+
with:
32+
token: ${{ secrets.ATALA_GITHUB_TOKEN }}
33+
fetch-depth: 0
34+
35+
- name: Validate Gradle Wrapper
36+
uses: gradle/wrapper-validation-action@v1
37+
38+
- name: Cache gradle
39+
uses: actions/cache@v3
40+
with:
41+
path: |
42+
~/.gradle/caches
43+
~/.gradle/wrapper
44+
~/.konan
45+
key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}
46+
restore-keys: |
47+
${{ runner.os }}-gradle-
48+
49+
- name: Install Java ${{ env.JAVA_VERSION }}
50+
uses: actions/setup-java@v3
51+
with:
52+
java-version: ${{ env.JAVA_VERSION }}
53+
distribution: "zulu"
54+
55+
- name: Gradle Build
56+
run: |
57+
./gradlew build test
58+
59+
# Container action is only supported on Linux
60+
# - name: Publish test results
61+
# if: always()
62+
# uses: EnricoMi/publish-unit-test-result-action@v2
63+
# with:
64+
# files: "${{ github.workspace }}/atala-prism-sdk/build/test-results/testReleaseUnitTest/TEST-*.xml"
65+
# comment_title: "Unit Test Results"
66+
# check_name: "Unit Test Results"

0 commit comments

Comments
 (0)