Skip to content

Commit

Permalink
Initial Build
Browse files Browse the repository at this point in the history
  • Loading branch information
komandar committed Dec 28, 2023
0 parents commit 0950ee8
Show file tree
Hide file tree
Showing 14 changed files with 472 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
root = true

[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
indent_style = space
indent_size = 4
max_line_length = 160
trim_trailing_whitespace = true

[{justfile,Makefile,makefile}]
indent_style = tab

[{*.go,go.mod}]
indent_style = tab

[*.json]
indent_size = 2

[*.{js,ts,vue}]
indent_size = 2

[*.md]
trim_trailing_whitespace = false

[*.tf]
indent_size = 2

[{.github/**.{yml,yaml},.gitlab-ci*.{yml,yaml}}]
indent_size = 2
82 changes: 82 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG-REPORT.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
name: "🐛 Bug Report"
description: Create a new ticket for a bug.
title: "🐛 [BUG] - <title>"
labels: [
"bug"
]
body:
- type: textarea
id: description
attributes:
label: "Description"
description: Please enter an explicit description of your issue
placeholder: Short and explicit description of your incident...
validations:
required: true
- type: input
id: reprod-url
attributes:
label: "Reproduction URL"
description: Please enter your GitHub URL to provide a reproduction of the issue
placeholder: ex. https://github.com/USERNAME/REPO-NAME
validations:
required: true
- type: textarea
id: reprod
attributes:
label: "Reproduction steps"
description: Please enter an explicit description of your issue
value: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
render: bash
validations:
required: true
- type: textarea
id: screenshot
attributes:
label: "Screenshots"
description: If applicable, add screenshots to help explain your problem.
value: |
![DESCRIPTION](LINK.png)
render: bash
validations:
required: false
- type: textarea
id: logs
attributes:
label: "Logs"
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: bash
validations:
required: false
- type: dropdown
id: browsers
attributes:
label: "Browsers"
description: What browsers are you seeing the problem on ?
multiple: true
options:
- Chrome
- Firefox
- Microsoft Edge
- Opera
- Safari
- "N/A"
validations:
required: false
- type: dropdown
id: os
attributes:
label: "OS"
description: What is the impacted environment ?
multiple: true
options:
- Windows
- Linux
- Mac
- "N/A"
validations:
required: false
63 changes: 63 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
name: "💡 Feature Request"
description: Create a new ticket for a new feature request
title: "💡 [REQUEST] - <title>"
labels: [
"enhancement"
]
body:
- type: input
id: start_date
attributes:
label: "Start Date"
description: Start of development
placeholder: "month/day/year"
validations:
required: false
- type: textarea
id: implementation_pr
attributes:
label: "Implementation PR"
description: Pull request used
placeholder: "#Pull Request ID"
validations:
required: false
- type: textarea
id: reference_issues
attributes:
label: "Reference Issues"
description: Common issues
placeholder: "#Issues IDs"
validations:
required: false
- type: textarea
id: summary
attributes:
label: "Summary"
description: Provide a brief explanation of the feature
placeholder: Describe in a few lines your feature request
validations:
required: true
- type: textarea
id: basic_example
attributes:
label: "Basic Example"
description: Indicate here some basic examples of your feature.
placeholder: A few specific words about your feature request.
validations:
required: true
- type: textarea
id: drawbacks
attributes:
label: "Drawbacks"
description: What are the drawbacks/impacts of your feature request ?
placeholder: Identify the drawbacks and impacts while being neutral on your feature request
validations:
required: true
- type: textarea
id: unresolved_question
attributes:
label: "Unresolved questions"
description: What questions still remain unresolved ?
placeholder: Identify any unresolved issues.
validations:
required: false
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
9 changes: 9 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
version: 2

updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
day: "saturday"
time: "03:00"
84 changes: 84 additions & 0 deletions .github/workflows/pages-build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
name: MARP Builder

on:
pull_request:
types:
- opened
- reopened
- synchronize
- closed
push:
branches:
- main
release:
types:
- published

concurrency:
group: marp-to-pages
cancel-in-progress: true

jobs:
build:
runs-on: ubuntu-latest
timeout-minutes: 60
permissions:
contents: write
pull-requests: write

steps:
- name: Checkout
uses: actions/checkout@v4
# with:
# fetch-depth: 0

- name: Ensure the build folder exists
run: mkdir -p build

- name: Copy img folder
run: if [[ -d img ]]; then cp -R img build/img; fi

- name: Marp Build (Copy docs)
uses: docker://marpteam/marp-cli:latest
with:
args: -I docs/ -o build/docs/
env:
MARP_USER: root:root

- name: Marp Build (HTML)
uses: docker://marpteam/marp-cli:latest
with:
args: SLIDES.md -o build/index.html
env:
MARP_USER: root:root

- name: Marp Build (PDF)
uses: docker://marpteam/marp-cli:latest
with:
args: SLIDES.md --allow-local-files -o build/index.pdf
env:
MARP_USER: root:root

- name: Marp Build (PPTX)
uses: docker://marpteam/marp-cli:latest
with:
args: SLIDES.md --allow-local-files -o build/index.pptx
env:
MARP_USER: root:root

- name: Deploy preview
if: ${{ github.event_name == 'pull_request' }}
uses: rossjrw/pr-preview-action@v1
with:
source-dir: ./build/
preview-branch: gh-pages
umbrella-dir: pr-preview
action: auto

- name: Deploy production
if: ${{ github.event_name == 'push' }}
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: ./build/
branch: gh-pages
clean-exclude: pr-preview
23 changes: 23 additions & 0 deletions .github/workflows/stale.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Mark stale issues

on:
workflow_dispatch:
schedule:
- cron: "0 3 * * 0"

jobs:
stale:
runs-on: ubuntu-latest
permissions:
issues: write
pull-requests: write

steps:
- uses: actions/stale@v9
with:
stale-issue-message: "This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions."
days-before-stale: 30
days-before-close: 5
exempt-issue-labels: "blocked,must,should,keep"
- name: Print outputs
run: echo ${{ join(steps.stale.outputs.*, ',') }}
17 changes: 17 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
/build

# Ignored jetbrains + vscode files
/.idea
/.vscode

# Ignore Mac .DS_Store files
**/.DS_Store

# Backup files
*.bak

# Logs
*.log

# Directories
/vendor
25 changes: 25 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [1.0.0] - 2044-01-01
### Added
- Example Text

### Changed
- Example Text

### Removed
- Example Text

## [0.1.0] - 2044-01-01
### Added
- Example Text

[Unreleased]: https://github.com/USERNAME/YOUR_PROJECT_NAME/compare/v1.0.0...HEAD
[1.0.0]: https://github.com/USERNAME/YOUR_PROJECT_NAME/compare/v0.1.0...v1.0.0
[0.1.0]: https://github.com/USERNAME/YOUR_PROJECT_NAME/releases/tag/v0.1.0
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 USERNAME

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Loading

0 comments on commit 0950ee8

Please sign in to comment.