Skip to content

Environment Variable for Repository #85

@meingraham

Description

@meingraham

For security/confidentiality reasons, the plug-in currently provides a means to use an environment variable (MKDOCS_GIT_COMMITTERS_APIKEY) to pass the access token to the plug-in. I have a request for a dev/prod scenario.

The master repo has ownership/maintainer ACLs. Contributors fork the master and work on their fork. The master runs mkdocs through a CI/CD pipeline. It obviously needs to refer to the master repo. For contributors, they can run mkdocs on their "local" repo so they can verify the results of their edits. In this case, mkdocs needs to reference the local fork. The APIKEY local environment variable allows users to set the value to their own access token while the master's automation can set its access token accordingly. Unfortunately, the repo ID (Gitlab) currently has to be hard coded in mkdocs.yml. Therefore, currently contributors have to maintain their own version of mkdocs.yml pointing to their fork and not commit this file so that it does not overwrite the master mkdocs.yml.

Would it be possible to have an environment variable to set the repository stub (GtiHub)/ID (Gitlab)?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions