From f93191c8f523af37c6ab24e580100903637537b7 Mon Sep 17 00:00:00 2001
From: Janek <development@superyu.xyz>
Date: Sat, 30 Dec 2023 18:58:55 +0100
Subject: [PATCH 01/11] Update README.md
---
csflow/README.md | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/csflow/README.md b/csflow/README.md
index 2ff8e84..0d0ce48 100644
--- a/csflow/README.md
+++ b/csflow/README.md
@@ -1,2 +1,5 @@
# csflow
-SDK for CS2 cheats utilizing [memflow](https://github.com/memflow/memflow)
\ No newline at end of file
+SDK for CS2 cheats utilizing [memflow](https://github.com/memflow/memflow)
+
+## Documentation
+Documentation can be found [here](https://superyu1337.github.io/cs2-memflow/csflow/index.html)
From 320ed18342bf267a214d70da2bc0849efc9b03ef Mon Sep 17 00:00:00 2001
From: Janek <development@superyu.xyz>
Date: Sat, 30 Dec 2023 19:02:33 +0100
Subject: [PATCH 02/11] Update README.md
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 67ef781..5a44888 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@ This is a repository for my CS2 cheats which utilize [memflow](https://github.co
### Todo
- csflow
- - [ ] Documentation
+ - [ ] Better Documentation with a "getting started"
- [ ] Test with pcileech hardware
- radarflow
- [ ] Test with pcileech hardware
From c163ed70f260e5b5ba64268c4440d2974bf0cafb Mon Sep 17 00:00:00 2001
From: Janek <development@superyu.xyz>
Date: Sat, 30 Dec 2023 19:02:53 +0100
Subject: [PATCH 03/11] Update README.md
---
README.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/README.md b/README.md
index 5a44888..eb399e0 100644
--- a/README.md
+++ b/README.md
@@ -12,4 +12,5 @@ This is a repository for my CS2 cheats which utilize [memflow](https://github.co
- [ ] Test with pcileech hardware
- radarflow
- [ ] Test with pcileech hardware
+ - [ ] Optimization
- [ ] More useful logging, maybe a TUI to write statistics?
From dc29597b602100ad677f7725b75cceeff309d2b0 Mon Sep 17 00:00:00 2001
From: Janek <development@superyu.xyz>
Date: Sat, 30 Dec 2023 19:13:14 +0100
Subject: [PATCH 04/11] Create deploy-docs.yml
---
.github/workflows/deploy-docs.yml | 30 ++++++++++++++++++++++++++++++
1 file changed, 30 insertions(+)
create mode 100644 .github/workflows/deploy-docs.yml
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
new file mode 100644
index 0000000..389bba4
--- /dev/null
+++ b/.github/workflows/deploy-docs.yml
@@ -0,0 +1,30 @@
+name: Deploy Docs to GitHub Pages
+
+on:
+ push:
+ branches:
+ - main # Adjust this branch name if needed
+
+jobs:
+ build-and-deploy:
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v2
+
+ - name: Set up Rust
+ uses: actions/setup-rust@v1
+
+ - name: Build Docs
+ run: |
+ cargo doc --no-deps
+ rm -rf ./docs
+ echo "<meta http-equiv=\"refresh\" content=\"0; url=csflow/index.html\">" > target/doc/index.html
+ cp -r target/doc ./docs
+
+ - name: Deploy to GitHub Pages
+ uses: peaceiris/actions-gh-pages@v3
+ with:
+ github_token: ${{ secrets.GITHUB_TOKEN }}
+ publish_dir: ./docs
From 7bc96f1093a383336cdc3e955a60268b0738bbc5 Mon Sep 17 00:00:00 2001
From: Janek <development@superyu.xyz>
Date: Sat, 30 Dec 2023 19:15:12 +0100
Subject: [PATCH 05/11] Update deploy-docs.yml
---
.github/workflows/deploy-docs.yml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
index 389bba4..f76f7cd 100644
--- a/.github/workflows/deploy-docs.yml
+++ b/.github/workflows/deploy-docs.yml
@@ -11,10 +11,10 @@ jobs:
steps:
- name: Checkout code
- uses: actions/checkout@v2
+ uses: actions/checkout@v4.1.1
- name: Set up Rust
- uses: actions/setup-rust@v1
+ uses: ATiltedTree/setup-rust@v1.0.5
- name: Build Docs
run: |
From 3f10cc573a39f9ec41d3e5791b8baf432eacfd16 Mon Sep 17 00:00:00 2001
From: Janek <development@superyu.xyz>
Date: Sat, 30 Dec 2023 19:16:16 +0100
Subject: [PATCH 06/11] Update deploy-docs.yml
---
.github/workflows/deploy-docs.yml | 2 ++
1 file changed, 2 insertions(+)
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
index f76f7cd..0790464 100644
--- a/.github/workflows/deploy-docs.yml
+++ b/.github/workflows/deploy-docs.yml
@@ -15,6 +15,8 @@ jobs:
- name: Set up Rust
uses: ATiltedTree/setup-rust@v1.0.5
+ with:
+ rust-version: 1.74
- name: Build Docs
run: |
From 6fe1820471607aa43bde02a5494d6a9b30608d58 Mon Sep 17 00:00:00 2001
From: Janek <development@superyu.xyz>
Date: Sat, 30 Dec 2023 19:23:22 +0100
Subject: [PATCH 07/11] Update deploy-docs.yml
---
.github/workflows/deploy-docs.yml | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
index 0790464..cbb11ef 100644
--- a/.github/workflows/deploy-docs.yml
+++ b/.github/workflows/deploy-docs.yml
@@ -5,6 +5,18 @@ on:
branches:
- main # Adjust this branch name if needed
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+ contents: read
+ pages: write
+ id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+ group: "pages"
+ cancel-in-progress: false
+
jobs:
build-and-deploy:
runs-on: ubuntu-latest
From 6d178a7fc84dbf504a802b2653d58b64b167a37f Mon Sep 17 00:00:00 2001
From: Janek <development@superyu.xyz>
Date: Sat, 30 Dec 2023 19:27:24 +0100
Subject: [PATCH 08/11] Update deploy-docs.yml
---
.github/workflows/deploy-docs.yml | 37 +++++++++++++++++++------------
1 file changed, 23 insertions(+), 14 deletions(-)
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
index cbb11ef..b00795e 100644
--- a/.github/workflows/deploy-docs.yml
+++ b/.github/workflows/deploy-docs.yml
@@ -1,9 +1,13 @@
-name: Deploy Docs to GitHub Pages
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy Docs to Github Pages
on:
+ # Runs on pushes targeting the default branch
push:
- branches:
- - main # Adjust this branch name if needed
+ branches: ["main"]
+
+ # Allows you to run this workflow manually from the Actions tab
+ workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
@@ -18,27 +22,32 @@ concurrency:
cancel-in-progress: false
jobs:
- build-and-deploy:
+ # Single deploy job since we're just deploying
+ deploy:
+ environment:
+ name: github-pages
+ url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
-
steps:
- - name: Checkout code
- uses: actions/checkout@v4.1.1
-
+ - name: Checkout
+ uses: actions/checkout@v4
- name: Set up Rust
uses: ATiltedTree/setup-rust@v1.0.5
with:
rust-version: 1.74
-
- name: Build Docs
run: |
cargo doc --no-deps
rm -rf ./docs
echo "<meta http-equiv=\"refresh\" content=\"0; url=csflow/index.html\">" > target/doc/index.html
cp -r target/doc ./docs
-
- - name: Deploy to GitHub Pages
- uses: peaceiris/actions-gh-pages@v3
+ - name: Setup Pages
+ uses: actions/configure-pages@v4
+ - name: Upload artifact
+ uses: actions/upload-pages-artifact@v3
with:
- github_token: ${{ secrets.GITHUB_TOKEN }}
- publish_dir: ./docs
+ # Upload entire repository
+ path: '.'
+ - name: Deploy to GitHub Pages
+ id: deployment
+ uses: actions/deploy-pages@v4
From e61d178147327d1d5a2784684d0f021a46e693e5 Mon Sep 17 00:00:00 2001
From: Janek <development@superyu.xyz>
Date: Sat, 30 Dec 2023 19:27:43 +0100
Subject: [PATCH 09/11] Update deploy-docs.yml
---
.github/workflows/deploy-docs.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
index b00795e..4b74986 100644
--- a/.github/workflows/deploy-docs.yml
+++ b/.github/workflows/deploy-docs.yml
@@ -47,7 +47,7 @@ jobs:
uses: actions/upload-pages-artifact@v3
with:
# Upload entire repository
- path: '.'
+ path: './docs'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
From 216fb548b442b6b8fd9e40136fb29eeeed5556df Mon Sep 17 00:00:00 2001
From: Janek <development@superyu.xyz>
Date: Sat, 30 Dec 2023 19:32:34 +0100
Subject: [PATCH 10/11] Update deploy-docs.yml
---
.github/workflows/deploy-docs.yml | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
index 4b74986..0af4f92 100644
--- a/.github/workflows/deploy-docs.yml
+++ b/.github/workflows/deploy-docs.yml
@@ -41,12 +41,16 @@ jobs:
rm -rf ./docs
echo "<meta http-equiv=\"refresh\" content=\"0; url=csflow/index.html\">" > target/doc/index.html
cp -r target/doc ./docs
+ - name: Fix permissions
+ run: |
+ chmod -c -R +rX "./docs/" | while read line; do
+ echo "::warning title=Invalid file permissions automatically fixed::$line"
+ done
- name: Setup Pages
uses: actions/configure-pages@v4
- - name: Upload artifact
+ - name: Upload pages artifact
uses: actions/upload-pages-artifact@v3
with:
- # Upload entire repository
path: './docs'
- name: Deploy to GitHub Pages
id: deployment
From b87ae1da442ccab7d6ea9ff702a95610b6e37ef1 Mon Sep 17 00:00:00 2001
From: Janek <development@superyu.xyz>
Date: Sat, 30 Dec 2023 19:52:17 +0100
Subject: [PATCH 11/11] Update deploy-docs.yml
---
.github/workflows/deploy-docs.yml | 48 ++++++++++++++++++++-----------
1 file changed, 32 insertions(+), 16 deletions(-)
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
index 0af4f92..5c67df4 100644
--- a/.github/workflows/deploy-docs.yml
+++ b/.github/workflows/deploy-docs.yml
@@ -22,36 +22,52 @@ concurrency:
cancel-in-progress: false
jobs:
- # Single deploy job since we're just deploying
- deploy:
- environment:
- name: github-pages
- url: ${{ steps.deployment.outputs.page_url }}
+ # Build docs job
+ build_docs:
runs-on: ubuntu-latest
steps:
- - name: Checkout
- uses: actions/checkout@v4
- - name: Set up Rust
- uses: ATiltedTree/setup-rust@v1.0.5
+ - uses: actions/checkout@v2
+ - name: Setup Pages
+ uses: actions/configure-pages@v4
+ - uses: actions-rs/toolchain@v1
with:
- rust-version: 1.74
- - name: Build Docs
+ toolchain: stable
+ - name: Build docs
+ uses: actions-rs/cargo@v1
+ with:
+ command: doc
+ args: --no-deps
+ - name: Fix docs
run: |
- cargo doc --no-deps
rm -rf ./docs
echo "<meta http-equiv=\"refresh\" content=\"0; url=csflow/index.html\">" > target/doc/index.html
cp -r target/doc ./docs
- - name: Fix permissions
- run: |
chmod -c -R +rX "./docs/" | while read line; do
echo "::warning title=Invalid file permissions automatically fixed::$line"
done
- - name: Setup Pages
- uses: actions/configure-pages@v4
- name: Upload pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: './docs'
+
+ # Deploy job
+ deploy:
+ # Add a dependency to the build job
+ needs: build_docs
+
+ # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+ permissions:
+ pages: write # to deploy to Pages
+ id-token: write # to verify the deployment originates from an appropriate source
+
+ # Deploy to the github-pages environment
+ environment:
+ name: github-pages
+ url: ${{ steps.deployment.outputs.page_url }}
+
+ # Specify runner + deployment step
+ runs-on: ubuntu-latest
+ steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4