History

Karen Bradshaw 87f68710ff correct tool reference front matter		2020-06-09 21:01:24 -04:00
..
README.md	cleanup: remove hugo-version-check.sh. (#18817 )	2020-02-11 11:28:07 -08:00
check-headers-file.sh	Add _headers file checking logic (#9879 )	2018-08-21 12:51:15 -07:00
diff_l10n_branches.py	Changed to print the directory name according to the l10n language. (#18473 )	2020-01-08 14:05:41 -08:00
find_pr.py	Added error handling to find_pr script (#14110 )	2019-05-08 14:12:35 -07:00
replace-capture.sh	correct tool reference front matter	2020-06-09 21:01:24 -04:00
requirements.txt	Add readme for scripts (#14913 )	2019-07-08 15:24:00 -07:00
test_examples.sh	Check all commits in branch for examples (to trigger testing) (#14243 )	2019-06-10 19:54:16 -07:00
upstream_changes.py	Add a script to check differences between translated and English version (#14731 )	2019-06-12 06:49:33 -07:00

README.md

Development scripts for Kubernetes documentation

Script	Description
`find_pr.py`	Find what GitHub pull requests touch a given file.
`upstream_changes.py`	Find what changes occurred between two versions.
`test_examples.sh`	This script tests whether a change affects example files bundled in the website.
`check-headers-file.sh`	This script checks the headers if you are in a production environment.
`diff_l10n_branches.py`	This script generates a report of outdated contents in `content/<l10n-lang>` directory by comparing two l10n team milestone branches.

Requirements

Some of those scripts have external requirements. You can install them with the following commands:

python3 -m pip install -r requirements.txt

find_pr.py

$ ./find_pr.py --help
Usage: find_pr.py [OPTIONS] PATH

  Find what GitHub pull requests touch a given file.

  ex: ./find_pr.py --tags "language/fr" "content/fr/_index.html"

Options:
  --tags TEXT          Tags of PullRequest (Can be passed multiple times)
  --token TEXT         GitHub API token. (Default env variable GITHUB_TOKEN)
  --last-n-pr INTEGER  Last n-th PullRequests
  --help               Show this message and exit.

upstream_changes.py

$ ./upstream_changes.py --help
Usage: upstream_changes.py [OPTIONS] PATH

  Find what changes occurred between two versions

  ex: ./upstream_changes.py content/fr/_index.html

Options:
  --reference TEXT  Specify the reference version of the file. Default to the
                    English one.
  --git-path TEXT   Specify git path
  --help            Show this message and exit.

test_examples.sh

This script tests whether a change affects example files bundled in the website.

To install the dependencies:

$ ./scripts/test_examples.sh install

To run the examples:

$ ./scripts/test_examples.sh run

check-headers-file.sh

This script checks the headers if you are in a production environment.

./scripts/check-headers-file.sh

diff_l10n_branches.py

$ scripts/diff_l10n_branches.py --help
Usage: diff_l10n_branches.py [OPTIONS] L10N_LANG L_COMMIT R_COMMIT

  This script generates a report of outdated contents in `content/<l10n-
  lang>` directory by comparing two l10n team milestone branches.

  L10n team owners can open a GitHub issue with the report generated by this
  script when they start a new team milestone.

  ex: `scripts/diff_l10n_branches.py ko dev-1.15-ko.3 dev-1.15-ko.4`

Options:
  --src-lang TEXT  Source language
  --help           Show this message and exit.