Skip to content

Commit 3e89a61

Browse files
committed
docs: fix markdown lint, terminology, and codespell errors
- MD024: rename duplicate "Example" headings to unique names - MD040: add language specifier to fenced code block - Terminology: "repo" → "repository", "git" → "Git", "file names" → "filenames" - Codespell: add .codespellrc to ignore French word "ans" in article title https://claude.ai/code/session_011wKCTFxXQBmCgzGmmfuBmq
1 parent 2ad667b commit 3e89a61

File tree

5 files changed

+9
-7
lines changed

5 files changed

+9
-7
lines changed

.codespellrc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[codespell]
2+
ignore-words-list = ans

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ steps:
1919
- **SLUG** -- Lowercase, replace special characters with `-`, limit to 63 characters. _Dots and underscores preserved._
2020
- **SLUG_URL** -- Same as SLUG, but dots and underscores are also replaced. _Safe for URLs and subdomains._
2121
- **SHORT** -- Shorten Git SHA values to a unique prefix.
22-
- **PART** -- Extract portions of a variable (e.g., owner or repo name from `GITHUB_REPOSITORY`).
22+
- **PART** -- Extract portions of a variable (e.g., owner or repository name from `GITHUB_REPOSITORY`).
2323
- **_CS** -- Case-sensitive variants of SLUG and SLUG_URL (original casing preserved).
2424

2525
> [!TIP]
@@ -31,7 +31,7 @@ steps:
3131
| ----- | ------- | ----------- |
3232
| `prefix` | `""` | Value prepended to each generated variable name |
3333
| `slug-maxlength` | `63` | Max length of slugified values (`"nolimit"` to disable) |
34-
| `short-length` | _(git default)_ | Length of short SHA values (minimum `4`) |
34+
| `short-length` | _(Git default)_ | Length of short SHA values (minimum `4`) |
3535

3636
See the [inputs reference](docs/reference/inputs.md) for details.
3737

docs/explanation/slug-transformation-rules.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This page explains the transformation algorithms used by the GitHub Slug Action,
44

55
## What is a "slug"?
66

7-
A slug is a human-readable identifier derived from a string, safe for use in URLs, file names, DNS labels, and other contexts where special characters are problematic. The term originates from publishing, where a "slug" is a short label used to identify a piece of content.
7+
A slug is a human-readable identifier derived from a string, safe for use in URLs, filenames, DNS labels, and other contexts where special characters are problematic. The term originates from publishing, where a "slug" is a short label used to identify a piece of content.
88

99
In CI/CD workflows, branch names, tag names, and repository names often contain characters (`/`, `@`, spaces) that break when used in URLs, Docker tags, Kubernetes labels, or file paths. Slugifying these values makes them safe for such contexts.
1010

@@ -18,7 +18,7 @@ The `SLUG` transformation applies the following steps in order:
1818
4. **Truncate** to a maximum length (default: 63 characters)
1919
5. **Remove** trailing `-` characters
2020

21-
### Example
21+
### SLUG examples
2222

2323
| Input | Output |
2424
| ----- | ------ |
@@ -33,7 +33,7 @@ Note that `.` and `_` are preserved in SLUG output.
3333

3434
The `SLUG_URL` transformation is identical to `SLUG` except that `.` and `_` are also replaced with `-` in step 2. This makes the result safe for use as a URL path segment or subdomain label, where dots and underscores can cause issues.
3535

36-
### Example
36+
### SLUG_URL examples
3737

3838
| Input | SLUG | SLUG_URL |
3939
| ----- | ---- | -------- |

docs/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ After the action runs, all slug variables are available as environment variables
4343

4444
For a branch named `feat/new_feature` on repository `octocat/Hello-World`, this outputs:
4545

46-
```
46+
```text
4747
Repository slug: octocat-hello-world
4848
Branch slug: feat-new-feature
4949
Short SHA: ffac537e

docs/reference/inputs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The GitHub Slug Action accepts the following inputs in the `with:` block.
66
| ----- | -------- | ------- | ----------- |
77
| `prefix` | No | `""` | Value prepended to each generated variable name. For example, `prefix: CI_` produces `CI_GITHUB_REPOSITORY_SLUG` instead of `GITHUB_REPOSITORY_SLUG`. |
88
| `slug-maxlength` | Yes | `63` | Maximum length of slugified values. Accepts a number or `"nolimit"` to disable truncation. Must not be empty. |
9-
| `short-length` | No | _(git default)_ | Length of shortened SHA values. Minimum `4`. When empty, Git determines the length based on your repository size using [`git rev-parse`][git-revparse]. |
9+
| `short-length` | No | _(Git default)_ | Length of shortened SHA values. Minimum `4`. When empty, Git determines the length based on your repository size using [`git rev-parse`][git-revparse]. |
1010

1111
## Notes
1212

0 commit comments

Comments
 (0)