Skip to content

Commit 877f6e3

Browse files
willtheorangeguywilltheorangeguy
authored
Merge pull request #20 from Dog-Face-Development/willtheorangeguy-github-and-docs
Create .github files and doc files
2 parents 8b35eb4 + 5ab41b3 commit 877f6e3

24 files changed

+1192
-674
lines changed

‎.github/FUNDING.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# These are supported funding model platforms
2+
3+
github: ['willtheorangeguy', 'Dog-Face-Development']
4+
custom: ['https://paypal.me/wvdg44']

‎.github/ISSUE_TEMPLATE/bug-report.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve!
4+
title: ''
5+
labels: bug
6+
assignees: willtheorangeguy
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+
16+
1. Go to '...'
17+
2. Click on '....'
18+
3. Scroll down to '....'
19+
4. See error.
20+
21+
**Expected Behavior**
22+
A clear and concise description of what you expected to happen.
23+
24+
**Screenshots**
25+
If applicable, add screenshots to help explain your problem.
26+
27+
**Desktop (please complete the following information):**
28+
29+
- OS: [e.g. Windows]
30+
- Program Version [e.g. 22]
31+
- Browser [e.g. Edge Chromium]
32+
- Browser Version [e.g. 69]
33+
34+
**Additional Context**
35+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature-request.md

+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: 'Feature: '
5+
labels: enhancement
6+
assignees: willtheorangeguy
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/question.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: Question
3+
about: Let us know if you have a question!
4+
title: 'Question: '
5+
labels: question
6+
assignees: willtheorangeguy
7+
8+
---
9+
10+
**Is your question 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+
**What is the question?**
14+
15+
**Additional Context**

‎.github/PULL_REQUEST_TEMPLATE.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
**Describe the Pull Request**
2+
3+
A clear and concise description of what the pull request does.
4+
5+
**Expected Behavior**
6+
7+
A clear and concise description of what you expected to happen.
8+
9+
**Fixes the Following Issues**
10+
11+
A clear and concise description of what you expected to happen.
12+
13+
**Screenshots**
14+
15+
If applicable, add screenshots to help explain your problem.
16+
17+
**Desktop Developed On (please complete the following information):**
18+
19+
- OS: [e.g. Windows]
20+
- Program Version [e.g. 22]
21+
- Browser [Edge Chromium]
22+
- Browser Version [e.g. 69]
23+
24+
**Additional Context**
25+
26+
Add any other context about the problem here.
27+
28+
**Please ensure you have read the [Contributor License Agreements](https://github.com/Dog-Face-Development/DFD-Web-Style-Guide/tree/master/docs/legal). By creating your pull request, you agree to the CLA.**

‎.github/dependabot.yml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "github-actions"
4+
directory: "/"
5+
schedule:
6+
interval: "daily"
7+
- package-ecosystem: "npm"
8+
directory: "/"
9+
schedule:
10+
interval: "daily"
11+
- package-ecosystem: "docker"
12+
directory: "/"
13+
schedule:
14+
interval: "daily"

‎.github/workflows/cla.yml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: "cla"
2+
on:
3+
issue_comment:
4+
types: [created]
5+
pull_request_target:
6+
types: [opened, closed, synchronize]
7+
8+
jobs:
9+
CLAssistant:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: "CLA Assistant"
13+
if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document, and I hereby sign the CLA.') || github.event_name == 'pull_request_target'
14+
# Beta Release
15+
uses: contributor-assistant/github-action@v2.2.1
16+
env:
17+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
18+
# the below token should have repo scope and must be manually added by you in the repository's secret
19+
PERSONAL_ACCESS_TOKEN : ${{ secrets.PERSONAL_ACCESS_TOKEN }}
20+
with:
21+
path-to-signatures: 'signatures/cla.json'
22+
path-to-document: 'https://github.com/Dog-Face-Development/.github/tree/main/docs/legal' # e.g. a CLA or a DCO document
23+
# branch should not be protected
24+
branch: 'main'
25+
allowlist: willtheorangeguy, bot*
26+
remote-organization-name: Dog-Face-Development
27+
remote-repository-name: cla-signatures
28+
create-file-commit-message: 'Create CLA signatures file'
29+
signed-commit-message: '$contributorName has signed the CLA in #$pullRequestNo'
30+
custom-notsigned-prcomment: 'Thank you for your contribution, please read and sign our CLA. Instructions on how to do so can be found in the `CONTRIBUTING.md` document.'
31+
custom-pr-sign-comment: 'I have read the CLA Document, and I hereby sign the CLA.'
32+
custom-allsigned-prcomment: 'All Contributors have signed the CLA!'

‎.github/workflows/codeql-analysis.yml

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: "CodeQL"
2+
3+
on:
4+
push:
5+
branches: [ "master" ]
6+
pull_request:
7+
# The branches below must be a subset of the branches above
8+
branches: [ "master" ]
9+
schedule:
10+
- cron: '39 7 * * 6'
11+
12+
jobs:
13+
analyze:
14+
name: Analyze
15+
runs-on: ubuntu-latest
16+
permissions:
17+
actions: read
18+
contents: read
19+
security-events: write
20+
21+
strategy:
22+
fail-fast: false
23+
matrix:
24+
language: [ 'javascript' ]
25+
26+
steps:
27+
- name: Checkout repository
28+
uses: actions/checkout@v3
29+
30+
# Initializes the CodeQL tools for scanning.
31+
- name: Initialize CodeQL
32+
uses: github/codeql-action/init@v2
33+
with:
34+
languages: ${{ matrix.language }}
35+
# If you wish to specify custom queries, you can do so here or in a config file.
36+
# By default, queries listed here will override any specified in a config file.
37+
# Prefix the list here with "+" to use these queries and those in the config file.
38+
39+
# Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
40+
# queries: security-extended,security-and-quality
41+
42+
43+
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
44+
# If this step fails, then you should remove it and run the build manually (see below)
45+
- name: Autobuild
46+
uses: github/codeql-action/autobuild@v2
47+
48+
# ℹ️ Command-line programs to run using the OS shell.
49+
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
50+
51+
# If the Autobuild fails above, remove it and uncomment the following three lines.
52+
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
53+
54+
# - run: |
55+
# echo "Run, Build Application using script"
56+
# ./location_of_script_within_repo/buildscript.sh
57+
58+
- name: Perform CodeQL Analysis
59+
uses: github/codeql-action/analyze@v2

‎.github/workflows/docker-publish.yml

+88
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
name: docker-publish
2+
3+
on:
4+
schedule:
5+
- cron: '32 11 * * *'
6+
push:
7+
branches: [ "main" ]
8+
# Publish semver tags as releases.
9+
tags: [ 'v*.*.*' ]
10+
pull_request:
11+
branches: [ "main" ]
12+
13+
env:
14+
# Use docker.io for Docker Hub if empty
15+
REGISTRY: ghcr.io
16+
# github.repository as <account>/<repo>
17+
IMAGE_NAME: ${{ github.repository }}
18+
19+
20+
jobs:
21+
build:
22+
23+
runs-on: ubuntu-latest
24+
permissions:
25+
contents: read
26+
packages: write
27+
# This is used to complete the identity challenge
28+
# with sigstore/fulcio when running outside of PRs.
29+
id-token: write
30+
31+
steps:
32+
- name: Checkout repository
33+
uses: actions/checkout@v3
34+
35+
# Install the cosign tool except on PR
36+
# https://github.com/sigstore/cosign-installer
37+
- name: Install cosign
38+
if: github.event_name != 'pull_request'
39+
uses: sigstore/cosign-installer@b3413d484cc23cf8778c3d2aa361568d4eb54679
40+
with:
41+
cosign-release: 'v1.9.0'
42+
43+
44+
# Workaround: https://github.com/docker/build-push-action/issues/461
45+
- name: Setup Docker buildx
46+
uses: docker/setup-buildx-action@dc7b9719a96d48369863986a06765841d7ea23f6
47+
48+
# Login against a Docker registry except on PR
49+
# https://github.com/docker/login-action
50+
- name: Log into registry ${{ env.REGISTRY }}
51+
if: github.event_name != 'pull_request'
52+
uses: docker/login-action@49ed152c8eca782a232dede0303416e8f356c37b
53+
with:
54+
registry: ${{ env.REGISTRY }}
55+
username: ${{ github.actor }}
56+
password: ${{ secrets.GITHUB_TOKEN }}
57+
58+
# Extract metadata (tags, labels) for Docker
59+
# https://github.com/docker/metadata-action
60+
- name: Extract Docker metadata
61+
id: meta
62+
uses: docker/metadata-action@69f6fc9d46f2f8bf0d5491e4aabe0bb8c6a4678a
63+
with:
64+
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
65+
66+
# Build and push Docker image with Buildx (don't push on PR)
67+
# https://github.com/docker/build-push-action
68+
- name: Build and push Docker image
69+
id: build-and-push
70+
uses: docker/build-push-action@ac9327eae2b366085ac7f6a2d02df8aa8ead720a
71+
with:
72+
context: .
73+
push: ${{ github.event_name != 'pull_request' }}
74+
tags: ${{ steps.meta.outputs.tags }}
75+
labels: ${{ steps.meta.outputs.labels }}
76+
77+
# Sign the resulting Docker image digest except on PRs.
78+
# This will only write to the public Rekor transparency log when the Docker
79+
# repository is public to avoid leaking data. If you would like to publish
80+
# transparency data even for private images, pass --force to cosign below.
81+
# https://github.com/sigstore/cosign
82+
- name: Sign the published Docker image
83+
if: ${{ github.event_name != 'pull_request' }}
84+
env:
85+
COSIGN_EXPERIMENTAL: "true"
86+
# This step uses the identity token to provision an ephemeral certificate
87+
# against the sigstore community Fulcio instance.
88+
run: echo "${{ steps.meta.outputs.tags }}" | xargs -I {} cosign sign {}@${{ steps.build-and-push.outputs.digest }}

‎.github/workflows/pages-build-deployment.yml

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: pages-build-deployment
2+
3+
on:
4+
# Runs on pushes targeting the default branch, change to gh-pages if on gh-pages branch
5+
push:
6+
branches: ["main"]
7+
8+
# Allows you to run this workflow manually from the Actions tab
9+
workflow_dispatch:
10+
11+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
12+
permissions:
13+
contents: read
14+
pages: write
15+
id-token: write
16+
17+
# Allow one concurrent deployment
18+
concurrency:
19+
group: "pages"
20+
cancel-in-progress: true
21+
22+
jobs:
23+
# Single deploy job since we're just deploying
24+
deploy:
25+
environment:
26+
name: github-pages
27+
url: ${{ steps.deployment.outputs.page_url }}
28+
runs-on: ubuntu-latest
29+
steps:
30+
- name: Checkout
31+
uses: actions/checkout@v3
32+
- name: Setup Pages
33+
uses: actions/configure-pages@v2
34+
- name: Upload artifact
35+
uses: actions/upload-pages-artifact@v1
36+
with:
37+
# Upload entire repository
38+
path: '.'
39+
- name: Deploy to GitHub Pages
40+
id: deployment
41+
uses: actions/deploy-pages@v1

0 commit comments

Comments
 (0)