--hide-prev-plan-comments doesn't work if Github App name contains a period

[krrrr38]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request. Searching for pre-existing feature requests helps us consolidate datapoints for identical requirements into a single place, thank you!
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.
• If you are interested in working on this issue or have submitted a pull request, please leave a comment.

---

Overview of the Issue

When create GitHub app which contains ., --hide-prev-plan-comments option never works fine.

Becasue GitHub uses app name as atlantis.app and identifier is atlantis-app like a following.

Reproduction Steps

1. create GitHub app which contains . e.g. atlantis.app
2. setup GitHub app credential
3. restart atlantis with following configurations

• --gh-app-slug=atlantis-app
• --hide-prev-plan-comments

then hide-prev-plan-comments not works, because github pr comment uses atlantis-app[bot] not atlantis.app[bot].

If we use --gh-app-slug=atlantis.app, we got following error.

Error: initializing server: getting user: getting app details: GET https://api.github.com/apps/atlantis.app: 404 Not Found []

Environment details

• Atlantis version: v0.20.1
• Atlantis flags:

Atlantis server-side config file:

ATLANTIS_HIDE_PREV_PLAN_COMMENTS=true
ATLANTIS_ATLANTIS_URL=${ATLANTIS_URL}
ATLANTIS_REPO_CONFIG=/opt/atlantis/repos.yaml
ATLANTIS_REPO_ALLOWLIST=${REPOSITORY}
ATLANTIS_WRITE_GIT_CREDS=true
ATLANTIS_GH_APP_ID=263516
ATLANTIS_GH_APP_SLUG="atlantis-app"
ATLANTIS_GH_APP_KEY_FILE=${GH_APP_KEY_FILE}
ATLANTIS_GH_WEBHOOK_SECRET=${GH_WEBHOOK_SECRET}

Additional Context

There are 2 solutions. When create atlantis.app GitHub app,

• 1: Use --gh-app-slug=atlantis.app and get app info from https://api.github.com/apps/atlantis-app not https://api.github.com/apps/atlantis.app in the following code.

atlantis/server/events/vcs/github_credentials.go

Line 104 in 020eeba

app, _, err := ghClient.Apps.Get(ctx, c.AppSlug)

• 2: Use --gh-app-slug=atlantis-app and convert username in the following code.

atlantis/server/events/vcs/github_credentials.go

Lines 109 to 111 in 020eeba

	// Currently there is no way to get the bot's login info, so this is a
	// hack until Github exposes that.
	return fmt.Sprintf("%s[bot]", app.GetName()), nil

[nitrocode]

I believe this is a duplicate of #1161

[nitrocode]

If it's separate, please open a PR. We'd be happy to merge it. :)

[nitrocode]

Do you mean a comma , or a period . ? The github app name you show contains a period.

[krrrr38]

Thank you for sharing the nearest issue and editing the description. You are right.

I think #2697 may solve these issues.