Skip to content

tutorial on CI logs #245

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

drammock
Copy link
Member

WIP, do not merge

Copy link

netlify bot commented May 12, 2025

Deploy Preview for learn-scientific-python-org ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 4483d25
🔍 Latest deploy log https://app.netlify.com/sites/learn-scientific-python-org/deploys/68214333ea7398000839ec9c
😎 Deploy Preview https://deploy-preview-245--learn-scientific-python-org.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 100
Accessibility: 97
Best Practices: 100
SEO: 100
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@henryiii
Copy link
Contributor

Pictures won't be maintainable, they will go out of date quickly (I made that mistake with my azure-pipelines wheel posts; when I rewrote it for GHA pages in the developer guide, I avoided pictures and that was much better. I'd also either just keep in high-level (figuring out how to find logs isn't that hard on most CI services!), or just specialize in one (GHA) and then mention differences at the end.

@drammock
Copy link
Member Author

I forgot I had opened this PR 😅

Pictures won't be maintainable, they will go out of date quickly

I share this concern, which is part of why I didn't finish this yet. However I disagree with the statement that

figuring out how to find logs isn't that hard on most CI services!

I've had numerous contributors say "hey, CIs are failing but I don't know how to find out why". Nowadays for GH Actions or CircleCI it's pretty easy (one click from the PR page, and it auto-scrolls to the failing job step), but Azure Pipelines seems to often trip folks up. After clicking on the failing job in the PR summary, there's a prominent center-screen "N errors / M warnings" link, which then leads to another screen where you have to select all over again which job you want to view. IIRC there's a more direct way to get there (2 clicks instead of 3) but folks often miss it.

@henryiii
Copy link
Contributor

I think that would fit under the "mention differences"; you could say "click on the check to view the logs", then have a callout for the CI services that make it more difficult. (I think Packit-as-a-Service takes the award here for hardest to find logs :) )

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants