Skip to content

Commit 39c6486

Browse files
committed
Fix: Merge Conflicts
2 parents 97582b8 + 863f29f commit 39c6486

File tree

1 file changed

+104
-0
lines changed

1 file changed

+104
-0
lines changed

README.md

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,7 @@ The site includes a test suite using [Playwright](https://playwright.dev/) to ve
134134
npm install @playwright/test
135135
```
136136

137+
<<<<<<< HEAD
137138
2. Install a browser (e.g., Firefox):
138139

139140
```console
@@ -223,6 +224,109 @@ ruby ./script/update-download-data.rb
223224
ruby ./script/update-book2.rb
224225
```
225226

227+
=======
228+
---
229+
230+
### 2. Install a browser for Playwright tests (e.g., Firefox)
231+
232+
Playwright supports several browsers including `firefox`, `chromium`, `webkit`, and `chrome`. You can install a specific browser like Firefox using:
233+
234+
```console
235+
npx playwright install firefox
236+
```
237+
238+
> **Note:**
239+
> You can install all supported browsers with `npx playwright install`, but be aware that each browser download is over 100MB. To save space and time, install only the browsers you need.
240+
> In GitHub Actions hosted runners, Chrome is pre-installed, and you might also be able to use your local Chrome installation.
241+
242+
---
243+
244+
### 3. Run tests against your local site
245+
246+
By default, Playwright tests run against [https://git-scm.com/](https://git-scm.com/). To test your local changes, run a local server (e.g., on `http://localhost:5000/`) and then run the tests targeting it:
247+
248+
```console
249+
PLAYWRIGHT_TEST_URL='http://localhost:5000/' npx playwright test --project=firefox
250+
```
251+
252+
You can also run specific tests matching a pattern using `-g <regex>` for more fine-grained testing.
253+
254+
---
255+
256+
## Content Updates
257+
258+
### Manual Pages
259+
260+
1. Install Ruby prerequisites:
261+
262+
```console
263+
bundler install
264+
```
265+
266+
2. Build manual pages from a local Git clone:
267+
268+
```console
269+
ruby ./script/update-docs.rb /path/to/git/.git en
270+
```
271+
272+
To build for a specific version:
273+
274+
```console
275+
version=v2.23.0
276+
REBUILD_DOC=$version ruby ./script/update-docs.rb /path/to/git/.git en
277+
```
278+
279+
To build from GitHub (slower):
280+
281+
```console
282+
export GITHUB_API_TOKEN=github_personal_auth_token
283+
REBUILD_DOC=$version ruby ./script/update-docs.rb remote en
284+
```
285+
286+
For localized man pages, use a local clone of [git-html-l10n](https://github.com/jnavila/git-html-l10n):
287+
288+
```console
289+
ruby ./script/update-docs.rb /path/to/git-html-l10n/.git l10n
290+
REBUILD_DOC=$version ruby ./script/update-docs.rb /path/to/git-html-l10n/.git l10n
291+
```
292+
293+
### Downloads Data
294+
295+
Update the downloads data for the site:
296+
297+
```console
298+
ruby ./script/update-download-data.rb
299+
```
300+
301+
### ProGit Book
302+
303+
1. Install prerequisites:
304+
305+
```console
306+
bundler install
307+
```
308+
309+
2. Clone the book repository and update:
310+
311+
```console
312+
git clone https://github.com/progit/progit2-fr ../progit2-fr
313+
ruby ./script/update-book2.rb fr ../progit2-fr
314+
```
315+
316+
Alternatively, fetch from GitHub:
317+
318+
```console
319+
export GITHUB_API_TOKEN=github_personal_auth_token
320+
ruby ./script/update-book2.rb en
321+
```
322+
323+
To build for all languages:
324+
325+
```console
326+
ruby ./script/update-book2.rb
327+
```
328+
329+
>>>>>>> temp-branch
226330
---
227331

228332
## Contributing

0 commit comments

Comments
 (0)