Commit8859caa

Karl Quinsland

authored and

committed

Quick note about GHEbaseUrl config

Opening this PR since issues are disabled.

1 parent4c9f247 commit8859caaCopy full SHA for 8859caa

File tree

+22

-0

lines changed

+22

-0

lines changed

Lines changed: 22 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -169,6 +169,28 @@ jobs:`
`169`	`169`	`}}`
`170`	`170`	`dry_run:${{ github.event.inputs.dry_run }}`
`171`	`171`	```
	`172`	`+`
	`173`	`+### Using with self-hosted git hub enterprise`
	`174`	`+`
	`175`	+If you're using this action in a GHE environment, the value you provide for`baseUrl` needs to be the precise and full URL.
	`176`	`+Consult the [documentation](https://docs.github.com/en/enterprise-server@3.14/rest/quickstart?apiVersion=2022-11-28) for your GHE instance to determine the correct URL to use.`
	`177`	`+`
	`178`	+For this example, let's say that you're running a modern version of GHE and it is accessible at `https://github.mycompany.com`.
	`179`	+The API endpoint for your GHE instance will (probably) be `https://github.mycompany.com/api/v3`.
	`180`	`+So the resulting configuration would look like this:`
	`181`	`+`
	`182`	+```yaml
	`183`	`+jobs:`
	`184`	`+ clean_up:`
	`185`	`+ # <...>`
	`186`	`+ steps:`
	`187`	`+ - name: Delete workflow runs`
	`188`	`+ uses: Mattraks/delete-workflow-runs@v2`
	`189`	`+ with:`
	`190`	`+ # <...>`
	`191`	`+ baseUrl: https://github.mycompany.com/api/v3`
	`192`	+```
	`193`	`+`
`172`	`194`	`##`
`173`	`195`
`174`	`196`	`## License`

Comments

(0)