Skip to content

Naming Convention

The naming convention check ensures that GitHub repositories adhere to ONS' naming standards, defined within the GitHub Usage Policy.

GitHub Usage Policy Origin

Inspired by the GitHub Usage Policy, clause 5.3.2, in summary:

  • Avoid Special Characters
  • Avoid Spaces (use hyphens or underscores instead)
  • Use Lowercase Letters

Check Criteria

  • The repository name must be in lowercase.
  • The repository name must not contain spaces (hyphens or underscores are acceptable).
  • The repository name must not contain special characters (only letters, numbers, hyphens, and underscores are allowed).

Reference

Ensures that the repository name follows GitHub Usage Policy Naming Conventions. This check verifies that the repository name is in lowercase and does not contain spaces or special characters.

Parameters:

Name Type Description Default
repository_name str

The name of the GitHub repository to check.

 required

Returns: dict: A dictionary containing the result of the check (pass/fail), a message, and any relevant details.

Source code in src/policy_methods_library/checks/naming_convention.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
def check_naming_convention(
    repository_name: str,
) -> dict:
    """Ensures that the repository name follows GitHub Usage Policy Naming Conventions.
    This check verifies that the repository name is in lowercase and does not contain spaces or special characters.

    Args:
        repository_name (str): The name of the GitHub repository to check.
    Returns:
        dict: A dictionary containing the result of the check (pass/fail), a message, and any relevant details.
    """

    if not repository_name:
        return {
            "result": "fail",
            "message": "Repository name cannot be empty.",
            "details": {"repository_name": repository_name},
        }

    # Note: Although the lowercase and no spaces check are covered by allowed_characters,
    # they are included as separate checks to provide more specific feedback on why a repository name fails the check.
    # Invalid characters can be grouped together but spaces and uppercase letters would be harder to identify if they are just part of a larger invalid character issue.

    if not repository_name.islower():
        return {
            "result": "fail",
            "message": "Repository name should be in lowercase.",
            "details": {"repository_name": repository_name},
        }

    if " " in repository_name:
        return {
            "result": "fail",
            "message": "Repository name should not contain spaces.",
            "details": {"repository_name": repository_name},
        }

    # Only allow lowercase letters, numbers, hyphens, and underscores in repository names
    allowed_characters = set("abcdefghijklmnopqrstuvwxyz0123456789-_")

    if any(char not in allowed_characters for char in repository_name):
        return {
            "result": "fail",
            "message": "Repository name should only contain letters, numbers, hyphens, and underscores.",
            "details": {"repository_name": repository_name},
        }

    return {
        "result": "pass",
        "message": "Repository name follows GitHub Usage Policy Naming Conventions.",
        "details": {"repository_name": repository_name},
    }

Usage Example

from policy_methods_library.checks.naming_convention import check_naming_convention

repository_name = "example-repository"

response = check_naming_convention(repository_name)

result = response.get("result")
message = response.get("message")

match result:
    case "pass":
        print(f"Check Passed: {message}")
    case "fail":
        print(f"Check Failed: {message}")
    case "error":
        print(f"Check Error: {message}")
    case _:
        print("Unexpected result returned.")

GitHub Integration Used

This check does not directly integrate with GitHub APIs.