Skip to content

Commit 2da9bf5

Browse files
Initial github config
1 parent 00c98d6 commit 2da9bf5

11 files changed

+439
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: 'BUG: '
5+
labels: 'bug, documentation'
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.
39+
40+
**Areas that will be affected as part of the fix**
41+
_Optional, to be added by developer if relevant_

.github/ISSUE_TEMPLATE/epic.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: Epic
3+
about: A theme of work that contain sub-tasks required to complete the larger goal / larger user-story
4+
title: ''
5+
labels: 'epic, documentation'
6+
assignees: ''
7+
---
8+
9+
## Description
10+
11+
Brief summary of what this Epic is, whether it's a larger project, goal, or user story. Describe the job to be done, which persona this Epic is mainly for, or if more multiple, break it down by user and job story.
12+
13+
## Initiative / goal
14+
15+
Describe how this Epic impacts an initiative the business is working on.
16+
17+
### Hypothesis
18+
19+
What is your hypothesis on the success of this Epic? Describe how success will be measured and what leading indicators the team will have to know if success has been hit.
20+
21+
## Acceptance criteria and must have scope
22+
23+
Define what is a must-have for launch and in-scope. Keep this section fluid and dynamic until you lock-in priority during planning.
24+
25+
## Stakeholders
26+
27+
Describe who needs to be kept up-to-date about this Epic, included in discussions, or updated along the way. Stakeholders can be both in Product/Engineering, as well as other teams like Customer Success who might want to keep customers updated on the Epic project.
28+
29+
## Timeline
30+
31+
What's the timeline for this Epic, what resources are needed, and what might potentially block this from hitting the projected end date.
32+
33+
## Design
34+
35+
Figma file:
36+
_Comments are highly appreciated. When commenting in Figma, please also leave a note in the comments box below this issue to notify us_
+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: 'enhancement, documentation'
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/user_story.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: User Story
3+
about: A valuable increment of functionality, testable by the users
4+
title: ''
5+
labels: 'user story, documentation'
6+
assignees: ''
7+
---
8+
9+
## Description
10+
11+
As a <persona or stakeholder type>
12+
I want <some software feature>
13+
So that <some business value>
14+
15+
## Acceptance criteria
16+
17+
- [ ] Should ‹testable condition that should be satisfied›
18+
- [ ]
19+
20+
## Additional Context
21+
22+
Screen shots / UX designs / data that are relevant.
23+
24+
## Areas that will be affected
25+
26+
_To be added during the refinement_

.github/config.yml

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Configuration for welcome - https://github.com/behaviorbot/welcome
2+
3+
# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
4+
5+
# Comment to be posted to on first time issues
6+
newIssueWelcomeComment: >
7+
Thanks for opening your first issue here! Be sure to follow the issue template!
8+
9+
# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
10+
11+
# Comment to be posted to on PRs from first time contributors in your repository
12+
newPRWelcomeComment: >
13+
Thanks for opening this pull request! Please check out our contributing guidelines.
14+
15+
# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
16+
17+
# Comment to be posted to on pull requests merged by a first time user
18+
firstPRMergeComment: >
19+
Congrats on merging your first pull request! We at CherryTwist thank you for your contribution!
20+
21+
# It is recommended to include as many gifs and emojis as possible!

.github/stale.yml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Number of days of inactivity before an issue becomes stale
2+
daysUntilStale: 60
3+
# Number of days of inactivity before a stale issue is closed
4+
daysUntilClose: 7
5+
# Issues with these labels will never be considered stale
6+
exemptLabels:
7+
- pinned
8+
- security
9+
- Epic
10+
# Label to use when marking an issue as stale
11+
staleLabel: wontfix
12+
# Comment to post when marking an issue as stale. Set to `false` to disable
13+
markComment: >
14+
This issue has been automatically marked as stale because it has not had
15+
recent activity. It will be closed if no further activity occurs. Thank you
16+
for your contributions.
17+
# Comment to post when closing a stale issue. Set to `false` to disable
18+
closeComment: false
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: Build, Migrate & Deploy to Dev on Hetzner
2+
3+
on:
4+
push:
5+
branches: [develop]
6+
7+
jobs:
8+
build:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: 'Checkout GitHub Action'
12+
uses: actions/[email protected]
13+
14+
- name: 'Login into ACR'
15+
uses: azure/docker-login@v2
16+
with:
17+
login-documentation: ${{ secrets.REGISTRY_LOGIN_SERVER }}
18+
username: ${{ secrets.REGISTRY_USERNAME }}
19+
password: ${{ secrets.REGISTRY_PASSWORD }}
20+
21+
- name: 'Build & Push image'
22+
run: |
23+
docker build -f Dockerfile . -t ${{ secrets.REGISTRY_LOGIN_SERVER }}/alkemio-documentation:${{ github.sha }} -t ${{ secrets.REGISTRY_LOGIN_SERVER }}/alkemio-documentation:latest
24+
docker push ${{ secrets.REGISTRY_LOGIN_SERVER }}/alkemio-documentation:${{ github.sha }}
25+
26+
deploy:
27+
needs: build
28+
runs-on: ubuntu-latest
29+
steps:
30+
- name: 'Checkout GitHub Action'
31+
uses: actions/[email protected]
32+
33+
- name: Install Kubectl
34+
uses: azure/[email protected]
35+
with:
36+
version: 'v1.27.6' # Ensure this matches the version used in your cluster
37+
38+
- name: Set up Kubeconfig for Hetzner k3s
39+
run: |
40+
mkdir -p $HOME/.kube # Ensure the .kube directory exists
41+
echo "${{ secrets.KUBECONFIG_SECRET_HETZNER_DEV }}" > $HOME/.kube/config
42+
chmod 600 $HOME/.kube/config
43+
44+
- name: Create Image Pull Secret
45+
run: |
46+
kubectl create secret docker-registry alkemio-documentation-secret \
47+
--docker-documentation=${{ secrets.REGISTRY_LOGIN_SERVER }} \
48+
--docker-username=${{ secrets.REGISTRY_USERNAME }} \
49+
--docker-password=${{ secrets.REGISTRY_PASSWORD }} \
50+
--dry-run=client -o yaml | kubectl apply -f -
51+
52+
- name: Deploy to k3s on Hetzner
53+
uses: azure/[email protected]
54+
with:
55+
manifests: |
56+
manifests/25-documentation-deployment-dev.yaml
57+
images: |
58+
${{ secrets.REGISTRY_LOGIN_SERVER }}/alkemio-documentation:${{ github.sha }}
59+
imagepullsecrets: |
60+
alkemio-documentation-secret
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Build, Migrate & Deploy to Sandbox on Hetzner
2+
3+
on:
4+
workflow_dispatch:
5+
6+
jobs:
7+
build:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: 'Checkout GitHub Action'
11+
uses: actions/[email protected]
12+
13+
- name: 'Login into ACR'
14+
uses: azure/docker-login@v2
15+
with:
16+
login-documentation: ${{ secrets.REGISTRY_LOGIN_SERVER }}
17+
username: ${{ secrets.REGISTRY_USERNAME }}
18+
password: ${{ secrets.REGISTRY_PASSWORD }}
19+
20+
- name: 'Build & Push image'
21+
run: |
22+
docker build -f Dockerfile . -t ${{ secrets.REGISTRY_LOGIN_SERVER }}/alkemio-documentation:${{ github.sha }} -t ${{ secrets.REGISTRY_LOGIN_SERVER }}/alkemio-documentation:latest
23+
docker push ${{ secrets.REGISTRY_LOGIN_SERVER }}/alkemio-documentation:${{ github.sha }}
24+
25+
deploy:
26+
needs: build
27+
runs-on: ubuntu-latest
28+
steps:
29+
- name: 'Checkout GitHub Action'
30+
uses: actions/[email protected]
31+
32+
- name: Install Kubectl
33+
uses: azure/[email protected]
34+
with:
35+
version: 'v1.27.6' # Ensure this matches the version used in your cluster
36+
37+
- name: Set up Kubeconfig for Hetzner k3s
38+
run: |
39+
mkdir -p $HOME/.kube # Ensure the .kube directory exists
40+
echo "${{ secrets.KUBECONFIG_SECRET_HETZNER_SANDBOX }}" > $HOME/.kube/config
41+
chmod 600 $HOME/.kube/config
42+
43+
- name: Create Image Pull Secret
44+
run: |
45+
kubectl create secret docker-registry alkemio-documentation-secret \
46+
--docker-documentation=${{ secrets.REGISTRY_LOGIN_SERVER }} \
47+
--docker-username=${{ secrets.REGISTRY_USERNAME }} \
48+
--docker-password=${{ secrets.REGISTRY_PASSWORD }} \
49+
--dry-run=client -o yaml | kubectl apply -f -
50+
51+
- name: Deploy to k3s on Hetzner
52+
uses: azure/[email protected]
53+
with:
54+
manifests: |
55+
manifests/25-documentation-deployment-dev.yaml
56+
images: |
57+
${{ secrets.REGISTRY_LOGIN_SERVER }}/alkemio-documentation:${{ github.sha }}
58+
imagepullsecrets: |
59+
alkemio-documentation-secret
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Build, Migrate & Deploy to Test on Hetzner
2+
3+
on:
4+
workflow_dispatch:
5+
6+
jobs:
7+
build:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: 'Checkout GitHub Action'
11+
uses: actions/[email protected]
12+
13+
- name: 'Login into ACR'
14+
uses: azure/docker-login@v2
15+
with:
16+
login-documentation: ${{ secrets.REGISTRY_LOGIN_SERVER }}
17+
username: ${{ secrets.REGISTRY_USERNAME }}
18+
password: ${{ secrets.REGISTRY_PASSWORD }}
19+
20+
- name: 'Build & Push image'
21+
run: |
22+
docker build -f Dockerfile . -t ${{ secrets.REGISTRY_LOGIN_SERVER }}/alkemio-documentation:${{ github.sha }} -t ${{ secrets.REGISTRY_LOGIN_SERVER }}/alkemio-documentation:latest
23+
docker push ${{ secrets.REGISTRY_LOGIN_SERVER }}/alkemio-documentation:${{ github.sha }}
24+
25+
deploy:
26+
needs: build
27+
runs-on: ubuntu-latest
28+
steps:
29+
- name: 'Checkout GitHub Action'
30+
uses: actions/[email protected]
31+
32+
- name: Install Kubectl
33+
uses: azure/[email protected]
34+
with:
35+
version: 'v1.27.6' # Ensure this matches the version used in your cluster
36+
37+
- name: Set up Kubeconfig for Hetzner k3s
38+
run: |
39+
mkdir -p $HOME/.kube # Ensure the .kube directory exists
40+
echo "${{ secrets.KUBECONFIG_SECRET_HETZNER_TEST }}" > $HOME/.kube/config
41+
chmod 600 $HOME/.kube/config
42+
43+
- name: Create Image Pull Secret
44+
run: |
45+
kubectl create secret docker-registry alkemio-documentation-secret \
46+
--docker-documentation=${{ secrets.REGISTRY_LOGIN_SERVER }} \
47+
--docker-username=${{ secrets.REGISTRY_USERNAME }} \
48+
--docker-password=${{ secrets.REGISTRY_PASSWORD }} \
49+
--dry-run=client -o yaml | kubectl apply -f -
50+
51+
- name: Deploy to k3s on Hetzner
52+
uses: azure/[email protected]
53+
with:
54+
manifests: |
55+
manifests/25-documentation-deployment-dev.yaml
56+
images: |
57+
${{ secrets.REGISTRY_LOGIN_SERVER }}/alkemio-documentation:${{ github.sha }}
58+
imagepullsecrets: |
59+
alkemio-documentation-secret

0 commit comments

Comments
 (0)