Skip to content

Commit

Permalink
Standardise configuration files
Browse files Browse the repository at this point in the history
  • Loading branch information
JoelLefkowitz committed May 26, 2024
1 parent e27019a commit 5dbc797
Show file tree
Hide file tree
Showing 53 changed files with 2,074 additions and 10,894 deletions.
1 change: 0 additions & 1 deletion .bandit

This file was deleted.

12 changes: 4 additions & 8 deletions .bumpversion.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,10 @@ tag = True
commit = True
current_version = 1.1.3

[bumpversion:file:setup.cfg]
search = version = {current_version}
replace = version = {new_version}

[bumpversion:file:.quickdocs.yml]
search = version: {current_version}
replace = version: {new_version}
[bumpversion:file:pyproject.toml]
search = version = "{current_version}"
replace = version = "{new_version}"

[bumpversion:file:docs/conf.py]
[bumpversion:file:docs/sphinx/conf.py]
search = version = "{current_version}"
replace = version = "{new_version}"
122 changes: 31 additions & 91 deletions .cspell.json
Original file line number Diff line number Diff line change
@@ -1,118 +1,58 @@
{
"language": "en",
"ignorePaths": [
"./.cspell.txt",
"**/package-lock.json",
".gitignore",
"*.coverage",
"*.types",
"**/__pycache__/**",
"**/*.egg-info/**",
"**/build/**",
"**/coverage/**",
"**/dist/**",
"**/node_modules/**",
"**/sqlite3",
"**/venv/**"
],
"dictionaries": [
"aws",
"bash",
"en-gb",
"fullstack",
"misc",
"node",
"python",
"softwareTerms",
"typescript",
"local"
"softwareTerms"
],
"ignorePaths": [".git"],
"words": [
"apidoc",
"applehelp",
"autodoc",
"autoapi",
"autoflake",
"backports",
"balsamiq",
"autosummary",
"bumpversion",
"certifi",
"chardet",
"chflags",
"cobertura",
"codacy",
"conftest",
"dataclasses",
"devhelp",
"digitalocean",
"debugpy",
"doctest",
"docutils",
"entrypoint",
"envlist",
"excalidraw",
"excinst",
"exctb",
"favicon",
"fmarkdown",
"fontobject",
"fullchain",
"genindex",
"gruntfile",
"hashicorp",
"hostvars",
"htmlhelp",
"idna",
"imagesize",
"instrumenter",
"exctype",
"furo",
"giphy",
"grotesk",
"isfile",
"isort",
"joellefkowitz",
"jsmath",
"keycap",
"lastmod",
"lchflags",
"lchown",
"lefkowitz",
"letsencrypt",
"listdir",
"maxdepth",
"matplotlib",
"mkfifo",
"mknod",
"modindex",
"nargs",
"noqa",
"nosec",
"opentype",
"pandoc",
"pandocfilters",
"precommit",
"preconnect",
"preprocessors",
"privkey",
"proxied",
"mypy",
"opengraph",
"pathconf",
"pycache",
"pylint",
"pylintrc",
"pypandoc",
"pyparsing",
"pypa",
"pypi",
"pyproject",
"pytest",
"pytz",
"qthelp",
"quickdocs",
"rcfile",
"remarkrc",
"roadmap",
"serializinghtml",
"serviceworker",
"setuptools",
"skipsdist",
"snowballstemmer",
"sphinxcontrib",
"scandir",
"sdist",
"searchindex",
"sphinxext",
"statvfs",
"subpackages",
"testcafe",
"testenv",
"toctree",
"truetype",
"trufflehog",
"undoc",
"unimported",
"urlset",
"venv",
"workdir",
"xdescribe",
"xmlid",
"yusei"
"walkmate"
]
}


21 changes: 6 additions & 15 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,20 @@ about: Report a bug

## Description

<!-- edit: --> A clear and concise description of the problem...

## Is this a regression?

<!-- Did this behavior use to work in the previous version? -->
<!-- edit: --> Yes, the previous version in which this bug was not present was: ...
...

## Minimal Reproduction

```code
```
...

## Stack trace / Error message
## Stack trace

```code
...
```

<!-- If the issue is accompanied by an exception or an error, please share it below: -->

## Your Environment
## Environment

```code
...
```
10 changes: 3 additions & 7 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,8 @@ about: Suggest a feature

## Description

<!-- edit: --> A clear and concise description of the problem or missing capability...
...

## Describe the solution you'd like
## Alternatives

<!-- edit: --> If you have a solution in mind, please describe it.

## Describe alternatives you've considered

<!-- edit: --> Have you considered any alternative solutions or workarounds?
...
39 changes: 15 additions & 24 deletions .github/PULL_REQUEST_TEMPLATE/general.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,22 @@
# PR Checklist
---
name: "Pull Request"
about: Open a pull request
---

Please check if your PR fulfills the following requirements:
# Pull Request

- [ ] The commit message follows our contributing guidelines
- [ ] Tests for the changes have been added (for bug fixes / features)
- [ ] Docs have been added / updated (for bug fixes / features)
## Description

## PR Type
...

What kind of change does this PR introduce?
## Current Behavior

- [ ] Bugfix
- [ ] Feature
- [ ] Code style update
- [ ] Refactoring (no functional changes)
- [ ] Build related changes
- [ ] CI related changes
- [ ] Documentation content changes
- [ ] Other
```code
...
```

## What is the current behavior?
## New Behavior

## What is the new behavior?

## Does this PR introduce a breaking change?

- [ ] Yes
- [ ] No

## Other information
```code
...
```
27 changes: 27 additions & 0 deletions .github/actions/install/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Install
description: Install dependencies

inputs:
python-version:
description: Python version
default: "3.10"

runs:
using: composite
steps:
- name: Checkout the source code
uses: actions/checkout@v4

- name: Set the python version
uses: actions/setup-python@v5
with:
python-version: ${{ inputs.python-version }}
cache: pip

- name: Install pip dependencies
shell: bash
run: pip install .[all]

- name: Install apt dependencies
shell: bash
run: sudo apt-get install -y doxygen
48 changes: 48 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Docs

on:
push:
tags:
- "*.*.*"

concurrency:
group: "pages"
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout the source code
uses: actions/checkout@v4

- name: Install dependencies
uses: ./.github/actions/install

- name: Setup GitHub Pages
uses: actions/configure-pages@v4

- name: Build the docs
run: thx docs

- name: Upload the artifacts
uses: actions/upload-pages-artifact@v3
with:
path: "docs/dist"

deploy:
permissions:
pages: write
id-token: write

runs-on: ubuntu-latest
needs: build

environment:
name: Pages
url: ${{ steps.deployment.outputs.page_url }}

steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
30 changes: 15 additions & 15 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,29 @@ name: Publish

on:
push:
tags: "v*.*.*"
tags:
- "*.*.*"

jobs:
publish:
name: Publish the package on pypi
runs-on: ubuntu-latest

permissions:
id-token: write

environment:
name: PyPI
url: https://pypi.org/p/miniscons

steps:
- name: Checkout the source code
uses: actions/checkout@v2

- name: Set the python version
uses: actions/setup-python@v2
with:
python-version: 3.6
uses: actions/checkout@v4

- name: Install pip dependencies
run: pip install .[all]
- name: Install dependencies
uses: ./.github/actions/install

- name: Build the distributions
run: python setup.py sdist bdist_wheel
- name: Build the package
run: python -m build

- name: Publish the package
uses: pypa/gh-action-pypi-publish@release/v1
with:
user: __token__
password: ${{ secrets.PYPI_API_TOKEN }}
Loading

0 comments on commit 5dbc797

Please sign in to comment.