Skip to content

Commit 32fc223

Browse files
authored
Cleanup special characters (added cleanup script) (#248)
* Cleanup special characters Signed-off-by: Mihai Criveti <[email protected]> * renamed cleanup script for ghcr Signed-off-by: Mihai Criveti <[email protected]> * Added cleanup script for AI artifacts Signed-off-by: Mihai Criveti <[email protected]> * Added cleanup script for AI artifacts Signed-off-by: Mihai Criveti <[email protected]> * Cleanup special characters Signed-off-by: Mihai Criveti <[email protected]> --------- Signed-off-by: Mihai Criveti <[email protected]>
1 parent 44a6f50 commit 32fc223

File tree

124 files changed

+1681
-1052
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

124 files changed

+1681
-1052
lines changed

.env.ce.example

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
###############################################################################
2-
# IBM Cloud Code Engine deployment-only variables
3-
# Required *only* when you deploy MCP Gateway to IBM Cloud.
4-
# These keys are consumed by the Makefile / ibmcloud CLI and are **NOT**
2+
# IBM Cloud Code Engine - deployment-only variables
3+
# - Required *only* when you deploy MCP Gateway to IBM Cloud.
4+
# - These keys are consumed by the Makefile / ibmcloud CLI and are **NOT**
55
# injected into the running container.
6-
# Copy this file to `.env.ce`, fill in real values, keep it out of Git.
6+
# - Copy this file to `.env.ce`, fill in real values, keep it out of Git.
77
###############################################################################
88

99
# ── Core IBM Cloud context ──────────────────────────────────────────────

.github/ISSUE_TEMPLATE/chore-task--devops--linting--maintenance-.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,15 @@ Why is this task needed? Does it reduce tech debt, unblock other work, or improv
4141

4242
Reference any relevant Makefile targets that are involved, if applicable. Ex:
4343

44-
- `make lint` run ruff, mypy, flake8, etc.
45-
- `make pre-commit` run pre-configured hooks
46-
- `make install-web-linters` installs npm-based linters
47-
- `make sonar-submit-docker` run SonarQube scanner via Docker
48-
- `make sbom` generate CycloneDX software bill of materials
49-
- `make pip-licenses` generate markdown license inventory
50-
- `make spellcheck` spell-check source + docs
51-
- `make update` update Python dependencies in the venv
52-
- `make check-env` validate required `.env` entries
44+
- `make lint` - run ruff, mypy, flake8, etc.
45+
- `make pre-commit` - run pre-configured hooks
46+
- `make install-web-linters` - installs npm-based linters
47+
- `make sonar-submit-docker` - run SonarQube scanner via Docker
48+
- `make sbom` - generate CycloneDX software bill of materials
49+
- `make pip-licenses` - generate markdown license inventory
50+
- `make spellcheck` - spell-check source + docs
51+
- `make update` - update Python dependencies in the venv
52+
- `make check-env` - validate required `.env` entries
5353

5454
---
5555

.github/ISSUE_TEMPLATE/feature-request.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Please select the most appropriate category:
3434

3535
---
3636

37-
### 🙋♂️ User Story 1
37+
### 🙋♂️ User Story 1
3838

3939
**As a:** <type of user>
4040
**I want:** <some goal>
@@ -55,7 +55,7 @@ Scenario: Second scenario title
5555

5656
---
5757

58-
### 🙋♂️ User Story 2
58+
### 🙋♂️ User Story 2
5959

6060
**As a:** <another type of user>
6161
**I want:** <a different goal>

.github/PULL_REQUEST_TEMPLATE/bug_fix.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
Before opening this PR please:
44

5-
1. `make lint` passes `ruff`, `mypy`, `pylint`
6-
2. `make test` all unit + integration tests green
7-
3. `make coverage` ≥ 90 %
5+
1. `make lint` - passes `ruff`, `mypy`, `pylint`
6+
2. `make test` - all unit + integration tests green
7+
3. `make coverage` - ≥ 90 %
88
4. `make docker docker-run-ssl` or `make podman podman-run-ssl`
99
5. Update relevant documentation.
1010
6. Tested with sqlite and postgres + redis.

.github/PULL_REQUEST_TEMPLATE/docs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Closes #
1212

1313
---
1414

15-
## 📝 Summary (12 sentences)
15+
## 📝 Summary (1-2 sentences)
1616
_What section of the docs is changing and why?_
1717

1818
---

.github/PULL_REQUEST_TEMPLATE/feature.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Closes #
66

77
---
88

9-
## 🚀 Summary (12 sentences)
9+
## 🚀 Summary (1-2 sentences)
1010
_What does this PR add or change?_
1111

1212
---
@@ -25,7 +25,7 @@ _Design sketch, screenshots, or extra context._
2525
If the change introduces or alters an architectural decision, add or update an ADR in **`docs/docs/adr/`** and link it here._
2626

2727
```mermaid
28-
%% Example diagram delete if not needed
28+
%% Example diagram - delete if not needed
2929
flowchart TD
3030
A[Client] -->|POST /completions| B(MCPGateway)
3131
B --> C[Completion Service]

.github/codeql-config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
# 📄 CodeQL Configuration
33
# ===============================================================
44
# This configuration:
5-
# Utilizes standard 'security-extended' and 'security-and-quality' query suites
6-
# Excludes 'tests' and 'docs' directories from analysis
5+
# - Utilizes standard 'security-extended' and 'security-and-quality' query suites
6+
# - Excludes 'tests' and 'docs' directories from analysis
77
# ---------------------------------------------------------------
88

99
name: "CodeQL Configuration"

.github/tools/cleanup.sh renamed to .github/tools/cleanup-ghcr-versions.sh

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@
1313
# deletion modes to help you keep the container registry clean.
1414
#
1515
# Features:
16-
# Dry-run by default to avoid accidental deletion
17-
# Tag whitelisting with regular expression matching
18-
# GitHub CLI integration with scope validation
19-
# CI/CD-compatible via environment overrides
16+
# - Dry-run by default to avoid accidental deletion
17+
# - Tag whitelisting with regular expression matching
18+
# - GitHub CLI integration with scope validation
19+
# - CI/CD-compatible via environment overrides
2020
#
2121
# Requirements:
22-
# GitHub CLI (gh) v2.x with appropriate scopes
23-
# jq (command-line JSON processor)
22+
# - GitHub CLI (gh) v2.x with appropriate scopes
23+
# - jq (command-line JSON processor)
2424
#
2525
# Required Token Scopes:
2626
# delete:packages
@@ -79,7 +79,7 @@ if scopes=$(gh auth status --show-token 2>/dev/null | grep -oP 'Token scopes: \K
7979
fi
8080

8181
if [[ ${#missing_scopes[@]} -gt 0 ]]; then
82-
echo "⚠️ Your token scopes are [$scopes] but you're missing: [$(IFS=','; echo "${missing_scopes[*]}")]"
82+
echo "⚠️ Your token scopes are [$scopes] - but you're missing: [$(IFS=','; echo "${missing_scopes[*]}")]"
8383
echo " Run: gh auth refresh -h github.com -s $NEEDED_SCOPES"
8484
exit 1
8585
fi
@@ -105,7 +105,7 @@ KEEP_REGEX="^($(IFS='|'; echo "${KEEP_TAGS[*]}"))$"
105105
##############################################################################
106106
delete_ids=()
107107

108-
echo "📦 Scanning ghcr.io/${ORG}/${PKG} "
108+
echo "📦 Scanning ghcr.io/${ORG}/${PKG} ..."
109109

110110
# Process versions and collect IDs to delete
111111
while IFS= read -r row; do
@@ -144,9 +144,9 @@ if [[ $DRY_RUN == true ]]; then
144144
if [[ $ASK_CONFIRM == true ]]; then
145145
echo
146146
read -rp "Proceed to delete the ${#delete_ids[@]} versions listed above? (y/N) " reply
147-
[[ $reply =~ ^[Yy]$ ]] || { echo "Aborted nothing deleted."; exit 0; }
147+
[[ $reply =~ ^[Yy]$ ]] || { echo "Aborted - nothing deleted."; exit 0; }
148148
fi
149-
echo "🚀 Re-running in destructive mode "
149+
echo "🚀 Re-running in destructive mode ..."
150150
DRY_RUN=false exec "$0" --yes
151151
else
152152
echo "🗑️ Deleting ${#delete_ids[@]} versions..."

.github/tools/generate-changelog-info.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ ISSUES_JSON=$(gh issue list --state closed \
4747

4848
echo "$ISSUES_JSON" | jq -r '
4949
sort_by(.closedAt)[]
50-
| "#\(.number) \(.title) (closed: \(.closedAt))"
50+
| "#\(.number) - \(.title) (closed: \(.closedAt))"
5151
' >>"$OUT"
5252

5353
###############################################################################

0 commit comments

Comments
 (0)