ci: use token in steam stats workflow

docs: update template
Nicconike · Jul 10, 2024 · 2101012 · 2101012
1 parent e642744
commit 2101012
Show file tree

Hide file tree

Showing 4 changed files with 330 additions and 8 deletions.
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -76,14 +76,12 @@ jobs:
                 restore-keys: |
                     ${{ runner.os }}-pip-
 
-          - name: Install Dependencies
-            run: |
-                python -m pip install --upgrade pip
-                pip install pylint
-
           - name: Run Pylint
             id: run-pylint
             run: |
+                git add .
+                python -m pip install --upgrade pip
+                pip install pylint
                 pylint api tests > pylint-report.txt || true
 
           - name: Generate Pylint Badge

diff --git a/.github/workflows/steam-stats.yml b/.github/workflows/steam-stats.yml
@@ -18,6 +18,8 @@ jobs:
         if: github.actor != 'dependabot[bot]' || github.actor != 'github-actions[bot]' || github.actor != 'protected-auto-commits[bot]' && github.base_ref == 'master'
         name: Steam Stats
         runs-on: ubuntu-latest
+        permissions:
+            contents: write
         container:
             image: nicconike/steam-stats:latest
         steps:
@@ -26,11 +28,12 @@ jobs:
             with:
                 token: ${{ secrets.GH_TOKEN }}
 
-          - name: Update Steam Stats in README
+          - name: Update Steam Stats
             run: |
                 export PYTHONPATH=$(pwd)
                 python api/main.py
             env:
+                GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
                 INPUT_STEAM_API_KEY: ${{ secrets.STEAM_API_KEY }}
                 INPUT_STEAM_ID: ${{ vars.STEAM_ID }}
                 INPUT_STEAM_CUSTOM_ID: ${{ vars.STEAM_CUSTOM_ID }}

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,8 +3,327 @@
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
 
-## [Unreleased]
+# v1.0.1 (2024-07-10)
 
+## Chore
 
+* chore: Update Pylint Badge ([`500c087`](https://github.com/Nicconike/Steam-Stats/commit/500c087a61ddddc9d61ece26b23ded382f0f8c30))
+
+## Fix
+
+* fix: Add INPUT_GH_TOKEN as a token env var
+docs: update readme
+ci: revert steam stats workflow
+chore: misc changes ([`a50764c`](https://github.com/Nicconike/Steam-Stats/commit/a50764c3ecc3df05187bfce3eefbeaa0ac0178f9))
+
+# v1.0.0 (2024-07-09)
+
+## Breaking
+
+* perf: Improve Card generation &amp; Main Runner Script Code
+
+BREAKING CHANGE: Major Release 🚀 ([`1e35e04`](https://github.com/Nicconike/Steam-Stats/commit/1e35e0431dd8d8742c7c566a81ebf0f3ff29af15))
+
+## Chore
+
+* chore: Update Steam Stats ([`984bfbf`](https://github.com/Nicconike/Steam-Stats/commit/984bfbfc121bd306b7af09baee69f34720042fce))
+
+* chore: Update Pylint Badge ([`860b652`](https://github.com/Nicconike/Steam-Stats/commit/860b6523d552a29a488591bff0101184586f6e07))
+
+* chore: Update Steam Stats ([`112176b`](https://github.com/Nicconike/Steam-Stats/commit/112176b0c93a5c7240fec84f7ad17d96491ab4f6))
+
+* chore(deps): bump pylint in the python-packages group (#8)
+
+Bumps the python-packages group with 1 update: [pylint](https://github.com/pylint-dev/pylint).
+
+
+Updates `pylint` from 3.2.3 to 3.2.5
+- [Release notes](https://github.com/pylint-dev/pylint/releases)
+- [Commits](https://github.com/pylint-dev/pylint/compare/v3.2.3...v3.2.5)
+
+---
+updated-dependencies:
+- dependency-name: pylint
+  dependency-type: direct:production
+  update-type: version-update:semver-patch
+  dependency-group: python-packages
+...
+
+Signed-off-by: dependabot[bot] &lt;support@github.com&gt;
+Co-authored-by: dependabot[bot] &lt;49699333+dependabot[bot]@users.noreply.github.com&gt;
+Co-authored-by: Nicco &lt;38905025+Nicconike@users.noreply.github.com&gt; ([`3915a4d`](https://github.com/Nicconike/Steam-Stats/commit/3915a4df619f620282d9356e91973196b6ce70ee))
+
+* chore: Update Steam Stats ([`bb5458c`](https://github.com/Nicconike/Steam-Stats/commit/bb5458c979a8bf370fe7e159956c249cc151eed5))
+
+* chore: Update Steam Stats ([`cc9f5fd`](https://github.com/Nicconike/Steam-Stats/commit/cc9f5fdab23f84973466a663c5d94063554cb047))
+
+* chore: Update Steam Stats ([`b2f031e`](https://github.com/Nicconike/Steam-Stats/commit/b2f031e57467f9fa951527e0158ba8a7899cd00a))
+
+## Ci
+
+* ci: update scoring for pylint badge ([`25fa44d`](https://github.com/Nicconike/Steam-Stats/commit/25fa44dfe840dae5dcc64124a3b1ff4ec2c1b015))
+
+* ci: update badge url &amp; codeql workflow ([`ee23446`](https://github.com/Nicconike/Steam-Stats/commit/ee23446bf6b43c6929816beb8fa1c99aa98b8807))
+
+* ci: move app token step at first ([`77cff48`](https://github.com/Nicconike/Steam-Stats/commit/77cff483c697a19f0e8f8c113f98ea60de5c5176))
+
+* ci: update pylint badge generation ([`17dc2ce`](https://github.com/Nicconike/Steam-Stats/commit/17dc2ce4f0b06fd9212fcf21cb0525153fc7d196))
+
+* ci: Update pylint workflow ([`11097f3`](https://github.com/Nicconike/Steam-Stats/commit/11097f3c1ba1c074cee36e04ecfdacd2633100db))
+
+* ci: Correct the pylint badge generation step ([`50be3f4`](https://github.com/Nicconike/Steam-Stats/commit/50be3f4fec1646f695202b78124961b85af0edfb))
+
+* ci: use custom pylint job instead of actions
+build: update dockerfile ([`ad37826`](https://github.com/Nicconike/Steam-Stats/commit/ad37826430dbe0ef308cb2fda461327f504c7ff8))
+
+* ci: pylint workflow should workflow if github actions bot does a commit ([`b958eea`](https://github.com/Nicconike/Steam-Stats/commit/b958eea2ba16d6fd684ac685cfedb4b37326114e))
+
+* ci: Update pylint workflow to commit to protected branch ([`c38fe71`](https://github.com/Nicconike/Steam-Stats/commit/c38fe7152f59a1dc16384a63be21aa9e1631fce3))
+
+* ci: update workflow ([`74c12c4`](https://github.com/Nicconike/Steam-Stats/commit/74c12c488febc0a51b34f76c7bae72e28a0ad5ba))
+
+* ci: update workflows to check for github actor ([`74e18a3`](https://github.com/Nicconike/Steam-Stats/commit/74e18a34e25ec67ff23ce70e6d7b696f82e2ca0c))
+
+* ci: Correct scout scan step ([`700840d`](https://github.com/Nicconike/Steam-Stats/commit/700840d2935e82a92815444cb39d10465c7f10af))
+
+* ci: correct the docker workflow for tags ([`b64b7d1`](https://github.com/Nicconike/Steam-Stats/commit/b64b7d1aed04032859e9c02fb53ed43be8632ab0))
+
+* ci: revert change ([`1b03955`](https://github.com/Nicconike/Steam-Stats/commit/1b03955877beecaf444e2d613ecb6ce1e95da5ce))
+
+* ci: update release workflow ([`28afc5a`](https://github.com/Nicconike/Steam-Stats/commit/28afc5a79cfa898331253dbddc5fa44d8e8bd921))
+
+* ci: update docker action
+refactor: remove logger info in steam_stats.py ([`82bf032`](https://github.com/Nicconike/Steam-Stats/commit/82bf032ab6e9b19ebd3ffc463f68a1710ecd1bfb))
+
+## Documentation
+
+* docs: correct changelog &amp; pyproject
+ci: misc changes ([`a84f81c`](https://github.com/Nicconike/Steam-Stats/commit/a84f81c82180caf45233b399799cc78125fe4a26))
+
+## Test
+
+* test: Improve codecov for card script to 84% ([`81d5f89`](https://github.com/Nicconike/Steam-Stats/commit/81d5f89eba3be0f68b2f142c8dd9c273d5d205be))
+
+* test: Improve code cov for main script to 95%
+ci: Check prev release ([`17383b6`](https://github.com/Nicconike/Steam-Stats/commit/17383b698613632351b16a3fc57aec4aac8f3989))
+
+* test: increase code coverage for main script ([`f0a7f52`](https://github.com/Nicconike/Steam-Stats/commit/f0a7f52e9f143c48f9fe2686c9e488a106fad5e1))
+
+* test: update test_steam_workshop.py for 100% coverage ([`72c964f`](https://github.com/Nicconike/Steam-Stats/commit/72c964faa4e7b7ce8838899554105324dd308709))
+
+## Unknown
+
+* Update Pylint Badge ([`f717f61`](https://github.com/Nicconike/Steam-Stats/commit/f717f61d39fca7561ea9f919019631ba0d5bd492))
+
+# v0.1.5 (2024-06-28)
+
+## Build
+
+* build: Missed dockerfile change ([`1de324b`](https://github.com/Nicconike/Steam-Stats/commit/1de324b9d28883ae0ce967c149c954a49b35cac6))
+
+## Chore
+
+* chore: template update ([`2370d9b`](https://github.com/Nicconike/Steam-Stats/commit/2370d9b31a226a2ac6b9ddd0f48151e8c6ef2a29))
+
+* chore: update pyproject.toml ([`b11e120`](https://github.com/Nicconike/Steam-Stats/commit/b11e1203587e3e6f43e64eb1e14d66ee5a143a19))
+
+* chore: Add dependencies in pyproject.toml ([`b1438f2`](https://github.com/Nicconike/Steam-Stats/commit/b1438f20623334031d5b1c712d9a5d2ed7ddafce))
+
+* chore: add versions in requirements.txt ([`113ef74`](https://github.com/Nicconike/Steam-Stats/commit/113ef74b4bcdb25e16adfce8a1bbdc1274c3b75a))
+
+* chore: update dependabot.yml ([`3c3fe46`](https://github.com/Nicconike/Steam-Stats/commit/3c3fe46f3d976b67f6b78568dced5b29c5994ffa))
+
+## Ci
+
+* ci: update release workflow ([`21fcc97`](https://github.com/Nicconike/Steam-Stats/commit/21fcc97842f0fb7589ebe5cfac522523e00bdd15))
+
+* ci: bump docker/scout-action from 1.9.3 to 1.10.0 in the github-actions group (#5)
+
+* ci: bump docker/scout-action in the github-actions group
+
+Bumps the github-actions group with 1 update: [docker/scout-action](https://github.com/docker/scout-action).
+
+Updates `docker/scout-action` from 1.9.3 to 1.10.0
+- [Release notes](https://github.com/docker/scout-action/releases)
+- [Commits](https://github.com/docker/scout-action/compare/v1.9.3...v1.10.0)
+
+---
+updated-dependencies:
+- dependency-name: docker/scout-action
+  dependency-type: direct:production
+  update-type: version-update:semver-minor
+  dependency-group: github-actions
+...
+
+Signed-off-by: dependabot[bot] &lt;support@github.com&gt;
+
+* Updated Steam Stats
+
+* ci: update steam stats workflow
+
+Co-authored-by: 38905025+Nicconike@users.noreply.github.com
+
+---------
+
+Signed-off-by: dependabot[bot] &lt;support@github.com&gt;
+Co-authored-by: dependabot[bot] &lt;49699333+dependabot[bot]@users.noreply.github.com&gt;
+Co-authored-by: Nicco &lt;38905025+Nicconike@users.noreply.github.com&gt;
+Co-authored-by: GitHub Action &lt;action@github.com&gt; ([`2a481b3`](https://github.com/Nicconike/Steam-Stats/commit/2a481b38f20e015e400d0022bedf4256e4fdf256))
+
+* ci: update workflows for requirements.txt
+fix: Update dockerfile ([`4e55410`](https://github.com/Nicconike/Steam-Stats/commit/4e55410fedc5820eb57191b61e7a5c6760d8f041))
+
+* ci: Add output for codeql analysis ([`6b8564a`](https://github.com/Nicconike/Steam-Stats/commit/6b8564a69c3d406ec08869e27772ced9efa16735))
+
+* ci: Update workflows
+docs: Add contributing.md
+chore: update toml ([`1080d6b`](https://github.com/Nicconike/Steam-Stats/commit/1080d6b68a260564fd6805d2b160e61489f8bedd))
+
+* ci: update workflow &amp; dockerfile
+Update changelog template ([`771a869`](https://github.com/Nicconike/Steam-Stats/commit/771a86987075102d47d523427bf9ee7a5d32d193))
+
+## Documentation
+
+* docs: update readme ([`94a89a3`](https://github.com/Nicconike/Steam-Stats/commit/94a89a3a023599a205ce3f2f0f7da6026551d534))
+
+* docs: update readme ([`49c1723`](https://github.com/Nicconike/Steam-Stats/commit/49c1723637dd6414454b279004cd56e537e2c5e6))
+
+* docs: Update readme ([`3b0cdbb`](https://github.com/Nicconike/Steam-Stats/commit/3b0cdbbdcdb85b8a5d4108e0ccf17191332ac844))
+
+* docs: Move the doc files to .github ([`68e64f1`](https://github.com/Nicconike/Steam-Stats/commit/68e64f171877a41ea5da21f0a42afd4f14b9162e))
+
+* docs: Add security.md
+ci: update workflows to not trigger on bot commits or PRs
+chore: move requirements.txt to api ([`cb5d35b`](https://github.com/Nicconike/Steam-Stats/commit/cb5d35b2f9d041651949e7d4c526c863b636a7b4))
+
+* docs: update issue templates ([`dc23769`](https://github.com/Nicconike/Steam-Stats/commit/dc23769b0e7f3283bb90294f67aac282c504055d))
+
+## Fix
+
+* fix: correct the assertion error ([`16e7217`](https://github.com/Nicconike/Steam-Stats/commit/16e7217e93a8c2529b7464c91c1a12f06b9e4871))
+
+## Refactor
+
+* refactor: Update pyproject.toml and template ([`666332e`](https://github.com/Nicconike/Steam-Stats/commit/666332e2a002dfaaba3f9ee4d43cba07b595e2e0))
+
+* refactor: Address bandit vulns issues
+ci: misc. changes
+docs: update readme ([`04db6ea`](https://github.com/Nicconike/Steam-Stats/commit/04db6ea8f7a0c5d228d168d9555d678bfef309b5))
+
+## v0.1.4 (2024-06-20)
+
+### Chore
+
+* chore: update dependencies (#3)
+
+Merge ([`99d0f2e`](https://github.com/Nicconike/Steam-Stats/commit/99d0f2ed378f052dc66b882fcd5cb40ea5ffc91e))
+
+
+### Ci
+
+* ci: Update workflow to upload reports correctly ([`721ec76`](https://github.com/Nicconike/Steam-Stats/commit/721ec76b8e0345816fc9fd2ee7ab445ee98cbb59))
+
+* ci: Update workflows ([`b648032`](https://github.com/Nicconike/Steam-Stats/commit/b648032537ea8b667054a3d65ee5e4a2149cc46c))
+
+
+### Documentation
+
+* docs: Add issue templates ([`cffa8f9`](https://github.com/Nicconike/Steam-Stats/commit/cffa8f9e6b02afab0593c3aa86bf7c79e47d56e0))
+
+
+### Fix
+
+* fix: update main python script to remvoe setup ([`ebfd9e0`](https://github.com/Nicconike/Steam-Stats/commit/ebfd9e01ac097efba2f507f8948084888da51a91))
+
+
+### Unknown
+
+* Create FUNDING.yml
+
+Signed-off-by: Nicco &lt;38905025+Nicconike@users.noreply.github.com&gt; ([`274096d`](https://github.com/Nicconike/Steam-Stats/commit/274096da2e090a9b8eedeb49e609296a458410df))
+
+
+## v0.1.3 (2024-06-19)
+
+### Ci
+
+* ci: run with python3 ([`7c0829b`](https://github.com/Nicconike/Steam-Stats/commit/7c0829b0a2a78f8752e0704672b7f317999b2688))
+
+* ci: Update release workflow &amp; add templates ([`8a7e376`](https://github.com/Nicconike/Steam-Stats/commit/8a7e3765ec89b18a03112e24445bfa18c1747cb6))
+
+
+### Fix
+
+* fix(workflow): Test release ([`e8c3ddb`](https://github.com/Nicconike/Steam-Stats/commit/e8c3ddba57368f21e9c29207fcb2eb9029ef99db))
+
+
+## v0.1.2 (2024-06-17)
+
+### Build
+
+* build: Addressing the autobuild warning to use v3 for CodeQL ([`abc130a`](https://github.com/Nicconike/Steam-Stats/commit/abc130a2641fb29f5b3fb4ef231d059d788b7e35))
+
+
+### Chore
+
+* chore: CodeQL &amp; Pylint Setup ([`8ddb1d6`](https://github.com/Nicconike/Steam-Stats/commit/8ddb1d6e75ff4f760192cfeab82ec314357101ee))
+
+
+### Fix
+
+* fix: Update action.yml to pull docker image ([`130bc91`](https://github.com/Nicconike/Steam-Stats/commit/130bc91bcc9fcc4d229f5d87fc2b05bc1472ce18))
+
+
+## v0.1.1 (2024-06-16)
+
+### Ci
+
+* ci: Trigger workflow ([`68cbea7`](https://github.com/Nicconike/Steam-Stats/commit/68cbea77858ad335336571d81d2904c414478f6f))
+
+* ci: Trigger workflow ([`96348ee`](https://github.com/Nicconike/Steam-Stats/commit/96348ee1154e7c2257fbf8080794b0afb7baf4c8))
+
+
+### Documentation
+
+* docs: Update Readme ([`2a9d8f3`](https://github.com/Nicconike/Steam-Stats/commit/2a9d8f347bcab6d0b9746ecb9e4f3a0a65bcbf5b))
+
+
+### Performance
+
+* perf: Remove redundancy ([`64cbf13`](https://github.com/Nicconike/Steam-Stats/commit/64cbf13cb3af82c3b1d2e150f3e572a6964d91ff))
+
+
+## v0.1.0 (2024-06-14)
+
+### Feature
+
+* feat(docker): Update dockerfile &amp; workflow ([`9e04f61`](https://github.com/Nicconike/Steam-Stats/commit/9e04f61fa42c44f92e4604cf0e8a7c7993174c51))
+
+* feat(workflow): Add release action &amp; update docker ([`baf85c6`](https://github.com/Nicconike/Steam-Stats/commit/baf85c6f89eb2f9e8cb48163b6ce9cff40a70ea5))
+
+
+### Fix
+
+* fix(workflow): Sign Commit ([`74ee9fb`](https://github.com/Nicconike/Steam-Stats/commit/74ee9fb0ca888b9c5a3be42936da3ec610596079))
+
+* fix(workflow): correctly setup gpg sign
+
+Added codespaces support ([`8046a1b`](https://github.com/Nicconike/Steam-Stats/commit/8046a1b6ef88048101fddf9a39ff82977afc4b02))
+
+* fix(workflow): update steps in workflow ([`143d3dc`](https://github.com/Nicconike/Steam-Stats/commit/143d3dcc246c498c3ef7b69008cd2cf654698bb5))
+
+* fix(workflow): refactor all github workflows ([`effac0b`](https://github.com/Nicconike/Steam-Stats/commit/effac0b087ede665edf4c8fd3d308aca677e8353))
+
+
+## v0.0.1 (2024-06-12)
+
+### Ci
+
+* ci(workflow): update Docker CICD workflow to use semantic-release ([`4eb4ac9`](https://github.com/Nicconike/Steam-Stats/commit/4eb4ac9566e07a83d90916042423c1164d77795d))
+
+
+### Fix
+
+* fix(workflow): correct &amp; update github workflow for automated release ([`44cc88e`](https://github.com/Nicconike/Steam-Stats/commit/44cc88ef4e80c47c0d750f4576aba3d3cdedbc25))
diff --git a/templates/CHANGELOG.md.j2 b/templates/CHANGELOG.md.j2
@@ -32,3 +32,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 {% endfor %}
 {% endfor %}
 {% endif %}
+
+{{ context.history.changelog_content if context.history.changelog_content else "" }}