Skip to content

Commit

Permalink
Python: add new link check action (#9667)
Browse files Browse the repository at this point in the history
### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->
The current link check action (github-action-markdown-link-check) is no
longer being maintained, because the developer created a new one, this
PR adds the new one side by side to test.

### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [x] The code builds clean without any errors or warnings
- [x] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄
  • Loading branch information
eavanvalkenburg authored Nov 13, 2024
1 parent 4a92f34 commit 8ad7ce5
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 47 deletions.
21 changes: 21 additions & 0 deletions .github/.linkspector.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
dirs:
- .
ignorePatterns:
- pattern: "/github/"
- pattern: "./actions"
- pattern: "./blob"
- pattern: "./issues"
- pattern: "./discussions"
- pattern: "./pulls"
- pattern: "^http://localhost"
- pattern: "^https://localhost"
- pattern: "^https://platform.openai.com"
- pattern: "^https://outlook.office.com/bookings"
baseUrl: https://github.com/microsoft/semantic-kernel/
aliveStatusCodes:
- 200
- 206
- 429
- 500
- 503
useGitIgnore: true
39 changes: 0 additions & 39 deletions .github/workflows/markdown-link-check-config.json

This file was deleted.

12 changes: 7 additions & 5 deletions .github/workflows/markdown-link-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,11 @@ jobs:
steps:
- uses: actions/checkout@v4

# Checks the status of hyperlinks in .md files in verbose mode
- name: Check links
uses: gaurav-nelson/github-action-markdown-link-check@v1
# Checks the status of hyperlinks in all files
- name: Run linkspector
uses: umbrelladocs/action-linkspector@v1
with:
use-verbose-mode: "yes"
config-file: ".github/workflows/markdown-link-check-config.json"
reporter: local
filter_mode: nofilter
fail_on_error: true
config_file: ".github/.linkspector.yml"
2 changes: 1 addition & 1 deletion docs/decisions/0032-agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ An _Agent_ can be of various modalities. Modalities are asymmetrical with regar
- _Agent Framework_ shall be extensible so that other libraries can build their own agents and chat experiences.
- _Agent Framework_ shall be as simple as possible to facilitate extensibility.
- _Agent Framework_ shall encapsulate complexity within implementation details, not calling patterns.
- _Agent_ abstraction shall support different modalities (see [Agent Modalities](#Agent-Modalities:) section).
- _Agent_ abstraction shall support different modalities (see [Agent Modalities](#agent-modalities) section).
- An _Agent_ of any modality shall be able to interact with an _Agent_ of any other modality.
- An _Agent_ shall be able to support its own modality requirements. (Specialization)
- _Agent_ input and output shall align to SK content type `ChatMessageContent`.
Expand Down
2 changes: 1 addition & 1 deletion python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ python -m pip install --upgrade semantic-kernel[all]
## OpenAI / Azure OpenAI API keys

Make sure you have an
[OpenAI API Key](https://platform.openai.com) or
[OpenAI API Key](https://platform.openai.com/) or
[Azure OpenAI service key](https://learn.microsoft.com/azure/cognitive-services/openai/quickstart?pivots=rest-api)

There are two methods to manage keys, secrets, and endpoints:
Expand Down
2 changes: 1 addition & 1 deletion python/samples/getting_started_with_agents/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Example|Description
## Configuring the Kernel

Similar to the Semantic Kernel Python concept samples, it is necessary to configure the secrets
and keys used by the kernel. See the follow "Configuring the Kernel" [guide](../concepts/README.md#configuring-the-kernell) for
and keys used by the kernel. See the follow "Configuring the Kernel" [guide](../concepts/README.md#configuring-the-kernel) for
more information.

## Running Concept Samples
Expand Down

0 comments on commit 8ad7ce5

Please sign in to comment.