Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
13 changes: 13 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# These are supported funding model platforms

github: [strelix, treyww]
patreon: # Replace with a single Patreon username
open_collective: # Replace with a single Open Collective username
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: 🐛 Report a bug
description: If you have found a bug on Strelix Core report it here!
title: "bug: "
labels: [bug]
body:
- type: markdown
attributes:
value: |

Hey there, thanks for creating a bug report, it's much appreciated!
> Note: This is strictly for **bug** reports for the **CORE** repository, issues regarding myfinances should be posted
on the [MyFinances Repo](https://github.com/Trey/MyFinances)

Before creating the bug report, please make sure that you have done the following steps:
- [ ] Only post **one** problem *per* bug report
- [ ] Updated to the latest [official release](https://github.com/Strelix/Core/releases)
- [ ] Update your database with the latest migrations `py manage.py migrate`

- type: input
id: version
validations:
required: true
attributes:
label: What version of Strelix-Core are you currently using?
description: You can view by using the command `git describe --tags`
placeholder: "v0.1.0"
- type: textarea
id: description
validations:
required: true
attributes:
label: Describe the bug
description: |
Please describe the bug in detail, make sure to list HOW you get the bug to come up (steps exactly what you follow, including the page path)
> To use code blocks, use ``` at the start and end of your code snippets. DO NOT USE SCREENSHOTS OF CODE.

You may attach images, please upload directly using github
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/2-ideas.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: 💡 Suggest a new feature
description: If you have an idea for the core repository, suggest it here!
title: "idea: "
labels: ["idea", "idea: suggested"]
body:
- type: markdown
attributes:
value: |

> Note: This is strictly for **feature requests**, issues setting up or bug reports be created with the "Report a Bug" form.

Before creating the feature request, please make sure that you have done the following steps:
- [ ] Checked our existing [MyFinances feature requests](https://github.com/TreyWW/MyFinances/issues?q=is%3Aissue+label%3Aidea+) [Core feature requests](https://github.com/TreyWW/MyFinances/issues?q=is%3Aissue+label%3Aidea+)
- [ ] Updated to the latest [official release](https://github.com/Strelix/Core/releases)

- type: dropdown
id: size
validations:
required: true
attributes:
label: What's the scope of this feature?
multiple: false
options:
- Small
- Medium
- Big feature
- type: textarea
id: problem
validations:
required: true
attributes:
label: Describe the problem
description: |
Please describe the problem needed to be solved in detail.

You may upload images through github and display them here.
- type: textarea
id: solution
validations:
required: false
attributes:
label: Describe a possible solution
description: |
[OPTIONAL] Please describe a potential solution to the problem that we may be able to solve.

Things you may want to address:
- Details of the technical implementation
- Tradeoffs made in design decisions
- Caveats and considerations for the future
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
blank_issues_enabled: false
contact_links:
- name: 💸 MyFinances
url: https://github.com/TreyWW/MyFinances/
about: Want to go to our main application repository? MyFinances!
- name: 🔍 View Issues
url: https://github.com/Strelix/Core/issues?q=is%3Aissue
about: If you have found an issue (or a bug), try searching our issues tab before reporting it.
- name: ❓ Need some help
url: https://github.com/Strelix/Core/discussions/categories/q-a
about: If you have a question or are stuck setting up the project, open a Q&A discussion!
# - name: 📖 View our documentation
# url: https://docs.strelix.org/?utm_source=github_issue_create
# about: Check out our documentation to get started! We have lots of helpful info in there
21 changes: 21 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates

version: 2
updates:
- package-ecosystem: "pip"
directory: "/"
open-pull-requests-limit: 0
schedule:
interval: "weekly"
- package-ecosystem: "docker"
directory: "/"
schedule:
interval: "weekly"
- package-ecosystem: "npm"
directory: "/"
open-pull-requests-limit: 0
schedule:
interval: "weekly"
7 changes: 7 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## Description

<!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. -->

## Related Info
- Related Issue #
- Closes # <!-- This automatically closes the issue upon merge -->
36 changes: 36 additions & 0 deletions .github/workflows/check_typos.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Check Typos
on:
push:
branches:
- main
pull_request:

jobs:
check-typos:
strategy:
fail-fast: true
matrix:
os: [ ubuntu-latest ]
python-version: [ "3.*" ]

runs-on: ${{ matrix.os }}

steps:
#----------------------------------------------
# check-out repo and set-up python
#----------------------------------------------
- name: Checkout code
uses: actions/checkout@v4

- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}

#----------------------------------------------
# check grammar with typos
#----------------------------------------------
- name: Check grammar with typos
run: |
pip3 install typos
typos
81 changes: 81 additions & 0 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
#
# ******** NOTE ********
# We have attempted to detect the languages in your repository. Please check
# the `language` matrix defined below to confirm you have the correct set of
# supported CodeQL languages.
#
name: "CodeQL"

on:
push:
branches: [ "main" ]
paths:
- 'src/**'
pull_request:
branches: [ "main" ]
paths:
- 'src/**'

jobs:
analyze:
name: Analyze
# Runner size impacts CodeQL analysis time. To learn more, please see:
# - https://gh.io/recommended-hardware-resources-for-running-codeql
# - https://gh.io/supported-runners-and-hardware-resources
# - https://gh.io/using-larger-runners
# Consider using larger runners for possible analysis time improvements.
runs-on: ubuntu-latest
timeout-minutes: 360
permissions:
# required for all workflows
security-events: write

# only required for workflows in private repositories
actions: read
contents: read

strategy:
fail-fast: false
matrix:
language: [ 'python' ]
# CodeQL supports [ 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift' ]
# Use only 'java-kotlin' to analyze code written in Java, Kotlin or both
# Use only 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support

steps:
- name: Checkout repository
uses: actions/checkout@v4

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v3
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.

# 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
# queries: security-extended,security-and-quality


# ℹ️ Command-line programs to run using the OS shell.
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun

# If the Autobuild fails above, remove it and uncomment the following three lines.
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.

# - run: |
# echo "Run, Build Application using script"
# ./location_of_script_within_repo/buildscript.sh

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v3
with:
category: "/language:${{matrix.language}}"
39 changes: 39 additions & 0 deletions .github/workflows/dependency-review.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Dependency Review Action
#
# This Action will scan dependency manifest files that change as part of a Pull Request,
# surfacing known-vulnerable versions of the packages declared or updated in the PR.
# Once installed, if the workflow run is marked as required, PRs introducing known-vulnerable
# packages will be blocked from merging.
#
# Source repository: https://github.com/actions/dependency-review-action
# Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement
name: 'Dependency review'
on:
pull_request:
branches: [ "main" ]

# If using a dependency submission action in this workflow this permission will need to be set to:
#
# permissions:
# contents: write
#
# https://docs.github.com/en/enterprise-cloud@latest/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api
permissions:
contents: read
# Write permissions for pull-requests are required for using the `comment-summary-in-pr` option, comment out if you aren't using this option
pull-requests: write

jobs:
dependency-review:
runs-on: ubuntu-latest
steps:
- name: 'Checkout repository'
uses: actions/checkout@v4
- name: 'Dependency Review'
uses: actions/dependency-review-action@v4
# Commonly enabled options, see hh for all available options.
with:
comment-summary-in-pr: always
# fail-on-severity: moderate
# deny-licenses: GPL-1.0-or-later, LGPL-2.0-or-later
# retry-on-snapshot-warnings: true
34 changes: 34 additions & 0 deletions .github/workflows/docs.yml.disabled
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Publish Docs
on:
push:
branches:
- main
paths:
- docs/**
- .github/workflows/docs.yml
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- uses: actions/setup-python@v5
with:
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v4
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material mkdocs-git-committers-plugin-2
- run: mkdocs gh-deploy --force
env:
UMAMI_PAGE_URL: ${{ secrets.UMAMI_PAGE_URL }}
UMAMI_WEBSITE_ID: ${{ secrets.UMAMI_WEBSITE_ID }}
51 changes: 51 additions & 0 deletions .github/workflows/publish_to_pypi.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Publish to PyPi
on:
push:
tags:
- v*
branches:
- 'main'
workflow_dispatch:

jobs:
# test:
# runs-on: ${{ matrix.os }}
# strategy:
# fail-fast: false
# matrix:
# os: [ ubuntu-latest ]
# python-version: [ "3.10", "3.11", "3.12" ]
# django-version: [ 4, 5 ]
# steps:
# - uses: actions/checkout@v4
#
# - uses: ./.github/actions/test
# with:
# python-version: ${{ matrix.python-version }}
# django-version: ${{ matrix.django-version }}

release:
runs-on: ubuntu-latest
# needs: [test]
environment: pypi
permissions:
id-token: write
steps:
- uses: actions/checkout@v4
- name: Setup python
uses: actions/setup-python@v2
with:
python-version: 3.11
- name: Install Dependencies
run: |
python -m pip install --upgrade pip
pip install build twine

- name: Build
run: python -m build

- name: Check
run: twine check dist/*

- name: Release
uses: pypa/gh-action-pypi-publish@release/v1
Loading
Loading