Skip to content

Commit 0f4dea2

Browse files
ArchmongerArchmonger
authored
Refactor the repo, and new docs styling (#29)
1 parent 3dd9777 commit 0f4dea2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

93 files changed

+2801
-1099
lines changed

‎.github/CODEOWNERS

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @reactive-python/maintainers

‎.github/FUNDING.yml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# These are supported funding model platforms
2+
3+
github: [archmonger]
4+
patreon: # Replace with a single Patreon username
5+
open_collective: # Replace with a single Open Collective username
6+
ko_fi: # Replace with a single Ko-fi username
7+
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
liberapay: # Replace with a single Liberapay username
10+
issuehunt: # Replace with a single IssueHunt username
11+
otechie: # Replace with a single Otechie username
12+
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

‎.github/ISSUE_TEMPLATE/bug_report.md

-24
This file was deleted.

‎.github/ISSUE_TEMPLATE/config.yml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Start a Discussion
4+
url: https://github.com/reactive-python/reactpy-router/discussions
5+
about: Report issues, request features, ask questions, and share ideas

‎.github/ISSUE_TEMPLATE/doc_enhancement.md

-14
This file was deleted.

‎.github/ISSUE_TEMPLATE/feature_request.md

-20
This file was deleted.

‎.github/ISSUE_TEMPLATE/issue-form.yml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Plan a Task
2+
description: Create a detailed plan of action (ONLY START AFTER DISCUSSION PLEASE 🙏).
3+
labels: ["flag: triage"]
4+
body:
5+
- type: textarea
6+
attributes:
7+
label: Current Situation
8+
description: Discuss how things currently are, why they require action, and any relevant prior discussion/context.
9+
validations:
10+
required: false
11+
- type: textarea
12+
attributes:
13+
label: Proposed Actions
14+
description: Describe what ought to be done, and why that will address the reasons for action mentioned above.
15+
validations:
16+
required: false

‎.github/pull_request_template.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## Description
2+
3+
<!-- A summary of the changes. -->
4+
5+
## Checklist
6+
7+
Please update this checklist as you complete each item:
8+
9+
- [ ] Tests have been developed for bug fixes or new functionality.
10+
- [ ] The changelog has been updated, if necessary.
11+
- [ ] Documentation has been updated, if necessary.
12+
- [ ] GitHub Issues closed by this PR have been linked.
13+
14+
<sub>By submitting this pull request I agree that all contributions comply with this project's open source license(s).</sub>

‎.github/workflows/codeql.yml

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# For most projects, this workflow file will not need changing; you simply need
2+
# to commit it to your repository.
3+
#
4+
# You may wish to alter this file to override the set of languages analyzed,
5+
# or to provide custom queries or build logic.
6+
#
7+
# ******** NOTE ********
8+
# We have attempted to detect the languages in your repository. Please check
9+
# the `language` matrix defined below to confirm you have the correct set of
10+
# supported CodeQL languages.
11+
#
12+
name: "CodeQL"
13+
14+
on:
15+
push:
16+
branches: [ "main" ]
17+
pull_request:
18+
# The branches below must be a subset of the branches above
19+
branches: [ "main" ]
20+
schedule:
21+
# Runs at 22:21 on Monday.
22+
- cron: '21 22 * * 1'
23+
24+
jobs:
25+
analyze:
26+
name: Analyze
27+
runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
28+
timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }}
29+
permissions:
30+
actions: read
31+
contents: read
32+
security-events: write
33+
34+
strategy:
35+
fail-fast: false
36+
matrix:
37+
language: [ 'javascript', 'python' ]
38+
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby', 'swift' ]
39+
# Use only 'java' to analyze code written in Java, Kotlin or both
40+
# Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
41+
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
42+
43+
steps:
44+
- name: Checkout repository
45+
uses: actions/checkout@v3
46+
47+
# Initializes the CodeQL tools for scanning.
48+
- name: Initialize CodeQL
49+
uses: github/codeql-action/init@v2
50+
with:
51+
languages: ${{ matrix.language }}
52+
# If you wish to specify custom queries, you can do so here or in a config file.
53+
# By default, queries listed here will override any specified in a config file.
54+
# Prefix the list here with "+" to use these queries and those in the config file.
55+
56+
# For more 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
57+
# queries: security-extended,security-and-quality
58+
59+
60+
# Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
61+
# If this step fails, then you should remove it and run the build manually (see below)
62+
- name: Autobuild
63+
uses: github/codeql-action/autobuild@v2
64+
65+
# ℹ️ Command-line programs to run using the OS shell.
66+
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
67+
68+
# If the Autobuild fails above, remove it and uncomment the following three lines.
69+
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
70+
71+
# - run: |
72+
# echo "Run, Build Application using script"
73+
# ./location_of_script_within_repo/buildscript.sh
74+
75+
- name: Perform CodeQL Analysis
76+
uses: github/codeql-action/analyze@v2
77+
with:
78+
category: "/language:${{matrix.language}}"

‎.github/workflows/publish-develop-docs.yml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Publish Develop Docs
2+
on:
3+
push:
4+
branches:
5+
- main
6+
jobs:
7+
deploy:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: actions/checkout@v3
11+
with:
12+
fetch-depth: 0
13+
- uses: actions/setup-python@v4
14+
with:
15+
python-version: 3.x
16+
- run: pip install -r requirements/build-docs.txt
17+
- name: Publish Develop Docs
18+
run: |
19+
git config user.name github-actions
20+
git config user.email [email protected]
21+
cd docs
22+
mike deploy --push develop

‎.github/workflows/publish-docs.yaml

-21
This file was deleted.

‎.github/workflows/publish-py.yaml

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# This workflows will upload a Python Package using Twine when a release is created
2+
# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
3+
4+
name: Publish Python
5+
6+
on:
7+
release:
8+
types: [published]
9+
10+
jobs:
11+
publish-package:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@v3
15+
- name: Set up Python
16+
uses: actions/setup-python@v4
17+
with:
18+
python-version: "3.x"
19+
- name: Install dependencies
20+
run: |
21+
python -m pip install --upgrade pip
22+
pip install -r requirements/build-pkg.txt
23+
- name: Build and publish
24+
env:
25+
TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
26+
TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
27+
run: |
28+
python setup.py bdist_wheel
29+
twine upload dist/*

‎.github/workflows/publish-release-docs.yml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Publish Release Docs
2+
3+
on:
4+
release:
5+
types: [published]
6+
7+
jobs:
8+
deploy:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v3
12+
with:
13+
fetch-depth: 0
14+
- uses: actions/setup-python@v4
15+
with:
16+
python-version: 3.x
17+
- run: pip install -r requirements/build-docs.txt
18+
- name: Publish ${{ github.event.release.name }} Docs
19+
run: |
20+
git config user.name github-actions
21+
git config user.email [email protected]
22+
cd docs
23+
mike deploy --push --update-aliases ${{ github.event.release.name }} latest

‎.github/workflows/release.yaml

-30
This file was deleted.

‎.github/workflows/test-docs.yml

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Test
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
branches:
9+
- main
10+
schedule:
11+
- cron: "0 0 * * *"
12+
13+
jobs:
14+
docs:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- uses: actions/checkout@v3
18+
with:
19+
fetch-depth: 0
20+
- uses: actions/setup-python@v4
21+
with:
22+
python-version: 3.x
23+
- name: Check docs build
24+
run: |
25+
pip install -r requirements/build-docs.txt
26+
linkcheckMarkdown docs/ -v -r
27+
linkcheckMarkdown README.md -v -r
28+
linkcheckMarkdown CHANGELOG.md -v -r
29+
cd docs
30+
mkdocs build --strict
31+
- name: Check docs examples
32+
run: |
33+
pip install -r requirements/check-types.txt
34+
pip install -r requirements/check-style.txt
35+
mypy --show-error-codes docs/examples/python/
36+
black docs/examples/python/ --check
37+
ruff check docs/examples/python/

0 commit comments

Comments
 (0)