github status context character limit 255

[bob-rohan]

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

Atlantis fails to report status to Github Pull request

Reproduction Steps

As this is character limit I suspect root cause will be in long directory name. As I'm unsure on the comonents of the status message I need some advice from the runatlantis team on this question please.

Logs

Sep 07 16:14:13 ip-10-168-199-68 bash[5613]: {"level":"error","ts":"2022-09-07T16:14:13.324Z","caller":"vcs/instrumented_client.go:203","msg":"Unable to update status at url: https://<REDACT>/jobs/7aae3453-d509-448a-8ca2-fe970f645c36, error: POST https://<REDACT>api/v3/repos/<REDACT>/statuses/dada198778bb3621dd9c4663cbf4289bc3a240c3: 422 Validation Failed [{Resource:Status Field:context Code:custom Message:context is too long (maximum is 255 characters)}]","json":{"repository":"<REDACT>","pull-num":"983"},"stacktrace":"github.com/runatlantis/atlantis/server/events/vcs.(*InstrumentedClient).UpdateStatus\n\t/home/runner/work/atlantis/atlantis/server/events/vcs/instrumented_client.go:203\ngithub.com/runatlantis/atlantis/server/events/vcs.(*ClientProxy).UpdateStatus\n\t/home/runner/work/atlantis/atlantis/server/events/vcs/proxy.go:76\ngithub.com/runatlantis/atlantis/server/events.(*DefaultCommitStatusUpdater).UpdateProject\n\t/home/runner/work/atlantis/atlantis/server/events/commit_status_updater.go:96\ngithub.com/runatlantis/atlantis/server/jobs.(*JobURLSetter).SetJobURLWithStatus\n\t/home/runner/work/atlantis/atlantis/server/jobs/job_url_setter.go:41\ngithub.com/runatlantis/atlantis/server/events.(*ProjectOutputWrapper).updateProjectPRStatus\n\t/home/runner/work/atlantis/atlantis/server/events/project_command_runner.go:164\ngithub.com/runatlantis/atlantis/server/events.(*ProjectOutputWrapper).Plan\n\t/home/runner/work/atlantis/atlantis/server/events/project_command_runner.go:149\ngithub.com/runatlantis/atlantis/server/events.RunAndEmitStats\n\t/home/runner/work/atlantis/atlantis/server/events/instrumented_project_command_runner.go:39\ngithub.com/runatlantis/atlantis/server/events.(*InstrumentedProjectCommandRunner).Plan\n\t/home/runner/work/atlantis/atlantis/server/events/instrumented_project_command_runner.go:13\ngithub.com/runatlantis/atlantis/server/events.runProjectCmdsParallel.func1\n\t/home/runner/work/atlantis/atlantis/server/events/project_command_pool_executor.go:28"}
Sep 07 16:14:13 ip-10-168-199-68 bash[5613]: {"level":"error","ts":"2022-09-07T16:14:13.324Z","caller":"events/project_command_runner.go:165","msg":"updating project PR status%!(EXTRA *github.ErrorResponse=POST https://<REDACT>/api/v3/repos/<REDACT>/statuses/dada198778bb3621dd9c4663cbf4289bc3a240c3: 422 Validation Failed [{Resource:Status Field:context Code:custom Message:context is too long (maximum is 255 characters)}])","json":{"repo":"<REDACT>","pull":"983"},"stacktrace":"github.com/runatlantis/atlantis/server/events.(*ProjectOutputWrapper).updateProjectPRStatus\n\t/home/runner/work/atlantis/atlantis/server/events/project_command_runner.go:165\ngithub.com/runatlantis/atlantis/server/events.(*ProjectOutputWrapper).Plan\n\t/home/runner/work/atlantis/atlantis/server/events/project_command_runner.go:149\ngithub.com/runatlantis/atlantis/server/events.RunAndEmitStats\n\t/home/runner/work/atlantis/atlantis/server/events/instrumented_project_command_runner.go:39\ngithub.com/runatlantis/atlantis/server/events.(*InstrumentedProjectCommandRunner).Plan\n\t/home/runner/work/atlantis/atlantis/server/events/instrumented_project_command_runner.go:13\ngithub.com/runatlantis/atlantis/server/events.runProjectCmdsParallel.func1\n\t/home/runner/work/atlantis/atlantis/server/events/project_command_pool_executor.go:28"}

Environment details

• Atlantis version:0.19.7
• If not running the latest Atlantis version have you tried to reproduce this issue on the latest version:
• Atlantis flags:

  /usr/local/bin/atlantis server
  --gh-user=MASKED
  --gh-token=MASKED
  --gh-hostname=MASKED
  --port MASKED
  --repo-allowlist=MASKED
  --repo-config=/var/atlantis/repo-config.yml
  --enable-diff-markdown-format
  --hide-prev-plan-comments
  --skip-clone-no-changes
  --disable-autoplan
  --atlantis-url=MASKED
  --gh-webhook-secret=MASKED
  --log-level=debug
  --automerge

Atlantis server-side config file:

repos:
- id: "/.*/"
  allowed_overrides: [workflow]
  pre_workflow_hooks:
    - run: tac_wrapper # terragrunt-atlantis-config generate --output atlantis.yaml --autoplan --parallel --create-workspace
  post_workflow_hooks:
    - run: rm atlantis.yaml || true
  workflow: terragrunt
  apply_requirements: [mergeable, approved]
workflows:
  terragrunt:
    plan:
      steps:
      - run: terragrunt plan -no-color -out=$PLANFILE
      - run: terragrunt show -json $PLANFILE > $SHOWFILE
    apply:
      steps:
      - run: terragrunt apply -no-color $PLANFILE

Repo atlantis.yaml file:

See tac_wrapper pre_workflow_hooks above

Additional Context

.

[bob-rohan]

Found some old PRs with context defined as atlantis/apply: <path>/<workspace>

Therefore where the workspace is the same as path, the path limit is 119 characters.