generated from ubiquity/ts-template
-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'template/development' into chore/merge-…
…sync-template
- Loading branch information
Showing
21 changed files
with
3,012 additions
and
1,353 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
MY_SECRET="MY_SECRET" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,129 @@ | ||
import * as core from "@actions/core"; | ||
import { Octokit } from "@octokit/rest"; | ||
import simpleGit from "simple-git"; | ||
|
||
const token = process.env.GITHUB_TOKEN; | ||
const [owner, repo] = process.env.GITHUB_REPOSITORY?.split("/") || []; | ||
const pullNumber = process.env.GITHUB_PR_NUMBER || process.env.PULL_REQUEST_NUMBER || "0"; | ||
const baseRef = process.env.GITHUB_BASE_REF; | ||
|
||
if (!token || !owner || !repo || pullNumber === "0" || !baseRef) { | ||
core.setFailed("Missing required environment variables."); | ||
process.exit(1); | ||
} | ||
|
||
const octokit = new Octokit({ auth: token }); | ||
const git = simpleGit(); | ||
|
||
async function main() { | ||
try { | ||
const { data: pullRequest } = await octokit.pulls.get({ | ||
owner, | ||
repo, | ||
pull_number: parseInt(pullNumber, 10), | ||
}); | ||
|
||
const baseSha = pullRequest.base.sha; | ||
const headSha = pullRequest.head.sha; | ||
|
||
await git.fetch(["origin", baseSha, headSha]); | ||
|
||
const diff = await git.diff([`${baseSha}...${headSha}`]); | ||
|
||
core.info("Checking for empty strings..."); | ||
const violations = parseDiffForEmptyStrings(diff); | ||
|
||
if (violations.length > 0) { | ||
violations.forEach(({ file, line, content }) => { | ||
core.warning( | ||
"Detected an empty string.\n\nIf this is during variable initialization, consider using a different approach.\nFor more information, visit: https://www.github.com/ubiquity/ts-template/issues/31", | ||
{ | ||
file, | ||
startLine: line, | ||
} | ||
); | ||
}); | ||
|
||
// core.setFailed(`${violations.length} empty string${violations.length > 1 ? "s" : ""} detected in the code.`); | ||
|
||
await octokit.rest.checks.create({ | ||
owner, | ||
repo, | ||
name: "Empty String Check", | ||
head_sha: headSha, | ||
status: "completed", | ||
conclusion: violations.length > 0 ? "failure" : "success", | ||
output: { | ||
title: "Empty String Check Results", | ||
summary: `Found ${violations.length} violation${violations.length !== 1 ? "s" : ""}`, | ||
annotations: violations.map((v) => ({ | ||
path: v.file, | ||
start_line: v.line, | ||
end_line: v.line, | ||
annotation_level: "warning", | ||
message: "Empty string found", | ||
raw_details: v.content, | ||
})), | ||
}, | ||
}); | ||
} else { | ||
core.info("No empty strings found."); | ||
} | ||
} catch (error) { | ||
core.setFailed(`An error occurred: ${error instanceof Error ? error.message : String(error)}`); | ||
} | ||
} | ||
|
||
function parseDiffForEmptyStrings(diff: string) { | ||
const violations: Array<{ file: string; line: number; content: string }> = []; | ||
const diffLines = diff.split("\n"); | ||
|
||
let currentFile: string; | ||
let headLine = 0; | ||
let inHunk = false; | ||
|
||
diffLines.forEach((line) => { | ||
const hunkHeaderMatch = /^@@ -\d+(?:,\d+)? \+(\d+)(?:,\d+)? @@/.exec(line); | ||
if (hunkHeaderMatch) { | ||
headLine = parseInt(hunkHeaderMatch[1], 10); | ||
inHunk = true; | ||
return; | ||
} | ||
|
||
if (line.startsWith("--- a/") || line.startsWith("+++ b/")) { | ||
currentFile = line.slice(6); | ||
inHunk = false; | ||
return; | ||
} | ||
|
||
// Only process TypeScript files | ||
if (!currentFile?.endsWith(".ts")) { | ||
return; | ||
} | ||
|
||
if (inHunk && line.startsWith("+")) { | ||
// Check for empty strings in TypeScript syntax | ||
if (/^\+.*""/.test(line)) { | ||
Check warning on line 106 in .github/empty-string-checker.ts GitHub Actions / check-for-empty-strings
|
||
// Ignore empty strings in comments | ||
if (!line.trim().startsWith("//") && !line.trim().startsWith("*")) { | ||
// Ignore empty strings in template literals | ||
if (!/`[^`]*\$\{[^}]*\}[^`]*`/.test(line)) { | ||
violations.push({ | ||
file: currentFile, | ||
line: headLine, | ||
content: line.substring(1).trim(), | ||
}); | ||
} | ||
} | ||
} | ||
headLine++; | ||
} else if (!line.startsWith("-")) { | ||
headLine++; | ||
} | ||
}); | ||
|
||
return violations; | ||
} | ||
main().catch((error) => { | ||
core.setFailed(`Error running empty string check: ${error instanceof Error ? error.message : String(error)}`); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
import type { KnipConfig } from "knip"; | ||
|
||
const config: KnipConfig = { | ||
entry: ["build/index.ts", ".github/empty-string-checker.ts"], | ||
project: ["src/**/*.ts"], | ||
ignore: ["src/types/config.ts", "**/__mocks__/**", "**/__fixtures__/**"], | ||
ignoreExportsUsedInFile: true, | ||
// eslint can also be safely ignored as per the docs: https://knip.dev/guides/handling-issues#eslint--jest | ||
ignoreDependencies: ["eslint-config-prettier", "eslint-plugin-prettier", "@types/jest", "@mswjs/data"], | ||
eslint: true, | ||
}; | ||
|
||
export default config; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
name: Build | ||
|
||
on: | ||
push: | ||
pull_request: | ||
workflow_dispatch: | ||
|
||
permissions: | ||
contents: read | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-22.04 | ||
|
||
steps: | ||
- name: Check out repository | ||
uses: actions/checkout@v4 | ||
|
||
- name: Set up Node.js | ||
uses: actions/setup-node@v4 | ||
with: | ||
node-version: 20.10.0 | ||
|
||
- name: Build | ||
run: | | ||
yarn | ||
yarn build | ||
- name: Upload build artifact | ||
uses: actions/upload-artifact@v4 | ||
with: | ||
name: static | ||
path: static |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
name: Deploy to Cloudflare Pages | ||
|
||
on: | ||
workflow_run: | ||
workflows: ["Build"] | ||
types: | ||
- completed | ||
|
||
jobs: | ||
deploy-to-cloudflare: | ||
name: Automatic Cloudflare Deploy | ||
runs-on: ubuntu-22.04 | ||
steps: | ||
- name: Deploy to Cloudflare | ||
if: ${{ github.event.workflow_run.conclusion == 'success' }} | ||
uses: ubiquity/cloudflare-deploy-action@main | ||
with: | ||
repository: ${{ github.repository }} | ||
production_branch: ${{ github.event.repository.default_branch }} | ||
build_artifact_name: "static" | ||
output_directory: "static" | ||
current_branch: ${{ github.event.workflow_run.head_branch }} | ||
cloudflare_account_id: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }} | ||
cloudflare_api_token: ${{ secrets.CLOUDFLARE_API_TOKEN }} | ||
commit_sha: ${{ github.event.workflow_run.head_sha }} | ||
workflow_run_id: ${{ github.event.workflow_run.id }} | ||
app_id: ${{ secrets.APP_ID }} | ||
app_private_key: ${{ secrets.APP_PRIVATE_KEY }} |
Oops, something went wrong.