Skip to content

Commit 8ad7ce5

Browse files
authoredNov 13, 2024
Python: add new link check action (microsoft#9667)
### 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 😄
1 parent 4a92f34 commit 8ad7ce5

File tree

6 files changed

+31
-47
lines changed

6 files changed

+31
-47
lines changed
 

‎.github/.linkspector.yml

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
dirs:
2+
- .
3+
ignorePatterns:
4+
- pattern: "/github/"
5+
- pattern: "./actions"
6+
- pattern: "./blob"
7+
- pattern: "./issues"
8+
- pattern: "./discussions"
9+
- pattern: "./pulls"
10+
- pattern: "^http://localhost"
11+
- pattern: "^https://localhost"
12+
- pattern: "^https://platform.openai.com"
13+
- pattern: "^https://outlook.office.com/bookings"
14+
baseUrl: https://github.com/microsoft/semantic-kernel/
15+
aliveStatusCodes:
16+
- 200
17+
- 206
18+
- 429
19+
- 500
20+
- 503
21+
useGitIgnore: true

‎.github/workflows/markdown-link-check-config.json

-39
This file was deleted.

‎.github/workflows/markdown-link-check.yml

+7-5
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,11 @@ jobs:
1515
steps:
1616
- uses: actions/checkout@v4
1717

18-
# Checks the status of hyperlinks in .md files in verbose mode
19-
- name: Check links
20-
uses: gaurav-nelson/github-action-markdown-link-check@v1
18+
# Checks the status of hyperlinks in all files
19+
- name: Run linkspector
20+
uses: umbrelladocs/action-linkspector@v1
2121
with:
22-
use-verbose-mode: "yes"
23-
config-file: ".github/workflows/markdown-link-check-config.json"
22+
reporter: local
23+
filter_mode: nofilter
24+
fail_on_error: true
25+
config_file: ".github/.linkspector.yml"

‎docs/decisions/0032-agents.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ An _Agent_ can be of various modalities. Modalities are asymmetrical with regar
6060
- _Agent Framework_ shall be extensible so that other libraries can build their own agents and chat experiences.
6161
- _Agent Framework_ shall be as simple as possible to facilitate extensibility.
6262
- _Agent Framework_ shall encapsulate complexity within implementation details, not calling patterns.
63-
- _Agent_ abstraction shall support different modalities (see [Agent Modalities](#Agent-Modalities:) section).
63+
- _Agent_ abstraction shall support different modalities (see [Agent Modalities](#agent-modalities) section).
6464
- An _Agent_ of any modality shall be able to interact with an _Agent_ of any other modality.
6565
- An _Agent_ shall be able to support its own modality requirements. (Specialization)
6666
- _Agent_ input and output shall align to SK content type `ChatMessageContent`.

‎python/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ python -m pip install --upgrade semantic-kernel[all]
1818
## OpenAI / Azure OpenAI API keys
1919

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

2424
There are two methods to manage keys, secrets, and endpoints:

‎python/samples/getting_started_with_agents/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Example|Description
3434
## Configuring the Kernel
3535

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

4040
## Running Concept Samples

0 commit comments

Comments
 (0)
Please sign in to comment.