Environment

See also

./base/envs-example/readme.md: for guide to create environment files.

Environment variables defined in .gh_credentials.

Environment Variable	Default Value	Description
GH_ACCESS_TOKEN	None	GitHub personal access token. Personal Access Tokens
OWNER	None	Owner of repo.
REPO	None	Repo name

In addition to above variables secrets_updater/settings.py defines configuration variables used for interacting with github api.

See also

Github API for endpoint urls, request format and other details.

Environment Variable	Default Value	Description
LOCAL_ENV	.envs/.local	Path for local environment file.
EXCLUDE_ENV_FILES_FROM_UPLOAD	.gh_credentials	List of file names to be excluded form upload process.

GitHub

Note

Create necessary GitHub secrets, Personal Access Tokens and tokens as referenced in yml files.

• Update ./github for various github related actions.

  • /workflows/:

    • ci.yml for ci related tasks.

    • pre-commit-autoupdate.yml for auto updating pre-commit hooks with PR request support.

  • dependabot.yml for setting GitHub dependabot.

Miscellaneous

• .editorconfig: helps to maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs. editorconfig

• .gitattributes: See details here. git-attributes

• .pre-commit-search-and-replace.yaml: See details here. search_and_replace

• .pre-commit-config.yaml: Defines all hooks used as part of pre-commit. See details here. pre-commit-hooks