Merge branch 'main' into config-schema

This commit is contained in:
Psyi Rius 2024-08-09 08:02:01 -07:00 committed by GitHub
commit 77e5c254a5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 86 additions and 20 deletions

View File

@ -7,5 +7,3 @@ updates:
ignore: ignore:
- dependency-name: "actions/stale" - dependency-name: "actions/stale"
versions: '>= 9' versions: '>= 9'
- dependency-name: "actions/setup-python"
versions: '> 4'

View File

@ -1,25 +1,31 @@
name: GitHub Pages Deploy name: GitHub Pages Deploy
on: on:
release: release:
types: [published, prereleased] types: [published, prereleased]
workflow_dispatch: workflow_dispatch:
permissions: permissions:
contents: write contents: write
jobs: jobs:
deploy: deploy:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v4 - name: Checkout Repository
- uses: actions/setup-python@v4 uses: actions/checkout@v4
with: with:
python-version: 3.x fetch-depth: '0' # Fetch all commit history for all branches as well as tags.
- uses: actions/cache@v4
- name: Setup Python
uses: actions/setup-python@v5
with: with:
key: ${{ github.ref }} python-version: 3.x # Install latest Stable release of Python 3
path: .cache cache: 'pip' # caching pip dependencies
- run: pip install mkdocs-material
- run: pip install pillow cairosvg - name: Install Necessary Dependencies using 'pip install -r requirements.txt'
- run: pip install mkdocs-awesome-pages-plugin run: pip install -r requirements.txt
- run: pip install mkdocs-git-revision-date-localized-plugin
- run: pip install mkdocs-minify-plugin - name: Build & Deploy using 'mkdocs'
- run: mkdocs gh-deploy --force run: mkdocs gh-deploy --force

View File

@ -46,18 +46,20 @@
### Overview ### Overview
``` mermaid ``` mermaid
graph LR %%{init: {"flowchart": {"curve": "cardinal"}} }%%
graph TD
  A[Fork Project] --> B[Clone Repository];   A[Fork Project] --> B[Clone Repository];
  B --> C[Create New Branch];   B --> C[Create New Branch];
  C --> D[Make Changes];   C --> D[Make Changes];
  D --> G[Test Changes];   D --> G[Test Changes];
  G --> H{Tests Passed?};   G --> H{Tests Passed?};
  H -->|Yes| E[Commit Changes];   H -->|Yes| E[Commit Changes];
  E --> F[Push Branch];
  H -->|No| J[Fix Issues];   H -->|No| J[Fix Issues];
  J --> G;
  E --> F[Push Branch];
  F --> K[Create Pull Request];   F --> K[Create Pull Request];
  K --> L[Fill out PR template];   K --> L[Fill out PR template];
  J --> G; classDef default stroke:#333,stroke-width:4px,font-size:12pt;
``` ```
!!! info !!! info
@ -65,8 +67,10 @@ graph LR
### Fork the Repo ### Fork the Repo
* Fork the WinUtil Repository [here](https://github.com/ChrisTitusTech/winutil) to create a copy that will be available in your repository list. * Fork the WinUtil Repository [here](https://github.com/ChrisTitusTech/winutil) to create a copy that will be available in your repository list.
![Fork Image](assets/Fork-Button-Dark.png#only-dark) ![Fork Image](assets/Fork-Button-Dark.png#only-dark)
![FOrk Image](assets/Fork-Button-Light.png#only-light)
![Fork Image](assets/Fork-Button-Light.png#only-light)
### Clone the Fork ### Clone the Fork
!!! tip !!! tip
@ -89,15 +93,22 @@ graph LR
* `cd {path to the folder with the compile.ps1}` * `cd {path to the folder with the compile.ps1}`
* Run the following command to compile and run WinUtil: * Run the following command to compile and run WinUtil:
* `.\Compile.ps1 -run` * `.\Compile.ps1 -run`
* ![Compile](assets/Compile.png)
![Compile](assets/Compile.png)
* After seeing that your changes work properly, feel free to commit the changes to the repository and make a PR. For help on that, follow the documentation below. * After seeing that your changes work properly, feel free to commit the changes to the repository and make a PR. For help on that, follow the documentation below.
### Committing the changes ### Committing the changes
* Before committing your changes, please discard changes made to the `winutil.ps1` file, like the following: * Before committing your changes, please discard changes made to the `winutil.ps1` file, like the following:
- ![Push Commit Image](assets/Discard-GHD.png)
![Push Commit Image](assets/Discard-GHD.png)
* Now, commit your changes once you are happy with the result. * Now, commit your changes once you are happy with the result.
![Commit Image](assets/Commit-GHD.png) ![Commit Image](assets/Commit-GHD.png)
* Push the changes to upload them to your fork on github.com. * Push the changes to upload them to your fork on github.com.
![Push Commit Image](assets/Push-Commit.png) ![Push Commit Image](assets/Push-Commit.png)
### Making a PR ### Making a PR

51
requirements.txt Normal file
View File

@ -0,0 +1,51 @@
Babel==2.15.0
bracex==2.5
cairocffi==1.7.1
CairoSVG==2.7.1
certifi==2024.7.4
cffi==1.17.0
charset-normalizer==3.3.2
click==8.1.7
colorama==0.4.6
csscompressor==0.9.5
cssselect2==0.7.0
defusedxml==0.7.1
ghp-import==2.1.0
gitdb==4.0.11
GitPython==3.1.43
htmlmin2==0.1.13
idna==3.7
Jinja2==3.1.4
jsmin==3.0.1
Markdown==3.6
MarkupSafe==2.1.5
mergedeep==1.3.4
mkdocs==1.6.0
mkdocs-awesome-pages-plugin==2.9.3
mkdocs-get-deps==0.2.0
mkdocs-git-revision-date-localized-plugin==1.2.6
mkdocs-material==9.5.31
mkdocs-material-extensions==1.3.1
mkdocs-minify-plugin==0.8.0
natsort==8.4.0
packaging==24.1
paginate==0.5.6
pathspec==0.12.1
pillow==10.4.0
platformdirs==4.2.2
pycparser==2.22
Pygments==2.18.0
pymdown-extensions==10.9
python-dateutil==2.9.0.post0
pytz==2024.1
PyYAML==6.0.2
pyyaml_env_tag==0.1
regex==2024.7.24
requests==2.32.3
six==1.16.0
smmap==5.0.1
tinycss2==1.3.0
urllib3==2.2.2
watchdog==4.0.1
wcmatch==9.0
webencodings==0.5.1