Skip to content

Commit 7d64590

Browse files
authored
Tidy up gitignore, prettierignore, dockerignore (#57403)
1 parent 53f2b04 commit 7d64590

File tree

5 files changed

+108
-62
lines changed

5 files changed

+108
-62
lines changed

.dockerignore

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@
44
.vscode/
55
contributing/
66
docs/
7-
node_modules/
8-
tests/
9-
# Folder is cloned during the Dockerfile build
107
docs-early-access/
8+
node_modules/
119
README.md
10+
tests/

.github/CODEOWNERS

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
# https://git-scm.com/docs/gitignore
55

66
# Site Policy
7-
/content/site-policy/ @github/site-policy-admins
7+
content/site-policy/ @github/site-policy-admins
88

99
# Enterprise
10-
/data/release-notes/**/*.yml @github/docs-content-enterprise
10+
data/release-notes/**/*.yml @github/docs-content-enterprise
1111
src/ghes-releases/lib/enterprise-dates.json @github/docs-content-enterprise
1212

1313
# Requires review of #actions-oidc-integration, docs-engineering/issues/1506

.gitignore

Lines changed: 94 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,113 @@
1-
.search-cache
1+
# Test coverage reports
2+
.coverage/
3+
4+
# macOS system files
25
.DS_Store
6+
7+
# Environment variables (contains secrets)
38
.env
4-
.vscode/settings.json
5-
.idea/
6-
/node_modules/
7-
npm-debug.log
8-
coverage/
9-
/assets/images/early-access
10-
/content/early-access
11-
/data/early-access
12-
/src/dev-toc/static
13-
.next
9+
10+
# ESLint cache for faster linting
1411
.eslintcache
15-
*.tsbuildinfo
16-
/translations/
12+
13+
# JetBrains IDE files
14+
.idea/
15+
16+
# Tracks package-lock.json installation state
17+
.installed.package-lock.json
18+
19+
# Linkinator full site link check results
20+
.linkinator/
21+
22+
# Next.js build output
23+
.next/
24+
25+
# Node.js version specification
1726
.node-version
18-
.linkinator/full.log
19-
next-env.d.ts
20-
nohup.out
2127

22-
# blc: broken link checker
28+
# Precomputed page info cache (brotli compressed)
29+
.pageinfo-cache.json.br
30+
31+
# getRemoteJSON() disk cache for archived content
32+
.remotejson-cache/
33+
34+
# VS Code workspace settings
35+
.vscode/settings.json
36+
37+
# TypeScript incremental build info
38+
*.tsbuildinfo
39+
40+
# Early access images from docs-early-access repo
41+
assets/images/early-access/
42+
43+
# Accidentally committed file that should be ignored
44+
assets/images/help/writing/unordered-list-rendered (1).png
45+
46+
# Old broken link checker output
2347
blc_output.log
48+
49+
# Old internal broken link checker output
2450
blc_output_internal.log
51+
52+
# Old broken links report
2553
broken_links.md
26-
# This one is purely for historical reasons because so many people might
27-
# still have these files on their disk.
28-
lib/redirects/.redirects-cache*.json
2954

55+
# Early access content from docs-early-access repo
56+
content/early-access/
57+
58+
# Test coverage reports
59+
coverage/
60+
61+
# Early access data from docs-early-access repo
62+
data/early-access/
3063

31-
# Logs from scripts
32-
*/logs/
64+
# Cloned for Elasticsearch indexing data
65+
docs-internal-data/
66+
67+
# External link checker cache database
3368
external-link-checker-db.json
3469

35-
# Playwright related
36-
/test-results/
37-
/playwright-report/
38-
/playwright/.cache/
70+
# Historical redirects cache (legacy)
71+
lib/redirects/.redirects-cache*.json
3972

40-
# Automated content source
41-
rest-api-description
42-
semmle-code
43-
models-gateway
73+
# Script execution logs
74+
logs/
4475

45-
.installed.package-lock.json
46-
assets/images/help/writing/unordered-list-rendered (1).png
76+
# GitHub Models API descriptions
77+
models-gateway/
4778

48-
# Used by getRemoteJSON()
49-
.remotejson-cache/
79+
# Next.js TypeScript environment definitions
80+
next-env.d.ts
5081

51-
# Used by precompute-pageinfo
52-
.pageinfo-cache.json.br
82+
# Node.js dependencies
83+
node_modules/
5384

54-
# Cloned and used for indexing Elasticsearch data
55-
docs-internal-data/
85+
# Background process output
86+
nohup.out
87+
88+
# NPM debug logs
89+
npm-debug.log
90+
91+
# Playwright test reports
92+
playwright-report/
5693

57-
# For intermediate data (like scraping for Elasticsearch indexing)
94+
# Playwright browser cache
95+
playwright/.cache/
96+
97+
# REST API OpenAPI descriptions
98+
rest-api-description/
99+
100+
# CodeQL CLI documentation source
101+
semmle-code/
102+
103+
# Development table of contents static HTML files
104+
src/dev-toc/static/
105+
106+
# Playwright test result artifacts
107+
test-results/
108+
109+
# Temporary data files
58110
tmp/
111+
112+
# Localized content from translation repositories
113+
translations/

.prettierignore

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,2 @@
11
data/release-notes/
22
src/bookmarklets/
3-
/.next/
4-
5-
/.coverage
6-
/coverage
7-
8-
# Automated content source
9-
rest-api-description
10-
semmle-code

Dockerfile

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ RUN --mount=type=secret,id=DOCS_BOT_PAT_BASE,mode=0444 \
5353
echo "Don't cache this step by printing date: $(date)" && \
5454
. ./build-scripts/fetch-repos.sh
5555

56-
# -----------------------------------------
56+
# ------------------------------------------------
5757
# PROD_DEPS STAGE: Install production dependencies
58-
# -----------------------------------------
58+
# ------------------------------------------------
5959
FROM base AS prod_deps
6060
USER node:node
6161
WORKDIR $APP_HOME
@@ -66,17 +66,17 @@ COPY --chown=node:node package.json package-lock.json ./
6666
# Install only production dependencies (skip scripts to avoid husky)
6767
RUN npm ci --omit=dev --ignore-scripts --registry https://registry.npmjs.org/
6868

69-
# -----------------------------------------
69+
# ------------------------------------------------------------
7070
# ALL_DEPS STAGE: Install all dependencies on top of prod deps
71-
# -----------------------------------------
71+
# ------------------------------------------------------------
7272
FROM prod_deps AS all_deps
7373

7474
# Install dev dependencies on top of production ones
7575
RUN npm ci --registry https://registry.npmjs.org/
7676

77-
# -----------------------------------------
77+
# ----------------------------------
7878
# BUILD STAGE: Build the application
79-
# -----------------------------------------
79+
# ----------------------------------
8080
FROM base AS build
8181
USER node:node
8282
WORKDIR $APP_HOME
@@ -99,17 +99,17 @@ COPY --chown=node:node --from=all_deps $APP_HOME/node_modules node_modules/
9999
# Build the application
100100
RUN npm run build
101101

102-
# -----------------------------------------
102+
# ---------------------------------------------
103103
# WARMUP_CACHE STAGE: Warm up remote JSON cache
104-
# -----------------------------------------
104+
# ---------------------------------------------
105105
FROM build AS warmup_cache
106106

107107
# Generate remote JSON cache
108108
RUN npm run warmup-remotejson
109109

110-
# -----------------------------------------
110+
# --------------------------------------
111111
# PRECOMPUTE STAGE: Precompute page info
112-
# -----------------------------------------
112+
# --------------------------------------
113113
FROM build AS precompute_stage
114114

115115
# Generate precomputed page info

0 commit comments

Comments
 (0)