Skip to content

Commit 634dc84

Browse files
AlexRogalskiyAlexRogalskiy
committed
Updates on docs
1 parent c85da45 commit 634dc84

17 files changed

+317
-20
lines changed

‎.dockerfilelintrc

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
rules:
3+
# Base images should not use the latest tag
4+
latest_tag: off

‎.github/ISSUE_TEMPLATE/bug_report.md

+30-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,37 @@
11
---
2-
name: Bug report
2+
name: Bug Report
33
about: Create a report to help us improve
44
title: ''
5-
labels: ''
5+
labels: 'bug'
66
assignees: ''
77

88
---
99

10-
**Which version of Kotest are you using**
10+
Found a bug? Maybe our community can help.
11+
12+
[![GitHub Community](https://github.githubassets.com/favicons/favicon.svg)](https://github.com/AlexRogalskiy/java-patterns/issues)
13+
14+
## Describe the Bug
15+
A clear and concise description of what the bug is.
16+
17+
## Expected Behavior
18+
A clear and concise description of what you expected to happen.
19+
20+
## Steps to Reproduce
21+
Steps to reproduce the behavior:
22+
1. Go to '...'
23+
2. Run '....'
24+
3. Enter '....'
25+
4. See error
26+
27+
## Screenshots
28+
If applicable, add screenshots or logs to help explain your problem.
29+
30+
## Environment (please complete the following information):
31+
32+
Anything that will help us triage the bug will help. Here are some ideas:
33+
- OS: [e.g. Linux, OSX, WSL, etc]
34+
- Version [e.g. 10.15]
35+
36+
## Additional Context
37+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/docs.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
name: Documentation request
2+
name: Documentation Request
33
about: Suggest an improvement to the documentation
44
title: ''
55
labels: 'documentation'
66
assignees: ''
77

88
---
99

10-
Please describe here what you would like to see documented.
10+
***Please describe here what you would like to see documented.***

‎.github/ISSUE_TEMPLATE/feature_request.md

+29-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,36 @@
11
---
2-
name: Feature request
2+
name: Feature Request
33
about: Suggest an idea for this project
44
title: ''
5-
labels: 'enhancement'
5+
labels: 'feature request'
66
assignees: ''
77

88
---
99

10-
**Please describe the feature you'd like to see including any solutions in mind if you have any**
10+
Have a question? Please checkout our community or visit us at [Official Website](https://sensiblemetrics.io).
11+
12+
[![GitHub Community](https://github.githubassets.com/favicons/favicon.svg)](https://github.com/AlexRogalskiy/java-patterns/issues)
13+
14+
## Describe the Feature
15+
16+
A clear and concise description of what the feature is.
17+
18+
## Expected Behavior
19+
20+
A clear and concise description of what you expected to happen.
21+
22+
## Use Case
23+
24+
Is your feature request related to a problem/challenge you are trying to solve? Please provide some additional context of why this feature or capability will be valuable.
25+
26+
## Describe Ideal Solution
27+
28+
A clear and concise description of what you want to happen. If you don't know, that's okay.
29+
30+
## Alternatives Considered
31+
32+
Explain what alternative solutions or features you've considered.
33+
34+
## Additional Context
35+
36+
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/question.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
name: Question
3-
about: Questions on kotest usage
3+
about: Questions on usage
44
title: ''
55
labels: ''
66
assignees: ''
77

88
---
99

10-
**Please consider asking your question on our slack channel #kotest or in stack overflow (and tagging with kotest). The github issue tracker is for bugs and feature requests.**
10+
***Please consider asking your question on our community website. The github issue tracker is for bugs and feature requests.***

‎.github/auto-label.yml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
docker:
2+
- Dockerfile
3+
- "*/*.Dockerfile"
4+
5+
docs:
6+
- docs/**
7+
8+
github:
9+
- .github/**
10+
11+
scripts:
12+
- scripts/**

‎.github/workflows/automerge-dependabot.yml

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
#######################################
3+
#######################################
4+
## Dependabot automerge dependencies ##
5+
#######################################
6+
#######################################
7+
8+
#
9+
# Documentation:
10+
# https://medium.com/@toufik.airane/automerge-github-dependabot-alerts-with-github-actions-7cd6f5763750
11+
#
12+
13+
######################
14+
# name of the action #
15+
######################
16+
name: automerge on pull request
17+
18+
###############
19+
# When to run #
20+
###############
21+
on: [ pull_request ]
22+
23+
#################
24+
# Start the job #
25+
#################
26+
jobs:
27+
automerge:
28+
name: automerge dependabot
29+
runs-on: ubuntu-latest
30+
if: github.actor == 'dependabot[bot]' && github.repository == 'megalinter/megalinter'
31+
steps:
32+
- name: Wait for CI/CT/CD to succeed
33+
uses: fountainhead/[email protected]
34+
id: wait-for-build
35+
with:
36+
token: ${{ secrets.GITHUB_TOKEN }}
37+
checkName: Tests + Deploy Docker Image - DEV
38+
ref: ${{ github.event.pull_request.head.sha || github.sha }}
39+
40+
- name: Wait for CI/CT/CD to succeed pt2
41+
uses: fountainhead/[email protected]
42+
id: wait-for-ci
43+
with:
44+
token: ${{ secrets.GITHUB_TOKEN }}
45+
checkName: MegaLinter
46+
ref: ${{ github.event.pull_request.head.sha || github.sha }}
47+
48+
- name: merge
49+
if: steps.wait-for-build.outputs.conclusion == 'success' || steps.wait-for-build.outputs.conclusion == 'skipped' && steps.wait-for-ci.outputs.conclusion == 'success'
50+
uses: actions/github-script@v6
51+
with:
52+
script: |
53+
github.pulls.createReview({
54+
owner: context.payload.repository.owner.login,
55+
repo: context.payload.repository.name,
56+
pull_number: context.payload.pull_request.number,
57+
event: 'APPROVE'
58+
})
59+
github.pulls.merge({
60+
owner: context.payload.repository.owner.login,
61+
repo: context.payload.repository.name,
62+
pull_number: context.payload.pull_request.number
63+
})

‎.github/workflows/automerge.yml

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: automerge
2+
3+
on:
4+
pull_request:
5+
types:
6+
- labeled
7+
- unlabeled
8+
- synchronize
9+
- opened
10+
- edited
11+
- ready_for_review
12+
- reopened
13+
- unlocked
14+
pull_request_review:
15+
types:
16+
- submitted
17+
check_suite:
18+
types:
19+
- completed
20+
status: { }
21+
22+
jobs:
23+
automerge:
24+
runs-on: ubuntu-latest
25+
if: github.repository == 'AlexRogalskiy/java-patterns'
26+
steps:
27+
- name: automerge
28+
env:
29+
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
30+
MERGE_COMMIT_MESSAGE: "pull-request-description"
31+
MERGE_FORKS: "false"
32+
if: env.GITHUB_TOKEN != null
33+
uses: "pascalgn/[email protected]"

‎.github/workflows/greetings.yml

+8-2
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,11 @@ jobs:
99
- uses: actions/first-interaction@v1
1010
with:
1111
repo-token: ${{ secrets.GITHUB_TOKEN }}
12-
issue-message: 'Message that will be displayed on users'' first issue'
13-
pr-message: 'Message that will be displayed on users'' first pr'
12+
issue-message: |-
13+
Thank you for reporting the issue! If you haven't already [joined our github community](https://github.com/AlexRogalskiy/java-patterns/issues), then we invite you to do so.
14+
This is a great place to get help and ask questions from our AMAZING community.
15+
[![GitHub Community](https://github.githubassets.com/favicons/favicon.svg)](https://github.com/AlexRogalskiy/java-patterns/issues)
16+
pr-message: |-
17+
Thank you for submitting this PR! If you haven't already [joined our github community](https://github.com/AlexRogalskiy/java-patterns/issues), then we invite you to do so.
18+
We receive an overwhelming number of contributions. By joining our community, we'll be able to review your PR faster.
19+
[![GitHub Community](https://github.githubassets.com/favicons/favicon.svg)](https://github.com/AlexRogalskiy/java-patterns/issues)

‎.github/workflows/label.yml

+3-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ on: [ pull_request ]
55
jobs:
66
label:
77
runs-on: ubuntu-latest
8-
98
steps:
10-
- uses: actions/labeler@v2
9+
- uses: actions/labeler@v3
1110
with:
1211
repo-token: "${{ secrets.GITHUB_TOKEN }}"
12+
configuration-path: '.github/auto-label.yml'
13+
sync-labels: true

‎.github/workflows/validate-codeowners.yml

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Validate Codeowners
2+
3+
on:
4+
workflow_dispatch:
5+
6+
pull_request:
7+
paths:
8+
- '**/CODEOWNERS'
9+
- '.github/workflows/validate-codeowners.yml'
10+
11+
jobs:
12+
validate-codeowners:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: "Checkout source code at current commit"
16+
uses: actions/checkout@v3
17+
- uses: mszostok/[email protected]
18+
if: github.event.pull_request.head.repo.full_name == github.repository
19+
name: "Full check of CODEOWNERS"
20+
with:
21+
# For now, remove "files" check to allow CODEOWNERS to specify non-existent
22+
# files so we can use the same CODEOWNERS file for Terraform and non-Terraform repos
23+
# checks: "files,syntax,owners,duppatterns"
24+
checks: "syntax,owners,duppatterns"
25+
# GitHub access token is required only if the `owners` check is enabled
26+
github_access_token: "${{ secrets.GITHUB_TOKEN }}"
27+
- uses: mszostok/[email protected]
28+
if: github.event.pull_request.head.repo.full_name != github.repository
29+
name: "Syntax check of CODEOWNERS"
30+
with:
31+
checks: "syntax,duppatterns"

‎.github/workflows/versioning.yml

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
#########################
3+
#########################
4+
## Version GitHub Tags ##
5+
#########################
6+
#########################
7+
8+
#
9+
# Documentation:
10+
# https://help.github.com/en/articles/workflow-syntax-for-github-actions
11+
#
12+
13+
##########################
14+
# Name of the action job #
15+
##########################
16+
name: Keep GitHub tag versions up-to-date
17+
18+
#####################################################
19+
# Run the job when a release is published or edited #
20+
#####################################################
21+
on:
22+
release:
23+
types: [ published, edited ]
24+
25+
#################
26+
# Start the job #
27+
#################
28+
jobs:
29+
actions-tagger:
30+
runs-on: windows-latest
31+
steps:
32+
#############################
33+
# Check out the latest code #
34+
#############################
35+
- uses: actions/[email protected]
36+
37+
######################
38+
# Run the tag action #
39+
######################
40+
- uses: Actions-R-Us/[email protected]
41+
with:
42+
publish_latest_tag: true
43+
env:
44+
GITHUB_TOKEN: "${{secrets.GITHUB_TOKEN}}"

‎.mergify.yml

+38-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,22 @@
11
pull_request_rules:
2+
- name: "approve automated PRs that have passed checks"
3+
conditions:
4+
- "#files<=6"
5+
- "base=master"
6+
actions:
7+
review:
8+
type: "APPROVE"
9+
message: "We've automatically approved this PR because the checks from the automated Pull Request have passed."
10+
label:
11+
add:
12+
- "auto-approved"
13+
214
- name: automatic merge on CI success require review
315
conditions:
416
- status-success=Travis CI - Pull Request
517
- '#approved-reviews-by>=1'
618
- '#changes-requested-reviews-by=0'
19+
- '#commented-reviews-by=0'
720
- label!=block-merge
821
actions:
922
label:
@@ -39,8 +52,8 @@ pull_request_rules:
3952
merge:
4053
method: merge
4154
strict: false
42-
dismiss_reviews: {}
43-
delete_head_branch: {}
55+
dismiss_reviews: { }
56+
delete_head_branch: { }
4457

4558
- name: automatic merge on CI success for TemplateControl
4659
conditions:
@@ -56,7 +69,7 @@ pull_request_rules:
5669
conditions:
5770
- merged
5871
actions:
59-
delete_head_branch: {}
72+
delete_head_branch: { }
6073

6174
- name: Automatically approve Dependabot PRs
6275
conditions:
@@ -69,3 +82,25 @@ pull_request_rules:
6982
actions:
7083
review:
7184
type: APPROVE
85+
86+
- name: "delete the head branch after merge"
87+
conditions:
88+
- "merged"
89+
actions:
90+
delete_head_branch: { }
91+
92+
- name: "ask to resolve conflict"
93+
conditions:
94+
- "conflict"
95+
actions:
96+
comment:
97+
message: "This pull request now has conflicts. Could you fix it @{{author}}? 🙏"
98+
99+
- name: "remove outdated reviews"
100+
conditions:
101+
- "base=master"
102+
actions:
103+
dismiss_reviews:
104+
changes_requested: true
105+
approved: true
106+
message: "This Pull Request has been updated, so we're dismissing all reviews."

0 commit comments

Comments
 (0)