Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(ci): make logs of PR GitHub CI public instead of using github-codebuild-logs #26625

Open
2 tasks
trivikr opened this issue Aug 3, 2023 · 5 comments
Open
2 tasks
Labels
@aws-cdk/aws-logs Related to Amazon CloudWatch Logs effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2

Comments

@trivikr
Copy link
Member

trivikr commented Aug 3, 2023

Describe the feature

Make logs of PR GitHub CI public instead of using github-codebuild-logs

Use Case

The AWS CodeBuild supports publicly viewable build results. When enabled, the build results are accessible to public.

The CodeBuild used by aws-cdk is private, and it uses github-codebuild-logs to add a comment with link to the result. Because of this, and an extra comment is added for each CI build.

Example comment: #26624 (comment)

Proposed Solution

Enable publicly viewable build results on CodeBuild, and disable github-codebuild-logs.

Other Information

No response

Acknowledgements

  • I may be able to implement this feature request
  • This feature might incur a breaking change

CDK version used

N/A

Environment details (OS name and version, etc.)

N/A

@trivikr trivikr added feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Aug 3, 2023
@github-actions github-actions bot added the @aws-cdk/aws-logs Related to Amazon CloudWatch Logs label Aug 3, 2023
@pahud
Copy link
Contributor

pahud commented Aug 3, 2023

Current build log should be public viewable already such as #26624 (comment) but yeah it would be great to use the build-in public viewable build results support.

@pahud pahud added p2 effort/medium Medium work item – several days of effort and removed needs-triage This issue or PR still needs to be triaged. labels Aug 3, 2023
@peterwoodworth
Copy link
Contributor

How would this improve the experience?

@trivikr
Copy link
Member Author

trivikr commented Aug 3, 2023

How would this improve the experience?

The PR author, or anyone viewing the PR, can click on "Details" to view the CodeBuild Logs as they would appear in Console.

aws-codebuild-details-ci

In current experience, the person clicks on Details which attempts to open CodeBuild Logs and fails if you're not logged in with the AWS account running the CodeBuild.

Then the person needs to read the extra comment added by github-codebuild-logs, and open the logs as raw text.

@peterwoodworth
Copy link
Contributor

I understand the request, I don't understand how switching which button you need to press to view the logs improves anything. Did you or someone else get confused at how to view the logs?

@peterwoodworth peterwoodworth added the response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days. label Aug 3, 2023
@trivikr
Copy link
Member Author

trivikr commented Aug 3, 2023

Did you or someone else get confused at how to view the logs?

I clicked on "Details" in CI failure before the github-codebuild-logs comment was posted. It's just additional learning.

I'm maintainer of AWS SDK for JavaScript. We also used github-codebuild-logs pre-2021 when CodeBuild did not have publicly viewable build results. When CodeBuild introduced the feature, we switched to it and removed github-codebuild-logs.

The recommendation is for AWS CDK to also switch to publicly viewable build results, so that it's easier for new visitors and future contributors. If it's too much work, feel free to close it as not planned.

@github-actions github-actions bot removed the response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days. label Aug 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/aws-logs Related to Amazon CloudWatch Logs effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2
Projects
None yet
Development

No branches or pull requests

3 participants