Skip to content

Automatically configure the GitHub server URL #32

Open
@martincostello

Description

GitHub Actions provides information about the URLs associated with the GitHub instance running the action, whether that is GitHub.com or GitHub Enterprise Server via the following properties of the github context:

  • api_url
  • graphql_url
  • server_url

Accordingly, when run as a GitHub Action (not as a standalone container), the action could self-configure itself for the current environment, only requiring the URL to be specified if it does not match the execution environment. This would make the action "just work™️" in GitHub Enterprise Server without having to explicitly configure the action.

For example:

---
name: 'Evergreen action'
author: 'github'
description: 'A GitHub Action to request dependabot enablement on eligible repositories in an organization.'
runs:
  using: 'docker'
  image: 'docker://ghcr.io/github/evergreen:v1'
+ env:
+   GH_ENTERPRISE_URL: ${{ github.server_url }}
branding:
  icon: 'file-plus'
  color: 'green'

In this scenario, renaming the variable to GH_URL would probably make the most sense, but it could be still be optional when using the container directly as it is today.

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestkeepdo not mark as staleready-for-workIssue is defined enough to begin implementation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions