Skip to content

Commit

Permalink
feat: create initial project structure
Browse files Browse the repository at this point in the history
  • Loading branch information
lyz-code committed Nov 24, 2020
0 parents commit a27362e
Show file tree
Hide file tree
Showing 83 changed files with 3,791 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Bug
about: Create a bug report to help us improve yamlfix
labels: bug
---

## Description
<!-- A clear and concise description of what the bug is. -->

## Steps to reproduce
<!-- Steps to reproduce the behavior:
1. Run ...
2. ...
3. ... -->

## Current behavior
<!-- What happens actually so you think this is a bug. -->

## Desired behavior
<!--
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.
-->

## Environment
<!--
make version
# or
python -c "import yamlfix.version; print(yamlfix.version.version_info())"
-->
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Feature Request
about: Suggest a new feature or change to yamlfix
labels: feature request
---

## Description
<!-- A clear and concise description for us to know your idea. -->

## Possible Solution
<!-- A clear and concise description of what you want to happen. -->

## Additional context
<!-- Add any other context or screenshots about the feature request here. -->

## Related Issue
<!-- If applicable, add link to existing issue also help us know better. -->
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: Question
about: Ask a question about how to use yamlfix
labels: question
---

<!--
* [ ] I added a descriptive title to this issue.
* [ ] I have searched (google, github) for similar issues and couldn't find
anything.
* [ ] I have read and followed [the docs](https://lyz-code.github.io/yamlfix)
and couldn't find an answer.
-->

## Question
12 changes: 12 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!--
Thank you for sending a pull request!
Please fill in the following content to let us know better about this change.
-->

## Description
<!-- Describe what the change is, try to link it with open issues -->

## Checklist

* [ ] Add test cases to all the changes you introduce
* [ ] Update the documentation for the changes
19 changes: 19 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Security Policy

## Supported Versions

We will endeavour to support:

* The most recent minor release with bug fixes.
* The latest minor release from the last major version for 6 months after a new
major version is released with critical bug fixes.
* All versions if a security vulnerability is found provided:
* Upgrading to a later version is non-trivial.
* Sufficient people are using that version to make support worthwhile.

## Reporting a Vulnerability

If you find what you think might be a security vulnerability with
yamlfix, please do not create an issue on github. Instead please
email [email protected] I'll reply to your email promptly
and try to get a patch out ASAP.
8 changes: 8 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
version: 2

updates:
- package-ecosystem: pip
directory: /
schedule:
interval: weekly
67 changes: 67 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
name: Build

on: # yamllint disable-line rule:truthy
push:
branches:
- master

jobs:
PyPI:
name: Build and publish Python distributions to PyPI and TestPyPI
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: Set up Python 3.7
uses: actions/setup-python@v1
with:
python-version: 3.7
- name: Install PEP517
run: >-
python -m
pip install
pep517
--user
- name: Build a binary wheel and a source tarball
run: >-
python -m
pep517.build
--source
--binary
--out-dir dist/
.
- name: Publish distribution to Test PyPI
uses: pypa/gh-action-pypi-publish@master
with:
password: ${{ secrets.test_pypi_password }}
repository_url: https://test.pypi.org/legacy/
skip_existing: true
- name: Publish distribution to PyPI
if: startsWith(github.ref, 'refs/tags')
uses: pypa/gh-action-pypi-publish@master
with:
password: ${{ secrets.pypi_password }}
Documentation:
runs-on: ubuntu-18.04
steps:
- name: Checkout
uses: actions/checkout@v2
with:
# Number of commits to fetch. 0 indicates all history.
# Default: 1
fetch-depth: 0
- uses: actions/setup-python@v2
with:
python-version: 3.7
- name: Install dependencies
run: >-
pip install -r ./docs/requirements.txt
pip install -e .
- name: Build the Documentation
run: |
mkdocs build
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
publish_dir: ./site
80 changes: 80 additions & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
name: Tests

on: # yamllint disable-line rule:truthy
push:
branches:
- '*' # matches every branch that doesn't contain a '/'
- '*/*' # matches every branch containing a single '/'
- '**' # matches every branch
- '!gh-pages' # excludes gh-pages

jobs:
Tests:
runs-on: ubuntu-latest
strategy:
max-parallel: 3
matrix:
python-version: [3.6, 3.7, 3.8]

steps:
- uses: actions/checkout@v1
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v1
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: make install
- name: Test linters
run: make lint
- name: Test type checkers
run: make mypy
- name: Test security
run: make security
- name: Test with pytest
run: make test
- name: Upload Coverage
run: |
pip3 install coveralls
coveralls
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
COVERALLS_FLAG_NAME: ${{ matrix.test-name }}
COVERALLS_PARALLEL: true
- name: Test documentation
run: make build-docs
Coveralls:
name: Finish Coveralls
needs: Pytest
runs-on: ubuntu-latest
container: python:3-slim
steps:
- name: Finished
run: |
pip3 install coveralls
coveralls --finish
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Python_Package:
name: Build the Python package
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: Set up Python 3.7
uses: actions/setup-python@v1
with:
python-version: 3.7
- name: Install PEP517
run: >-
python -m
pip install
pep517
--user
- name: Build a binary wheel and a source tarball
run: >-
python -m
pep517.build
--source
--binary
--out-dir dist/
.
Loading

0 comments on commit a27362e

Please sign in to comment.