From 46c5fe3ba9648ae1342c24d7cd36ff296310b664 Mon Sep 17 00:00:00 2001
From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com>
Date: Mon, 11 Nov 2024 08:39:47 -0500
Subject: [PATCH 1/3] Bump pygithub from 2.4.0 to 2.5.0 in the all group (#65)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Bumps the all group with 1 update:
[pygithub](https://github.com/pygithub/pygithub).

Updates `pygithub` from 2.4.0 to 2.5.0
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/pygithub/pygithub/releases">pygithub's
releases</a>.</em></p>
<blockquote>
<h2>v2.5.0</h2>
<h2>Breaking Changes</h2>
<ul>
<li>Parameters of method
<code>github.Requester.Requester.graphql_named_mutation</code> have been
renamed:
<ul>
<li>Parameter <code>variables</code> renamed to
<code>mutation_input</code></li>
<li>Parameter <code>output</code> renamed to
<code>output_schema</code></li>
<li>Default value of parameter <code>output</code> has been removed</li>
</ul>
</li>
</ul>
<h2>New features</h2>
<ul>
<li>Rework GraphQL mutations <a
href="https://github.com/EnricoMi"><code>@​EnricoMi</code></a> (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3046">#3046</a>)</li>
<li>Make pagination work with GraphQL response data <a
href="https://github.com/EnricoMi"><code>@​EnricoMi</code></a> (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3047">#3047</a>)</li>
<li>Add <code>RepositoryDiscussion</code> powered by GraphQL API <a
href="https://github.com/EnricoMi"><code>@​EnricoMi</code></a> (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3048">#3048</a>)</li>
<li>Add <code>Repository.get_discussion()</code> to get a single
Discussion <a
href="https://github.com/tiangolo"><code>@​tiangolo</code></a> (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3072">#3072</a>)</li>
</ul>
<h2>Improvements</h2>
<ul>
<li>Adds List organization memberships for the authenticated user <a
href="https://github.com/eduramirezh"><code>@​eduramirezh</code></a> (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3040">#3040</a>)</li>
<li>Add <code>actor</code> property to WorkflowRun <a
href="https://github.com/gbhand"><code>@​gbhand</code></a> (<a
href="https://redirect.github.com/pygithub/pygithub/issues/2764">#2764</a>)</li>
<li>Make requester a public attribute <a
href="https://github.com/minrk"><code>@​minrk</code></a> (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3056">#3056</a>)</li>
</ul>
<h2>Bug Fixes</h2>
<ul>
<li>Fix requesting urls containing parameters with parameters dict <a
href="https://github.com/EnricoMi"><code>@​EnricoMi</code></a> (<a
href="https://redirect.github.com/pygithub/pygithub/issues/2929">#2929</a>)</li>
<li>PullRequest.delete_branch: fix the remaining pull requests check <a
href="https://github.com/fetsko"><code>@​fetsko</code></a> (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3063">#3063</a>)</li>
</ul>
<h2>Maintenance</h2>
<ul>
<li>Remove stale bot <a
href="https://github.com/EnricoMi"><code>@​EnricoMi</code></a>
(510c1402)</li>
<li>Upgrade Github actions <a
href="https://github.com/EnricoMi"><code>@​EnricoMi</code></a> (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3075">#3075</a>)</li>
<li>Add top issues dashboard action <a
href="https://github.com/EnricoMi"><code>@​EnricoMi</code></a> (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3049">#3049</a>)</li>
<li>Make tests pass some more years <a
href="https://github.com/bmwiedemann"><code>@​bmwiedemann</code></a> (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3045">#3045</a>)</li>
<li>Run top issues workflow only in PyGithub repo <a
href="https://github.com/EnricoMi"><code>@​EnricoMi</code></a>
(0d395d4e)</li>
<li>Replace pre-commit action in order to pin pre-commit <a
href="https://github.com/minrk"><code>@​minrk</code></a> (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3059">#3059</a>)</li>
</ul>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/PyGithub/PyGithub/blob/main/doc/changes.rst">pygithub's
changelog</a>.</em></p>
<blockquote>
<h2>Version 2.5.0 (November 06, 2024)</h2>
<p>Breaking Changes
^^^^^^^^^^^^^^^^</p>
<ul>
<li>
<p>Parameters of method
<code>github.Requester.Requester.graphql_named_mutation</code> have been
renamed:</p>
<ul>
<li>Parameter <code>variables</code> renamed to
<code>mutation_input</code></li>
<li>Parameter <code>output</code> renamed to
<code>output_schema</code></li>
<li>Default value of parameter <code>output</code> has been removed</li>
</ul>
</li>
</ul>
<p>New features
^^^^^^^^^^^^</p>
<ul>
<li>Rework GraphQL mutations (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3046">#3046</a>)
(27222251)</li>
<li>Make pagination work with GraphQL response data (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3047">#3047</a>)
(cd30e379)</li>
<li>Add <code>RepositoryDiscussion</code> powered by GraphQL API (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3048">#3048</a>)
(29359f3c)</li>
<li>Add <code>Repository.get_discussion()</code> to get a single
Discussion (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3072">#3072</a>)
(44120b1e)</li>
</ul>
<p>Improvements
^^^^^^^^^^^^</p>
<ul>
<li>Adds List organization memberships for the authenticated user (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3040">#3040</a>)
(cf443955)</li>
<li>Add <code>actor</code> property to WorkflowRun (<a
href="https://redirect.github.com/pygithub/pygithub/issues/2764">#2764</a>)
(612ba68e)</li>
<li>Make requester a public attribute (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3056">#3056</a>)
(c44ec523)</li>
</ul>
<p>Bug Fixes
^^^^^^^^^</p>
<ul>
<li>Fix requesting urls containing parameters with parameters dict (<a
href="https://redirect.github.com/pygithub/pygithub/issues/2929">#2929</a>)
(e1d67ada)</li>
<li>PullRequest.delete_branch: fix the remaining pull requests check (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3063">#3063</a>)
(72fa6278)</li>
</ul>
<p>Maintenance
^^^^^^^^^^^</p>
<ul>
<li>Remove stale bot (510c1402)</li>
<li>Upgrade Github actions (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3075">#3075</a>)
(323e2828)</li>
<li>Add top issues dashboard action (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3049">#3049</a>)
(c91f26a7)</li>
<li>Make tests pass some more years (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3045">#3045</a>)
(352c55aa)</li>
<li>Run top issues workflow only in PyGithub repo (0d395d4e)</li>
<li>Replace pre-commit Github action in order to pin pre-commit version
(<a
href="https://redirect.github.com/pygithub/pygithub/issues/3059">#3059</a>)
(1a05b43d)</li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/PyGithub/PyGithub/commit/19ddb9f4fd996e99a5010d271b3c2e76dd280fb5"><code>19ddb9f</code></a>
Release v2.5.0 (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3079">#3079</a>)</li>
<li><a
href="https://github.com/PyGithub/PyGithub/commit/44120b1e85218166bd89735352868b2ad470762e"><code>44120b1</code></a>
Add support for <code>Repository.get_discussion()</code> to get a single
Discussion (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3072">#3072</a>)</li>
<li><a
href="https://github.com/PyGithub/PyGithub/commit/323e28282fd2bfdd4f00ad7119d7ac127ece8b56"><code>323e282</code></a>
Upgrade Github actions (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3075">#3075</a>)</li>
<li><a
href="https://github.com/PyGithub/PyGithub/commit/29359f3ce090a57c759668c50a8c08fc7346c2cf"><code>29359f3</code></a>
Add <code>RepositoryDiscussion</code> powered by GraphQL API (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3048">#3048</a>)</li>
<li><a
href="https://github.com/PyGithub/PyGithub/commit/cd30e3796e3758be876810b5cfe935d8c5f78ff0"><code>cd30e37</code></a>
Make pagination work with GraphQL response data (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3047">#3047</a>)</li>
<li><a
href="https://github.com/PyGithub/PyGithub/commit/272222510d07876dc91cea9ede99b9a1efeb5221"><code>2722225</code></a>
Rework GraphQL mutations (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3046">#3046</a>)</li>
<li><a
href="https://github.com/PyGithub/PyGithub/commit/72fa6278170f0463d053795dec3023d7bdd3ced3"><code>72fa627</code></a>
PullRequest.delete_branch: fix the remaining pull requests check (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3063">#3063</a>)</li>
<li><a
href="https://github.com/PyGithub/PyGithub/commit/352c55aa98c7844333c610455db2cca915aa5c64"><code>352c55a</code></a>
Make tests pass some more years (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3045">#3045</a>)</li>
<li><a
href="https://github.com/PyGithub/PyGithub/commit/cf44395580cd9a1ec822236da36967a8faa290a3"><code>cf44395</code></a>
Adds List organization memberships for the authenticated user (<a
href="https://redirect.github.com/pygithub/pygithub/issues/3040">#3040</a>)</li>
<li><a
href="https://github.com/PyGithub/PyGithub/commit/612ba68e92e3fe2eb2986c53a3e48c137a3214b6"><code>612ba68</code></a>
Add <code>actor</code> property to WorkflowRun (<a
href="https://redirect.github.com/pygithub/pygithub/issues/2764">#2764</a>)</li>
<li>Additional commits viewable in <a
href="https://github.com/pygithub/pygithub/compare/v2.4.0...v2.5.0">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=pygithub&package-manager=pip&previous-version=2.4.0&new-version=2.5.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore <dependency name> major version` will close this
group update PR and stop Dependabot creating any more for the specific
dependency's major version (unless you unignore this specific
dependency's major version or upgrade to it yourself)
- `@dependabot ignore <dependency name> minor version` will close this
group update PR and stop Dependabot creating any more for the specific
dependency's minor version (unless you unignore this specific
dependency's minor version or upgrade to it yourself)
- `@dependabot ignore <dependency name>` will close this group update PR
and stop Dependabot creating any more for the specific dependency
(unless you unignore this specific dependency or upgrade to it yourself)
- `@dependabot unignore <dependency name>` will remove all of the ignore
conditions of the specified dependency
- `@dependabot unignore <dependency name> <ignore condition>` will
remove the ignore condition of the specified dependency and ignore
conditions


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
---
 poetry.lock    | 8 ++++----
 pyproject.toml | 2 +-
 2 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/poetry.lock b/poetry.lock
index ca49057..f9d5ff2 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -509,13 +509,13 @@ files = [
 
 [[package]]
 name = "pygithub"
-version = "2.4.0"
+version = "2.5.0"
 description = "Use the full Github API v3"
 optional = false
 python-versions = ">=3.8"
 files = [
-    {file = "PyGithub-2.4.0-py3-none-any.whl", hash = "sha256:81935aa4bdc939fba98fee1cb47422c09157c56a27966476ff92775602b9ee24"},
-    {file = "pygithub-2.4.0.tar.gz", hash = "sha256:6601e22627e87bac192f1e2e39c6e6f69a43152cfb8f307cee575879320b3051"},
+    {file = "PyGithub-2.5.0-py3-none-any.whl", hash = "sha256:b0b635999a658ab8e08720bdd3318893ff20e2275f6446fcf35bf3f44f2c0fd2"},
+    {file = "pygithub-2.5.0.tar.gz", hash = "sha256:e1613ac508a9be710920d26eb18b1905ebd9926aa49398e88151c1b526aad3cf"},
 ]
 
 [package.dependencies]
@@ -969,4 +969,4 @@ files = [
 [metadata]
 lock-version = "2.0"
 python-versions = ">= 3.12"
-content-hash = "fcfaed6134f27dcbd4f55b42bae4e7deaf8feae536f412e29ac8be9fbb241cc5"
+content-hash = "f7d531e86abb1e0a2e4ded41b8ea2b3a76b86e2b1b902147f588b88fa1ea5beb"
diff --git a/pyproject.toml b/pyproject.toml
index 501522b..fd6ad7d 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -10,7 +10,7 @@ license = "Apache-2.0"
 python = ">= 3.12"
 requests = "^2.32.3"
 pycairo = "^1.27.0"
-pygithub = "^2.4.0"
+pygithub = "^2.5.0"
 python-slugify = "^8.0.4"
 requests-cache = "^1.2.1"
 ruamel-yaml = "^0.18.6"

From 475cf36eb16a8f5f2e3e5969a116156d5dafd772 Mon Sep 17 00:00:00 2001
From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com>
Date: Mon, 11 Nov 2024 14:28:18 -0500
Subject: [PATCH 2/3] Bump github/codeql-action from 3.27.0 to 3.27.1 in the
 all group (#66)

Bumps the all group with 1 update:
[github/codeql-action](https://github.com/github/codeql-action).

Updates `github/codeql-action` from 3.27.0 to 3.27.1
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/github/codeql-action/releases">github/codeql-action's
releases</a>.</em></p>
<blockquote>
<h2>v3.27.1</h2>
<h1>CodeQL Action Changelog</h1>
<p>See the <a
href="https://github.com/github/codeql-action/releases">releases
page</a> for the relevant changes to the CodeQL CLI and language
packs.</p>
<p>Note that the only difference between <code>v2</code> and
<code>v3</code> of the CodeQL Action is the node version they support,
with <code>v3</code> running on node 20 while we continue to release
<code>v2</code> to support running on node 16. For example
<code>3.22.11</code> was the first <code>v3</code> release and is
functionally identical to <code>2.22.11</code>. This approach ensures an
easy way to track exactly which features are included in different
versions, indicated by the minor and patch version numbers.</p>
<h2>3.27.1 - 08 Nov 2024</h2>
<ul>
<li>The CodeQL Action now downloads bundles compressed using Zstandard
on GitHub Enterprise Server when using Linux or macOS runners. This
speeds up the installation of the CodeQL tools. This feature is already
available to GitHub.com users. <a
href="https://redirect.github.com/github/codeql-action/pull/2573">#2573</a></li>
<li>Update default CodeQL bundle version to 2.19.3. <a
href="https://redirect.github.com/github/codeql-action/pull/2576">#2576</a></li>
</ul>
<p>See the full <a
href="https://github.com/github/codeql-action/blob/v3.27.1/CHANGELOG.md">CHANGELOG.md</a>
for more information.</p>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/github/codeql-action/blob/main/CHANGELOG.md">github/codeql-action's
changelog</a>.</em></p>
<blockquote>
<h1>CodeQL Action Changelog</h1>
<p>See the <a
href="https://github.com/github/codeql-action/releases">releases
page</a> for the relevant changes to the CodeQL CLI and language
packs.</p>
<p>Note that the only difference between <code>v2</code> and
<code>v3</code> of the CodeQL Action is the node version they support,
with <code>v3</code> running on node 20 while we continue to release
<code>v2</code> to support running on node 16. For example
<code>3.22.11</code> was the first <code>v3</code> release and is
functionally identical to <code>2.22.11</code>. This approach ensures an
easy way to track exactly which features are included in different
versions, indicated by the minor and patch version numbers.</p>
<h2>[UNRELEASED]</h2>
<p>No user facing changes.</p>
<h2>3.27.1 - 08 Nov 2024</h2>
<ul>
<li>The CodeQL Action now downloads bundles compressed using Zstandard
on GitHub Enterprise Server when using Linux or macOS runners. This
speeds up the installation of the CodeQL tools. This feature is already
available to GitHub.com users. <a
href="https://redirect.github.com/github/codeql-action/pull/2573">#2573</a></li>
<li>Update default CodeQL bundle version to 2.19.3. <a
href="https://redirect.github.com/github/codeql-action/pull/2576">#2576</a></li>
</ul>
<h2>3.27.0 - 22 Oct 2024</h2>
<ul>
<li>Bump the minimum CodeQL bundle version to 2.14.6. <a
href="https://redirect.github.com/github/codeql-action/pull/2549">#2549</a></li>
<li>Fix an issue where the <code>upload-sarif</code> Action would fail
with &quot;upload-sarif post-action step failed: Input required and not
supplied: token&quot; when called in a composite Action that had a
different set of inputs to the ones expected by the
<code>upload-sarif</code> Action. <a
href="https://redirect.github.com/github/codeql-action/pull/2557">#2557</a></li>
<li>Update default CodeQL bundle version to 2.19.2. <a
href="https://redirect.github.com/github/codeql-action/pull/2552">#2552</a></li>
</ul>
<h2>3.26.13 - 14 Oct 2024</h2>
<p>No user facing changes.</p>
<h2>3.26.12 - 07 Oct 2024</h2>
<ul>
<li>
<p><em>Upcoming breaking change</em>: Add a deprecation warning for
customers using CodeQL version 2.14.5 and earlier. These versions of
CodeQL were discontinued on 24 September 2024 alongside GitHub
Enterprise Server 3.10, and will be unsupported by CodeQL Action
versions 3.27.0 and later and versions 2.27.0 and later. <a
href="https://redirect.github.com/github/codeql-action/pull/2520">#2520</a></p>
<ul>
<li>
<p>If you are using one of these versions, please update to CodeQL CLI
version 2.14.6 or later. For instance, if you have specified a custom
version of the CLI using the 'tools' input to the 'init' Action, you can
remove this input to use the default version.</p>
</li>
<li>
<p>Alternatively, if you want to continue using a version of the CodeQL
CLI between 2.13.5 and 2.14.5, you can replace
<code>github/codeql-action/*@v3</code> by
<code>github/codeql-action/*@v3.26.11</code> and
<code>github/codeql-action/*@v2</code> by
<code>github/codeql-action/*@v2.26.11</code> in your code scanning
workflow to ensure you continue using this version of the CodeQL
Action.</p>
</li>
</ul>
</li>
</ul>
<h2>3.26.11 - 03 Oct 2024</h2>
<ul>
<li>
<p><em>Upcoming breaking change</em>: Add support for using
<code>actions/download-artifact@v4</code> to programmatically consume
CodeQL Action debug artifacts.</p>
<p>Starting November 30, 2024, GitHub.com customers will <a
href="https://github.blog/changelog/2024-04-16-deprecation-notice-v3-of-the-artifact-actions/">no
longer be able to use <code>actions/download-artifact@v3</code></a>.
Therefore, to avoid breakage, customers who programmatically download
the CodeQL Action debug artifacts should set the
<code>CODEQL_ACTION_ARTIFACT_V4_UPGRADE</code> environment variable to
<code>true</code> and bump <code>actions/download-artifact@v3</code> to
<code>actions/download-artifact@v4</code> in their workflows. The CodeQL
Action will enable this behavior by default in early November and
workflows that have not yet bumped to
<code>actions/download-artifact@v3</code> to
<code>actions/download-artifact@v4</code> will begin failing then.</p>
<p>This change is currently unavailable for GitHub Enterprise Server
customers, as <code>actions/upload-artifact@v4</code> and
<code>actions/download-artifact@v4</code> are not yet compatible with
GHES.</p>
</li>
<li>
<p>Update default CodeQL bundle version to 2.19.1. <a
href="https://redirect.github.com/github/codeql-action/pull/2519">#2519</a></p>
</li>
</ul>
<h2>3.26.10 - 30 Sep 2024</h2>
<ul>
<li>We are rolling out a feature in September/October 2024 that sets up
CodeQL using a bundle compressed with <a
href="http://facebook.github.io/zstd/">Zstandard</a>. Our aim is to
improve the performance of setting up CodeQL. <a
href="https://redirect.github.com/github/codeql-action/pull/2502">#2502</a></li>
</ul>
<h2>3.26.9 - 24 Sep 2024</h2>
<p>No user facing changes.</p>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/github/codeql-action/commit/4f3212b61783c3c68e8309a0f18a699764811cda"><code>4f3212b</code></a>
Merge pull request <a
href="https://redirect.github.com/github/codeql-action/issues/2585">#2585</a>
from github/update-v3.27.1-3ef4c0845</li>
<li><a
href="https://github.com/github/codeql-action/commit/63b548d59efbc36249fe81c530cd6abbb92dfb6b"><code>63b548d</code></a>
Update changelog for v3.27.1</li>
<li><a
href="https://github.com/github/codeql-action/commit/3ef4c0845750690942ece9abe29a853edce0f43c"><code>3ef4c08</code></a>
Merge pull request <a
href="https://redirect.github.com/github/codeql-action/issues/2576">#2576</a>
from github/update-bundle/codeql-bundle-v2.19.3</li>
<li><a
href="https://github.com/github/codeql-action/commit/4e033f0e2665ee6b02a64f636ae76c937e3c7293"><code>4e033f0</code></a>
Merge branch 'main' into update-bundle/codeql-bundle-v2.19.3</li>
<li><a
href="https://github.com/github/codeql-action/commit/5ac2ddd6fc78e6c0d2af5b110b19381f38bd84df"><code>5ac2ddd</code></a>
Merge pull request <a
href="https://redirect.github.com/github/codeql-action/issues/2580">#2580</a>
from jsoref/minor-cleanup</li>
<li><a
href="https://github.com/github/codeql-action/commit/3b7b85fbe86fa0c4cbfb2e855f588b595a95609e"><code>3b7b85f</code></a>
Conditionally clear runner cache</li>
<li><a
href="https://github.com/github/codeql-action/commit/688ea5370d3de84af47f851b307068890b8de8bf"><code>688ea53</code></a>
Fix publish-immutable-action version</li>
<li><a
href="https://github.com/github/codeql-action/commit/1e6d67b13813efa924b55655e325752fc41e4890"><code>1e6d67b</code></a>
Give expected-queries-runs permissions</li>
<li><a
href="https://github.com/github/codeql-action/commit/d5e73848c49f7764fd7b8bf826748e767b955fd3"><code>d5e7384</code></a>
Strip trailing whitespace generated by ruamel-yaml</li>
<li><a
href="https://github.com/github/codeql-action/commit/756aa649dfdf25203aa333caa3f5f9503f09400e"><code>756aa64</code></a>
spelling: macos</li>
<li>Additional commits viewable in <a
href="https://github.com/github/codeql-action/compare/662472033e021d55d94146f66f6058822b0b39fd...4f3212b61783c3c68e8309a0f18a699764811cda">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=github/codeql-action&package-manager=github_actions&previous-version=3.27.0&new-version=3.27.1)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore <dependency name> major version` will close this
group update PR and stop Dependabot creating any more for the specific
dependency's major version (unless you unignore this specific
dependency's major version or upgrade to it yourself)
- `@dependabot ignore <dependency name> minor version` will close this
group update PR and stop Dependabot creating any more for the specific
dependency's minor version (unless you unignore this specific
dependency's minor version or upgrade to it yourself)
- `@dependabot ignore <dependency name>` will close this group update PR
and stop Dependabot creating any more for the specific dependency
(unless you unignore this specific dependency or upgrade to it yourself)
- `@dependabot unignore <dependency name>` will remove all of the ignore
conditions of the specified dependency
- `@dependabot unignore <dependency name> <ignore condition>` will
remove the ignore condition of the specified dependency and ignore
conditions


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
---
 .github/workflows/codeql.yml    | 4 ++--
 .github/workflows/scorecard.yml | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
index 744895a..49c24e1 100644
--- a/.github/workflows/codeql.yml
+++ b/.github/workflows/codeql.yml
@@ -68,7 +68,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@662472033e021d55d94146f66f6058822b0b39fd # v3.27.0
+      uses: github/codeql-action/init@4f3212b61783c3c68e8309a0f18a699764811cda # v3.27.1
       with:
         languages: ${{ matrix.language }}
         build-mode: ${{ matrix.build-mode }}
@@ -95,6 +95,6 @@ jobs:
         exit 1
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@662472033e021d55d94146f66f6058822b0b39fd # v3.27.0
+      uses: github/codeql-action/analyze@4f3212b61783c3c68e8309a0f18a699764811cda # v3.27.1
       with:
         category: "/language:${{matrix.language}}"
diff --git a/.github/workflows/scorecard.yml b/.github/workflows/scorecard.yml
index 3610f13..510d4e9 100644
--- a/.github/workflows/scorecard.yml
+++ b/.github/workflows/scorecard.yml
@@ -73,6 +73,6 @@ jobs:
       # Upload the results to GitHub's code scanning dashboard (optional).
       # Commenting out will disable upload of results to your repo's Code Scanning dashboard
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@662472033e021d55d94146f66f6058822b0b39fd # v3.27.0
+        uses: github/codeql-action/upload-sarif@4f3212b61783c3c68e8309a0f18a699764811cda # v3.27.1
         with:
           sarif_file: results.sarif

From e543b9bfc3ae616b31b80db46d4e433a778a6faf Mon Sep 17 00:00:00 2001
From: John Mertic <jmertic@linuxfoundation.org>
Date: Mon, 11 Nov 2024 14:52:50 -0500
Subject: [PATCH 3/3] Update README and INSTRUCTIONS (#8)

Signed-off-by: John Mertic <jmertic@linuxfoundation.org>
---
 INSTRUCTIONS.md | 192 ------------------------------------------------
 README.md       | 118 +++++++++++++++++++----------
 2 files changed, 80 insertions(+), 230 deletions(-)
 delete mode 100644 INSTRUCTIONS.md

diff --git a/INSTRUCTIONS.md b/INSTRUCTIONS.md
deleted file mode 100644
index d645641..0000000
--- a/INSTRUCTIONS.md
+++ /dev/null
@@ -1,192 +0,0 @@
-# How this all works?
-
-The main script [landscapemembers.py](landscapemembers.py) is designed to pull a list of all current members of the given project from LF Members endpoint, using that as the primary source of data for the landscape. Data pulled includes...
-
-- Member name
-- Website
-- Crunchbase URL
-- Twitter handle
-- Logo URL
-
-The pull will look for active members based on the Purchase History, and respect the 'Don't show logo on website' item if selected.
-
-With the data for things like logos and crunchbase entries, there is often more accurate data in other [landscapes](https://landscapes.dev). The script will attempt to look for this, and overlay data from other landscapes if the data from the LF Members endpoint is empty. This also pulls in useful data such as `stock_ticker`, which often has to be set to `null` as the Crunchbase data is inaccurate.
-
-# How to use
-
-You can use this script in a few different ways, but generally one of the below works best
-
-## Recommended - Automatic build with GitHub Actions
-
-Easiest option to do a build is leveraging GitHub Actions, which requires nothing for you to setup on your local machine. You can have it run on demand, or set the `cron` option in the `update_members.yml` action to have it run on a schedule ( this is how it's done for the LF Landscape, which runs nightly at 9:00pm-ish EST ).
-
-If it's all setup, goto the landscape repo under [Actions](actions). You should see a job called 'Update members' on the right side under 'Workflows'. Click that, then on the next screen click 'Run workflow'
-
-There is some prerequiste setup in GitHub.
-
-1) Add [secrets](https://docs.github.com/en/actions/reference/encrypted-secrets) for `PAT`, which is a [GitHub Personal Authorization Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) set for the `repo` scope.
-2) [Add two new labels](https://docs.github.com/en/github/managing-your-work-on-github/managing-labels#creating-a-label) - `automerge` and `automated-build`. These are for this workflow to all work and shouldn't be used for anything else.
-
-Actions are stored in the `.github/workflows` directory. There are three to create if you want to do the entire workflow, including having it autocommit if the build all works successfully.
-
-First one is `update_members.yml`
-
-```yaml
-name: Update members
-
-on:
-  workflow_dispatch:
-  # you can add a cron option here as well if you want it fully hands off
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout Landscape
-        uses: actions/checkout@v4
-        with:
-          path: landscape
-      - name: Checkout landscape-tools
-        uses: actions/checkout@v4
-        with:
-          repository: jmertic/landscape-tools
-          path: landscape-tools
-      - name: Set up Python 3.x
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.x'
-      - name: Install dependencies
-        run: |
-          pip install --no-deps --require-hashes -r landscape-tools/requirements.txt
-      - name: Run build
-        working-directory: ./landscape
-        run: |
-          ../landscape-tools/landscapemembers.py
-      - name: Save missing.csv file
-        uses: actions/upload-artifact@v4
-        with:
-          name: missing-members 
-          path: ./landscape/missing.csv
-      - name: Checkout landscapeapp
-        uses: actions/checkout@v4
-        with:
-          repository: cncf/landscapeapp
-          path: landscapeapp
-      - name: Setup node
-        uses: actions/setup-node@v4
-        with:
-          node-version: '18'
-      - name: Cleanup YAML files
-        working-directory: ./landscapeapp
-        run: |
-          node tools/removePuppeteer
-          npm install
-          PROJECT_PATH=../landscape node tools/removeQuotes
-          PROJECT_PATH=../landscape node tools/pruneExtraEntries
-      - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v6
-        with:
-          token: ${{ secrets.PAT }}
-          branch-suffix: timestamp
-          path: ./landscape
-          title: Update members
-          labels: automated-build
-          commit-message: Update members
-```
-
-Next is `marksuccessfulbuild.yml`, which looks for when the Netlify preview build is done and labels the pull request to be merged. Change the string `omp-landscape` for the name of your landscape in Netlify
-
-```yaml
-name: "Set Issue Label on successful build"
-on:
-  workflow_dispatch:
-  issue_comment:
-    types: [created]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: Amwam/issue-comment-action@v1.3.1
-        if: ${{ github.event.issue.pull_request && contains(github.event.issue.labels.*.name, 'automated-build') }}
-        with:
-          keywords: '["Deploy preview for *omp-landscape* ready"]'
-          labels: '["automerge"]'
-          github-token: "${{ secrets.PAT }}"
-```
-
-Finally, `automerge.yaml` will merge the pull request moments after the issue us labeled `automerge`
-
-```yaml
-name: Autocommit pull requests
-
-on:
-  workflow_dispatch:
-  pull_request:
-    types: [labeled]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Automerge Pull Request if possible
-        uses: "pascalgn/automerge-action@v0.15.5"
-        env:
-          GITHUB_TOKEN: "${{ secrets.PAT }}"
-          MERGE_LABELS: "automerge"
-          MERGE_RETRY_SLEEP: 300000
-          MERGE_METHOD: "squash"
-```
-
-## Optional - Running a full build locally
-
-To run things locally, you'll want to have both this repo and the given landscape repo checked out. The following steps should do that...
-
-```zsh
-git clone https://github.com/jmertic/landscape-tools.git
-git clone [landscape repo url] landscape # if you have multiple landscapes pick a new name here ;-)
-git clone https://github.com/cncf/landscapeapp.git
-cd landscapeapp
-npm install -g yarn@latest
-yarn
-cd ../landscape-tools
-chmod +x *.py
-pip install -r requirements.txt
-./downloadcrunchbasedata.sh
-```
-
-You'll want to add the [API keys](https://github.com/cncf/landscapeapp#api-keys) and [.bash_profile or .zshrc](https://github.com/cncf/landscapeapp#installing-locally) bits here as well.
-
-You will also want to create the `config.yaml` file in the `landscape` directory with the [proper config settings for your landscape](https://github.com/jmertic/landscape-tools#configuration)
-
-Now to run a full build, do the following...
-
-```zsh
-cd landscape # or whatever the directory name you chose above for the landscape clone itself
-../landscape-tools/landscapemembers.py
-yf
-yo
-```
-
-`../landscape-tools/landscapemembers.py` will take about a minute, and will update the `landscape.yml` file in your local clone, as well as adding the logos under `hosted_logos/`.
-
-`yf` likely will take a few minutes on the first run, but should go faster after that. This will update `processed_landscape.yml`
-
-`yo` will run and you can preview the landscape. Once you are happy with thing, commit the changes and push to Github.
-
-```zsh
-git add .
-git commit -m 'Updated member logos' # or whatever you want to set here
-git push
-```
-
-# Troubleshooting errors
-
-There are a few common issues that pop up that require intervention.
-
-- Bad logo, either the 'SVG embeds a PNG' error or 'Convert text to glyph'. Tips on how to resolve these errors and get a proper logo are at https://github.com/cncf/landscapeapp#logos, and then refer to the internal instructions for updating logos.
-- Bad crunchbase entry, for this just add the right one in SF for the member under 'Crunchbase URL'
-- `Build failed because of: no headquarter addresses for xxx`, here you need to update the CrunchBase entry to add a location ( details at https://support.crunchbase.com/hc/en-us/articles/360019601394-Updating-a-Company-Profile )
-- `No cached entry, and can not fetch: xxx. Can't resolve stock ticker XXXX; please manually add a "stock_ticker" key to landscape.yml or set to null`. Usually this means either the stock ticker is set wrong ( for example, the company is merged with another and it changed ) or it's pointing to some foreign stock market that the landscape doesn't know how to handle. In either case the easiest thing to do is set `stock_ticker` to `null`.
diff --git a/README.md b/README.md
index a381f9a..6d03bce 100644
--- a/README.md
+++ b/README.md
@@ -1,57 +1,99 @@
-# Landscape Tools
+# LFX Landscape Tools
 
-[![License](https://img.shields.io/github/license/jmertic/landscape-tools)](LICENSE)
-[![CI](https://github.com/jmertic/landscape-tools/workflows/CI/badge.svg)](https://github.com/jmertic/landscape-tools/actions?query=workflow%3ACI)
-[![codecov](https://codecov.io/gh/jmertic/landscape-tools/graph/badge.svg?token=A05TDQO69V)](https://codecov.io/gh/jmertic/landscape-tools)
-[![CodeQL](https://github.com/jmertic/landscape-tools/actions/workflows/codeql.yml/badge.svg)](https://github.com/jmertic/landscape-tools/actions/workflows/codeql.yml)
+[![License](https://img.shields.io/github/license/jmertic/lfx-landscape-tools)](LICENSE)
+[![CI](https://github.com/jmertic/lfx-landscape-tools/workflows/CI/badge.svg)](https://github.com/jmertic/lfx-landscape-tools/actions?query=workflow%3ACI)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=jmertic_lfx-landscape-tools&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=jmertic_lfx-landscape-tools)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=jmertic_lfx-landscape-tools&metric=coverage)](https://sonarcloud.io/summary/new_code?id=jmertic_lfx-landscape-tools)
 
-This project contains some tools for making it easier to build and maintain a [landscape](https://github.com/cncf/landscapeapp).
+This project contains tools that make building and maintaining a [landscape](https://github.com/cncf/landscapeapp) easier by pulling data from LFX on projects and members. 
 
-Current tools are:
+It is an evolution of the former [landscape-tools](https://github.com/jmertic/landscape-tools), with a refactor to add the ability to pull projects from LFX and generate text logos when a pure SVG does not exist. Additional differences include:
 
-- [landscapemembers.py](landscapemembers.py) - Creates a new landscape.yml or updates an existing landscape.yml file with members populated. Leverages LF SFDC as the primary data source for members include, and uses Crunchbase and [other landscapes](https://github.com/cncf/landscapeapp/blob/master/landscapes.yml) as secondary data sources for data enrichment.
-- [makememberprojectlogos.sh](makememberprojectlogos.sh) - Creates uniform project/product logos for an organization where they don't have a specific logo to use.
-- [downloadcrunchbasedata.sh](downloadcrunchbasedata.sh) - Fetches the latest CSV dump of organizations from crunchbase
-- [buildimages.sh](buildimages.sh) - Creates images for all the projects of a given company, using the given image as base and adds the project name underneath.
+- Only leverage LFX data for members and projects; no longer looks up in CrunchBase or other landscapes.
+- Pull review data from a TAC repo using a specific project format, if used.
+- More verbose error messages that improve debugging.
 
-## Installation
+## Setting up the GitHub Action
 
-```bash
-git clone https://github.com/jmertic/landscape-tools
-cd landscape-tools
-pip install -r requirements.txt
+1) Add [secrets](https://docs.github.com/en/actions/reference/encrypted-secrets) for `PAT`, which is a [GitHub Personal Authorization Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) set for the `repo` scope.
+2) [Add a new label](https://docs.github.com/en/github/managing-your-work-on-github/managing-labels#creating-a-label) - `automated-build`. This is for this workflow to work and shouldn't be used for anything else.
+3) Add the following code to a `build.yml` file in your landscape repo's `.github/workflows/` directory.
+
+```yaml
+name: Build Landscape from LFX
+
+on:
+  workflow_dispatch:
+  schedule:
+  - cron: "0 4 * * *"
+
+jobs:
+  build:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
+        with:
+          egress-policy: audit
+      - uses: jmertic/lfx-landscape-tools@main
+        with:
+          project_processing: skip # see options in action.yml
+        env:
+          token: ${{ secrets.PAT }}
+          repository: ${{ github.repository }}
+          ref: ${{ github.ref }}
 ```
+4) Add the following code to a `validate.yml` file in your landscape repo's `.github/workflows/` directory.
 
-If you wish to use crunchbase as a data source, add this command.
+```yaml
+name: Validate Landscape
 
-```bash
-./downloadcrunchbasedata.sh 
+on:
+  merge_group:
+  pull_request:
+    branches:
+      - main
+      - master
+
+jobs:
+  validate-landscape:
+    runs-on: ubuntu-latest
+    name: "Validate landscape.yml file"
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: cncf/landscape2-validate-action@7f299c46e9b03b4e8bc2896882734fb0b0756b37 # v2.0.0
+        with:
+          target_kind: data
+          target_path: ./landscape.yml
+      - uses: pascalgn/automerge-action@7961b8b5eec56cc088c140b56d864285eabd3f67 # v0.16.4
+        if: success()
+        env:
+          GITHUB_TOKEN: "${{ secrets.PAT }}"
+          MERGE_LABELS: "automated-build"
+          MERGE_RETRY_SLEEP: 300000
+          MERGE_METHOD: "squash"
 ```
 
-## Configuration
+## Local install
 
-All of the Python scripts depend on a `config.yaml` file being present in the same directory as the script to provide any configuration variables, or passing a `-c` option to the script with a path to the config file. Settings are below.
+You can install this tool on your local computer via `pipx`
 
-```yaml
-landscapeName: # short name of your landscape - matches entry at https://github.com/cncf/landscapeapp/blob/master/landscapes.yml
-landscapeMemberClasses: # classes of membership; name matches how it's listed in LF SFDC, and category how it will be listed in the landscape. Example below...
-   - name: Associate Membership
-     category: Associate
-   - name: Gold Membership
-     category: Gold
-   - name: Platinum Membership
-     category: Platinum
-   - name: Silver Membership
-     category: Silver
-project: # project slug
-landscapeMemberCategory: # category name of the members section in the landscape.yml file
-landscapefile: # filename to use for the outputted landscape.yml file
-missingcsvfile: # filename to use for the list of entries with missing parts ( such as a logo, website, or crunchbase entry )
+```bash
+pipx install git+https://github.com/jmertic/lfx-landscape-tools.git
 ```
 
-### Environment variables
+Similarly, you can use the command below to upgrade your local install.
+
+```bash
+pipx upgrade lfx-landscape-tools
+```
 
-This depends on `CRUNCHBASE_KEY` being set to a valid key if you wish to use that as a data source ( required by [downloadcrunchbasedata.sh](downloadcrunchbasedata.sh) ).
+You can then use the `lfxlandscape` command to run the various commands. Use `lfxlandscape --help` for the options.
 
 ## Contributing