Repository: MarketingPipeline/Awesome-Repo-Template
Branch: main
Commit: 2d833654a1b2
Files: 22
Total size: 56.6 KB
Directory structure:
gitextract_dbir42hu/
├── .github/
│ ├── CHANGE_LOG.md
│ ├── CODEOWNERS
│ ├── CODE_OF_CONDUCT.md
│ ├── CONTRIBUTING.md
│ ├── ISSUE_TEMPLATE/
│ │ ├── bug_report.yaml
│ │ └── feature_request.yaml
│ ├── SECURITY.md
│ ├── TO_DO.md
│ ├── config.yml
│ ├── issue_label_bot.yaml
│ ├── pull_request_template.md
│ ├── py_repo_tools/
│ │ ├── generate_index_file.py
│ │ ├── replace_code_of_conduct_info.py
│ │ ├── replace_repo_links.py
│ │ ├── replace_security_policy_email.py
│ │ ├── repo_config.json
│ │ └── shell_scripts/
│ │ └── github_downloader.sh
│ ├── settings.yml
│ └── workflows/
│ └── Repo-Generator.yaml
├── LICENSE
├── README.md
└── index.html
================================================
FILE CONTENTS
================================================
================================================
FILE: .github/CHANGE_LOG.md
================================================
# Changelog
All notable changes to this project will be documented in this file.
## [Unreleased]
Upcoming changes.
### Added
### Changed
### Removed
## [0.0.1] - YYYY-MM-DD
Initial Release.
### Added
- What was added.
[Unreleased]: /
[0.0.1]: /v0.0.1
================================================
FILE: .github/CODEOWNERS
================================================
# These owners will be the default owners for everything in
# the repo. Unless a later match takes precedence,
# @MarketingPip will be requested for
# review when someone opens a pull request.
# if you want to add more owners just write it after the demo user @OctoCat
* @MarketingPip
================================================
FILE: .github/CODE_OF_CONDUCT.md
================================================
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
the following e-mail address example@hello.com.
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series
of actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within
the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
================================================
FILE: .github/CONTRIBUTING.md
================================================
# Contributing
There are a lot of different ways to contribute to this project. See below for
everything you can do and the processes to follow for each contribution method.
Note that no matter how you contribute, your participation is governed by our
[Code of Conduct](CODE_OF_CONDUCT.md).
## Make changes to the code or docs
Fork the project, make a change, and send a pull request!
Make sure you read and follow the instructions in the [pull request template](.github/pull_request_template.md). And note
that all participation in this project (including code submissions) is
governed by our [Code of Conduct](CODE_OF_CONDUCT.md).
## Submit bug reports or feature requests
Just use the GitHub issue tracker to submit your bug reports and feature
requests.
================================================
FILE: .github/ISSUE_TEMPLATE/bug_report.yaml
================================================
name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug", "triage"]
assignees:
- octocat
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: ex. email@example.com
validations:
required: false
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Describe the issue here.
placeholder: Tell us what you see!
value: "A bug happened!"
validations:
required: true
- type: dropdown
id: browsers
attributes:
label: What type of browser are you seeing the problem on?
multiple: true
options:
- Firefox
- Chrome
- Safari
- Microsoft Edge
validations:
required: true
- type: dropdown
id: operating-systems
attributes:
label: What type of Operating System are you seeing the problem on?
multiple: true
options:
- Linux
- Windows
- Mac
- Other
validations:
required: true
- type: textarea
id: logs
attributes:
label: Code to produce this issue.
description: Please copy and paste any relevant code to re-produce this issue. And the version of the browser you are using.
render: shell
================================================
FILE: .github/ISSUE_TEMPLATE/feature_request.yaml
================================================
name: Feature request
description: Suggest an feature / idea for this project
title: "[Feature Request / Suggestion]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
We appreciate your feedback on how to improve this project. Please be sure to include as much details & any resources if possible!
- type: textarea
id: Suggestion
attributes:
label: Suggestion / Feature Request
description: Describe the feature(s) you would like to see added.
placeholder: Tell us your suggestion
value: "Your suggestion here"
validations:
required: true
================================================
FILE: .github/SECURITY.md
================================================
# Security Policy
## Supported Versions
| Version | Supported |
| ------- | ------------------ |
| 5.1.x | :white_check_mark: |
| 5.0.x | :x: |
| 4.0.x | :white_check_mark: |
| < 4.0 | :x: |
## Reporting a Vulnerability
If you have identified a security vulnerability in system or product please email `example@hello.com` with your findings. We strongly recommend using our `PGP key` to prevent this information from falling into the wrong hands.
### Disclosure Policy
Upon receipt of a security report the following steps will be taken:
- Acknowledge your report within 48 hours, and provide a further more detailed update within 48 hours.
- Confirm the problem and determine the affected versions
- Keep you informed of the progress towards resolving the problem and notify you when the vulnerability has been fixed.
- Audit code to find any potential similar problems.
- Prepare fixes for all releases still under maintenance. These fixes will be released as fast as possible.
- Handle your report with strict confidentiality, and not pass on your personal details to third parties without your permission.
Whilst the issue is under investigation
- **Do** provide as much information as possible.
- **Do not** exploit of the vulnerability or problem you have discovered.
- **Do not** reveal the problem to others until it has been resolved.
================================================
FILE: .github/TO_DO.md
================================================
# To-Do
## Tasks (Sorted by Priority)
#### High
- [ ] Demo Task
- [ ] Demo Task
- [ ] Demo Task
- [ ] Demo Sub-Task
- [ ] Demo Sub-Task
#### Medium
- [ ] Demo Task
- [ ] Demo Task
- [ ] Demo Task
- [ ] Demo Sub-Task
- [ ] Demo Sub-Task
#### Low
- [ ] Demo Task
- [ ] Demo Task
- [ ] Demo Task
- [ ] Demo Sub-Task
- [ ] Demo Sub-Task
================================================
FILE: .github/config.yml
================================================
# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
# Comment to be posted to on first time issues
newIssueWelcomeComment: >
Thanks for opening your first issue! Reports like these help improve the project!
# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
# Comment to be posted to on PRs from first time contributors in your repository
newPRWelcomeComment: >
Thanks for opening this pull request!
# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
# Comment to be posted to on pull requests merged by a first time user
firstPRMergeComment: >
Congrats on merging your first pull request!
# The keyword to find for Todo Bot issue
todo:
keyword: '@todo'
================================================
FILE: .github/issue_label_bot.yaml
================================================
label-alias:
bug: 'Type: Bug'
feature_request: 'Type: Feature'
question: 'Type: Question'
================================================
FILE: .github/pull_request_template.md
================================================
## Proposed changes
Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.
## Types of changes
What types of changes does your code introduce to this project?
_Put an `x` in the boxes that apply_
- [ ] Bugfix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Documentation Update (if none of the other choices apply)
## Checklist
_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._
- [ ] I have read the CONTRIBUTING.md
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have added necessary documentation (if appropriate)
## Further comments
If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...
================================================
FILE: .github/py_repo_tools/generate_index_file.py
================================================
#! /usr/bin/env python
# -*- coding: utf-8 -*-
import sys
import os
import codecs
import urllib.request, json
API_URL = os.environ['INPUT_STORE']
with urllib.request.urlopen(f"{API_URL}") as url:
data = json.loads(url.read().decode())
SiteDescription = data['description']
SiteTitle = data['name']
Author = data['owner']['login']
# README File Path
input_file = "README.md"
input_file_contents = None
# Open our README file
try:
with open(input_file, 'r') as f:
input_file_contents = f.read()
except IOError:
sys.exit('README.md file does not exist, or has no content. Exiting')
output_file = "index.html"
# Write out the Index.HTML file
try:
with codecs.open(output_file, 'w', encoding='utf-8') as f:
f.write(f"""{SiteTitle}
""" + """
""" +
input_file_contents + """
""")
except IOError:
sys.exit(u'Unable to write to file: {0}'.format(output_file))
================================================
FILE: .github/py_repo_tools/replace_code_of_conduct_info.py
================================================
import json
# Opening JSON file
f = open('.github/py_repo_tools/repo_config.json')
# returns JSON object as
# a dictionary
config = json.load(f)
# Define the filename here you want to replace content in
FileName = ".github/CODE_OF_CONDUCT.md"
# Replace with string
Text_To_Replace = "example@hello.com"
# Replace with JSON value
Text_To_Replace_With = config['EMAIL']
# Closing file
f.close()
# Open the File
with open(FileName, 'r') as f:
# Read the file contents
contents = f.read()
# Replace the file contents
contents = contents.replace(Text_To_Replace, Text_To_Replace_With)
# Write the file out
with open(FileName, 'w') as f:
# Write the updated contents
f.write(contents)
================================================
FILE: .github/py_repo_tools/replace_repo_links.py
================================================
# Python program to read
# json file
import json
# Opening JSON file
f = open('.github/py_repo_tools/repo_config.json')
# returns JSON object as
# a dictionary
config = json.load(f)
# Define the filename here you want to replace content in
FileName = "README.md"
Text_To_Replace = config['Text_To_Replace']
Text_To_Replace_With = config['Text_To_Replace_With']
# Closing file
f.close()
# Open the File
with open(FileName, 'r') as f:
# Read the file contents
contents = f.read()
# Replace the file contents
contents = contents.replace(Text_To_Replace, Text_To_Replace_With)
# Write the file out
with open(FileName, 'w') as f:
# Write the updated contents
f.write(contents)
================================================
FILE: .github/py_repo_tools/replace_security_policy_email.py
================================================
import json
# Opening JSON file
f = open('.github/py_repo_tools/repo_config.json')
# returns JSON object as
# a dictionary
config = json.load(f)
# Define the filename here you want to replace content in
FileName = ".github/SECURITY.md"
# Replace with string
Text_To_Replace = "example@hello.com"
# Replace with JSON value
Text_To_Replace_With = config['EMAIL']
# Closing file
f.close()
# Open the File
with open(FileName, 'r') as f:
# Read the file contents
contents = f.read()
# Replace the file contents
contents = contents.replace(Text_To_Replace, Text_To_Replace_With)
# Write the file out
with open(FileName, 'w') as f:
# Write the updated contents
f.write(contents)
================================================
FILE: .github/py_repo_tools/repo_config.json
================================================
{"Text_To_Replace": "MarketingPipeline/Awesome-Repo-Template", "Text_To_Replace_With": "YOUR_GITHUB_USERNAME/Your-Repo-Name", "EMAIL" : "test@example.com"}
================================================
FILE: .github/py_repo_tools/shell_scripts/github_downloader.sh
================================================
#!/bin/bash
#####################################################
# Download Specific folders from Github using SVN
#
# Author: Declan Cook
# Licence: MIT
#####################################################
GHDOMAIN="https://github.com/"
IN=$1
IN=${IN##$GHDOMAIN}
BRANCH="trunk"
FOLDER=""
IFS="/" read -a SECT <<< "$IN"
if [[ "${SECT[3]}" != "master" ]]; then
BRANCH=${SECT[3]}
fi
for index in "${!SECT[@]}"; do
if [ $index -gt 3 ]; then
FOLDER=$FOLDER/${SECT[index]}
fi
done
# DOMAIN/USER/PROJECT//FOLDER
echo Exporting $GHDOMAIN${SECT[0]}/${SECT[1]}/$BRANCH$FOLDER
svn --force export $GHDOMAIN${SECT[0]}/${SECT[1]}/$BRANCH$FOLDER ./
================================================
FILE: .github/settings.yml
================================================
repository:
# See https://developer.github.com/v3/repos/#edit for all available settings.
# The name of the repository. Changing this will rename the repository
#name: repo-name
# A short description of the repository that will show up on GitHub
#description: description of repo
# A URL with more information about the repository
#homepage: https://example.github.io/
# A comma-separated list of topics to set on the repository
#topics: project, template, project-template
# Either `true` to make the repository private, or `false` to make it public.
#private: false
# Either `true` to enable issues for this repository, `false` to disable them.
#has_issues: true
# Either `true` to enable the wiki for this repository, `false` to disable it.
#has_wiki: true
# Either `true` to enable downloads for this repository, `false` to disable them.
#has_downloads: true
# Updates the default branch for this repository.
#default_branch: master
# Either `true` to allow squash-merging pull requests, or `false` to prevent
# squash-merging.
#allow_squash_merge: true
# Either `true` to allow merging pull requests with a merge commit, or `false`
# to prevent merging pull requests with merge commits.
#allow_merge_commit: true
# Either `true` to allow rebase-merging pull requests, or `false` to prevent
# rebase-merging.
#allow_rebase_merge: true
# Labels: define labels for Issues and Pull Requests
labels:
- name: 'Type: Bug'
color: e80c0c
description: Something isn't working as expected.
- name: 'Type: Enhancement'
color: 54b2ff
description: Suggest an improvement for an existing feature.
- name: 'Type: Feature'
color: 54b2ff
description: Suggest a new feature.
- name: 'Type: Security'
color: fbff00
description: A problem or enhancement related to a security issue.
- name: 'Type: Question'
color: 9309ab
description: Request for information.
- name: 'Type: Test'
color: ce54e3
description: A problem or enhancement related to a test.
- name: 'Status: Awaiting Review'
color: 24d15d
description: Ready for review.
- name: 'Status: WIP'
color: 07b340
description: Currently being worked on.
- name: 'Status: Waiting'
color: 38C968
description: Waiting on something else to be ready.
- name: 'Status: Stale'
color: 66b38a
description: Has had no activity for some time.
- name: 'Duplicate'
color: EB862D
description: Duplicate of another issue.
- name: 'Invalid'
color: faef50
description: This issue doesn't seem right.
- name: 'Priority: High +'
color: ff008c
description: Task is considered higher-priority.
- name: 'Priority: Low -'
color: 690a34
description: Task is considered lower-priority.
- name: 'Documentation'
color: 2fbceb
description: An issue/change with the documentation.
- name: "Won't fix"
color: C8D9E6
description: Reported issue is working as intended.
- name: '3rd party issue'
color: e88707
description: This issue might be caused by a 3rd party script/package/other reasons
- name: 'Os: Windows'
color: AEB1C2
description: Is Windows-specific
- name: 'Os: Mac'
color: AEB1C2
description: Is Mac-specific
- name: 'Os: Linux'
color: AEB1C2
description: Is Linux-specific
# # Collaborators: give specific users access to this repository.
# # See https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator for available options
# collaborators:
# # - username: bkeepers
# # permission: push
# # - username: hubot
# # permission: pull
# # Note: `permission` is only valid on organization-owned repositories.
# # The permission to grant the collaborator. Can be one of:
# # * `pull` - can pull, but not push to or administer this repository.
# # * `push` - can pull and push, but not administer this repository.
# # * `admin` - can pull, push and administer this repository.
# # * `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions.
# # * `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.
# # See https://developer.github.com/v3/teams/#add-or-update-team-repository for available options
# teams:
# - name: core
# # The permission to grant the team. Can be one of:
# # * `pull` - can pull, but not push to or administer this repository.
# # * `push` - can pull and push, but not administer this repository.
# # * `admin` - can pull, push and administer this repository.
# # * `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions.
# # * `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.
# permission: admin
# - name: docs
# permission: push
# branches:
# - name: master
# # https://developer.github.com/v3/repos/branches/#update-branch-protection
# # Branch Protection settings. Set to null to disable
# protection:
# # Required. Require at least one approving review on a pull request, before merging. Set to null to disable.
# required_pull_request_reviews:
# # The number of approvals required. (1-6)
# required_approving_review_count: 1
# # Dismiss approved reviews automatically when a new commit is pushed.
# dismiss_stale_reviews: true
# # Blocks merge until code owners have reviewed.
# require_code_owner_reviews: true
# # Specify which users and teams can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.
# dismissal_restrictions:
# users: []
# teams: []
# # Required. Require status checks to pass before merging. Set to null to disable
# required_status_checks:
# # Required. Require branches to be up to date before merging.
# strict: true
# # Required. The list of status checks to require in order to merge into this branch
# contexts: []
# # Required. Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.
# enforce_admins: true
# # Prevent merge commits from being pushed to matching branches
# required_linear_history: true
# # Required. Restrict who can push to this branch. Team and user restrictions are only available for organization-owned repositories. Set to null to disable.
# restrictions:
# apps: []
# users: []
# teams: []
================================================
FILE: .github/workflows/Repo-Generator.yaml
================================================
name: Repo Generator
on:
workflow_dispatch:
inputs:
Replace_Links_In_Markdown:
description: 'Update all links'
type: boolean
required: false
Update_Code_Of_Conduct_EMAIL:
description: 'Update Code Of Conduct Email'
type: boolean
required: false
Update_Security_Policy_EMAIL:
description: 'Update Security Policy Email'
type: boolean
required: false
Compress_Images:
description: 'Compress / Optimize Images'
type: boolean
required: false
Generate_Table_Of_Contents:
description: 'Generate Table Of Contents'
type: boolean
required: false
Generate_Metrics_File:
description: 'Generate Metrics Image File'
type: boolean
required: false
Generate_Index_File:
description: 'Generate Index File'
type: boolean
required: false
Download_Files_Or_Folder:
description: 'Download a file or folder from a GitHub Repo'
required: False
default: ''
jobs:
Repo_Builder:
name: Repo Template Builder
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
### Update links in README file
- name: Updating links in README content
if: ${{ github.event.inputs.Replace_Links_In_Markdown == 'true' }}
run: |
sudo apt-get install python3
python3 .github/py_repo_tools/replace_repo_links.py
### Metric Images
- name: Generating Metrics Image
if: ${{ github.event.inputs.Generate_Metrics_File == 'true' }}
uses: lowlighter/metrics@v3.24
with:
filename: stargazers-metrics.svg
filepath: /.github/
plugin_stargazers_charts_type: chartist
token: ${{ secrets.METRICS_TOKEN }}
base: ""
config_octicon: yes
plugin_stargazers: yes
plugin_contributors: yes
## - name: Move Metrics Image
# if: ${{ github.event.inputs.Generate_Metrics_File == 'true' }}
# run: |
# git mv -f ~/work/${{ github.event.repository.name }}/${{ github.event.repository.name }}/metrics.plugin.stargazers.svg ~/work/${{ github.event.repository.name }}/${{ github.event.repository.name }}/.github
### Table Of Contents
- name: Generating Table Of Contents
if: ${{ github.event.inputs.Generate_Table_Of_Contents == 'true' }}
run: |
npx markdown-toc-gen update README.md
### Generate Index File
- name: Generating Index File
if: ${{ github.event.inputs.Generate_Index_File == 'true' }}
run: |
sudo apt-get install python3
INPUT_STORE=${{ github.event.repository.url }} python3 .github/py_repo_tools/generate_index_file.py
### Optimize / Compress Image
- name: Optimizing Images
if: ${{ github.event.inputs.Compress_Images == 'true' }}
run: |
sudo apt-get install python3 python3-pip
pip3 install pillow optimize-images
optimize-images ./
### Replace COC E-mail
- name: Updating Code Of Conduct E-Mail
if: ${{ github.event.inputs.Update_Code_Of_Conduct_EMAIL == 'true' }}
run: |
sudo apt-get install python3
python3 .github/py_repo_tools/replace_code_of_conduct_info.py
### Replace Security Policy E-mail
- name: Updating Security Policy E-Mail
if: ${{ github.event.inputs.Update_Security_Policy_EMAIL == 'true' }}
run: |
sudo apt-get install python3
python3 .github/py_repo_tools/replace_security_policy_email.py
### Download a file or folder from a GitHub repo
- name: Downloading file / folder from GitHub Repo
if: ${{ github.event.inputs.Download_Files_Or_Folder != ''}}
run: |
chmod +x .github/py_repo_tools/shell_scripts/github_downloader.sh
.github/py_repo_tools/shell_scripts/github_downloader.sh ${{ github.event.inputs.Download_Files_Or_Folder}}
### Commit updates (if any)
- name: Commiting updates
run: |
git config --global user.name "github-actions[bot]"
git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
git add -A
git commit -m "Updated Content"
git push
================================================
FILE: LICENSE
================================================
MIT License
Copyright (c) 2022 Marketing Pipeline
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.
================================================
FILE: README.md
================================================
# Awesome-Repo-Template [](https://github.com/MarketingPipeline/Awesome-Repo-Template/)
A awesome repo template to kick-start your next project
Show your support!
## Features:
- A configurable workflow action to:
- update all links with your own with EASE!
- update Code Of Conduct E-mail with your own!
- update Security Policy E-mail with your own!
- download files & folder from another GitHub Repo
- compress / optimize all images in repo!
- generate a Markdown styled [index file](index.html) with SEO details!
- generate a table of contents in your README
- generate a star-gazer metrics SVG image
- Time Saving Files:
- [Pull request template](.github/pull_request_template.md)
- Issue templates for [bug reports](.github/ISSUE_TEMPLATE/bug_report.yaml) and
[feature requests](.github/ISSUE_TEMPLATE/feature_request.yaml)
- [Contributor guidelines](.github/CONTRIBUTING.md)
- [Code Owners](.github/CODEOWNERS)
- [Code of Conduct](.github/CODE_OF_CONDUCT.md)
- [Change-log](.github/CHANGE_LOG.md)
- [To-Do list](.github/TO_DO.md)
- [Security Policy](.github/SECURITY.md)
- [README](README.md)
- [License file](LICENSE)
- GitHub Bot Files
- [config.yml](/.github/config.yml) file to modify multiple bot's behaviours.
- [issue_label_bot.yaml](/.github/issue_label_bot.yaml) file to use the issue adder GitHub bot. [Activate it or check its documentation](https://github.com/marketplace/issue-label-bot).
- [settings.yml](/.github/settings.yml) file to use the popular settings GitHub bot. [Activate it or check its documentation](https://probot.github.io/apps/settings/).
## Example and Usage
How to use this template:
To run any of these tasks you MUST be in the Actions section
How to find the Action
How to replace all links with your own:
Edit the [repo_config.json](.github/py_repo_tools/repo_config.json) file & set the value for "REPLACE_TEXT_WITH" - to your username & repo name like the following example
MyUserName/My-Repo-Name
And run the Repo Generator in Actions - set "Update all links" to checked
How to replace e-mail in Code of Conduct with your own:
Edit the [repo_config.json](.github/py_repo_tools/repo_config.json) file & set the value for "EMAIL" - to your e-mail address like the following example.
hello_world@github.com
And run the Repo Generator in Actions- set "Update Code Of Conduct Info" to checked
How to replace e-mail in Security Policy with your own:
Edit the [repo_config.json](.github/py_repo_tools/repo_config.json) file & set the value for "EMAIL" - to your e-mail address like the following example.
hello_world@github.com
And run the Repo Generator in Actions- set "Update Security Info" to checked
How to download file(s) / folder(s) from another GitHub repo
WARNING
files downloaded from a repo containing the same name in your current repo will be OVER-WRITTEN.
In the Repo Generator Actions- set "Download a file or folder from a GitHub Repo" to a GitHub file path or folder.
Example(s)
To download a single file:
https://github.com/Repo-Owner-UserName/Repo-Name/blob/master/README.md
To download a specific folder:
https://github.com/Repo-Owner-UserName/Repo-Name/blob/master/Folder-Name
To download all files in a repo folder:
https://github.com/Repo-Owner-UserName/Repo-Name/blob/master/
Note: File's will be placed into main repo path.
How to generate a index.html file
A index.html file will be produced from your README content.
SEO details such as Title, Description & OG images etc are auto-produced using your Repo details.
Note Your README content will be rendered in Github Flavored Markdown using our tool [Markdown-Tag: Add Markdown to any HTML using a tag](https://github.com/MarketingPipeline/Markdown-Tag)
Go to the Repo Generator in Actions- set "Generate Index File" to checked
How to compress / optimize images in repo
Note: All images in repo will be compressed / optimized (SVG's are NOT supported)
Go to the Repo Generator in Actions- set "Compress / Optimize Images" to checked
How to generate Table Of Contents:
To generate tables of contents automatically use anywhere in your README.md file a comment like so
<!-- toc -->
<!-- tocstop -->
And when running the Repo Generator in Actions - set "Generate Table Of Contents" to checked
WARNING: Only 1 table of contents can be generated in a README - if you use more than one you WILL face problems.
How to Generate a Metrics Image:
Create a Personal Access Token & create a repo secret called "METRICS_TOKEN" & when running the Repo Generator - set "Generate Metrics Image File" to checked
You will have an image generated that looks like this!
It will be placed in the main repo under the filename stargazers-metrics.svg
Note: if someone knows how to change this please make a pull request with the image placed to .github folder!
Shield.io Buttons:
_Repo metadata_
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/blob/master/LICENSE)
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/issues)
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/issues?utf8=✓&q=is%3Aissue+is%3Aclosed)
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/pulls)
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/pulls?utf8=✓&q=is%3Apr+is%3Aclosed)
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/graphs/commit-activity)
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/graphs/contributors)
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/commits/master)
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/releases/)
_Social buttons_
[](https://github.com/MarketingPipeline/Awesome-Repo-Template "Go to GitHub repo")
[](https://github.com/MarketingPipeline/Awesome-Repo-Template)
[](https://github.com/MarketingPipeline/Awesome-Repo-Template)
_Call-to-Action buttons_
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/generate)
[](https://marketingpip.github.io/Awesome-Repo-Template/)
_Documentation button_
[](/README.MD "Go to project documentation")
_Custom button_
Auto Generated Table Of Contents Demo:
- [Features:](#features)
- [Example and Usage](#example-and-usage)
- [Contributing  ](#contributing-a-hrefhttpsgithubcommarketingpipelineawesome-repo-templategraphscontributors-githubhttpsimgshieldsiogithubcontributorsmarketingpipelineawesome-repo-template-a)
- [License  ](#license-a-hreflicense-githubhttpsimgshieldsiogithublicensemarketingpipelineawesome-repo-template-a)
How to setup GitHub bots
These are bots that are prepared and configured for this template. They need to be activated to properly work.
1. The `issue_label_bot.yaml` file depends on the **issue label bot** [Activate it or check its documentation](https://github.com/marketplace/issue-label-bot)(✓ highly recommended).
2. The `settings.yml` file depends on the **settings label bot** [Activate it or check its documentation](https://probot.github.io/apps/settings/) (optional).
3. The `config.yml` file depends on the bot **welcome bot** [Activate it or check its documentation](https://probot.github.io/apps/welcome/) and [to-do bot](https://probot.github.io/apps/todo/) (optional).
## Contributing 
Want to improve this template? Create a pull request with detailed changes / improvements! If approved you will be added to the list of contributors of this awesome repo template!
See also the list of
[contributors](https://github.com/MarketingPipeline/Awesome-Repo-Template/graphs/contributors) who
participate in this project.
## License 
This project is licensed under the MIT License - see the
[LICENSE.md](https://github.com/MarketingPipeline/Awesome-Repo-Template/blob/main/LICENSE) file for
details.
================================================
FILE: index.html
================================================
Awesome-Repo-Template
# Awesome-Repo-Template [](https://github.com/MarketingPipeline/Awesome-Repo-Template/)
A awesome repo template to kick-start your next project
Show your support!
## Features:
- A configurable workflow action to:
- update all links with your own with EASE!
- update Code Of Conduct E-mail with your own!
- update Security Policy E-mail with your own!
- compress / optimize all images in repo!
- generate a Markdown styled [index file](index.html) with SEO details!
- generate a table of contents in your README
- generate a star-gazer metrics SVG image
- Time Saving Files:
- [Pull request template](.github/pull_request_template.md)
- Issue templates for [bug reports](.github/ISSUE_TEMPLATE/bug_report.yaml) and
[feature requests](.github/ISSUE_TEMPLATE/feature_request.yaml)
- [Contributor guidelines](CONTRIBUTING.md)
- [Code of Conduct](CODE_OF_CONDUCT.md)
- [Change-log](.github/CHANGE_LOG.md)
- [To-Do list](.github/TO_DO.md)
- [Security Policy](.github/SECURITY.md)
- [README](README.md)
- [License file](LICENSE)
## Example and Usage
How to use this template:
To run any of these tasks you MUST be in the Actions section
How to find the Action
How to replace all links with your own:
Edit the [repo_config.json](.github/py_repo_tools/repo_config.json) file & set the value for "REPLACE_TEXT_WITH" - to your username & repo name like the following example
MyUserName/My-Repo-Name
And run the Repo Generator in Actions - set "Update all links" to checked
How to replace e-mail in Code of Conduct with your own:
Edit the [repo_config.json](.github/py_repo_tools/repo_config.json) file & set the value for "EMAIL" - to your e-mail address like the following example.
hello_world@github.com
And run the Repo Generator in Actions- set "Update Code Of Conduct Info" to checked
How to replace e-mail in Security Policy with your own:
Edit the [repo_config.json](.github/py_repo_tools/repo_config.json) file & set the value for "EMAIL" - to your e-mail address like the following example.
hello_world@github.com
And run the Repo Generator in Actions- set "Update Security Info" to checked
How to compress / optimize images in repo
Note: All images in repo will be compressed / optimized (SVG's are NOT supported)
Go to the Repo Generator in Actions- set "Compress / Optimize Images" to checked
How to generate Table Of Contents:
To generate tables of contents automatically use anywhere in your README.md file a comment like so
<!-- toc -->
<!-- tocstop -->
And when running the Repo Generator in Actions - set "Generate Table Of Contents" to checked
WARNING: Only 1 table of contents can be generated in a README - if you use more than one you WILL face problems.
How to Generate a Metrics Image:
Create a Personal Access Token & create a repo secret called "METRICS_TOKEN" & when running the Repo Generator - set "Generate Metrics Image File" to checked
You will have an image generated that looks like this!
It will be placed in the main repo under the filename stargazers-metrics.svg
Note: if someone knows how to change this please make a pull request with the image placed to .github folder!
Shield.io Buttons:
_Repo metadata_
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/blob/master/LICENSE)
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/issues)
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/issues?utf8=✓&q=is%3Aissue+is%3Aclosed)
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/pulls)
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/pulls?utf8=✓&q=is%3Apr+is%3Aclosed)
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/graphs/commit-activity)
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/graphs/contributors)
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/commits/master)
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/releases/)
_Social buttons_
[](https://github.com/MarketingPipeline/Awesome-Repo-Template "Go to GitHub repo")
[](https://github.com/MarketingPipeline/Awesome-Repo-Template)
[](https://github.com/MarketingPipeline/Awesome-Repo-Template)
_Call-to-Action buttons_
[](https://github.com/MarketingPipeline/Awesome-Repo-Template/generate)
[](https://marketingpip.github.io/Awesome-Repo-Template/)
_Documentation button_
[](/README.MD "Go to project documentation")
_Custom button_
Auto Generated Table Of Contents Demo:
- [Features:](#features)
- [Example and Usage](#example-and-usage)
- [Contributing  ](#contributing-a-hrefhttpsgithubcommarketingpipelineawesome-repo-templategraphscontributors-githubhttpsimgshieldsiogithubcontributorsmarketingpipelineawesome-repo-template-a)
- [License  ](#license-a-hreflicense-githubhttpsimgshieldsiogithublicensemarketingpipelineawesome-repo-template-a)