Skip to content

DOCS-3816: Add workflow permissions to update module instructions#4178

Closed
JessamyT wants to merge 2 commits intoviamrobotics:mainfrom
JessamyT:3816permissions
Closed

DOCS-3816: Add workflow permissions to update module instructions#4178
JessamyT wants to merge 2 commits intoviamrobotics:mainfrom
JessamyT:3816permissions

Conversation

@JessamyT
Copy link
Copy Markdown
Contributor

@JessamyT JessamyT commented Apr 1, 2025

No description provided.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Apr 1, 2025
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 1, 2025

Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit 76d25b5
🔍 Latest deploy log https://app.netlify.com/sites/viam-docs/deploys/67ed6d56a8c1870008c41e31
😎 Deploy Preview https://deploy-preview-4178--viam-docs.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: 20 (🔴 down 6 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: 70 (no change from production)
View the detailed breakdown and full score reports

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

Copy link
Copy Markdown
Contributor

@npentrel npentrel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are you adding this? I've used the gh workflows and have not had to do this for my repositories

@JessamyT
Copy link
Copy Markdown
Contributor Author

JessamyT commented Apr 2, 2025

Why are you adding this? I've used the gh workflows and have not had to do this for my repositories

Oh really? I’ve always had to do it, and with the micro stuff that is in the works, Esha had to do it with those as well (that’s separate but perhaps supports that what I ran into wasn’t a fluke).
Checking with SME

@JessamyT JessamyT requested a review from npentrel April 2, 2025 16:39
@JessamyT
Copy link
Copy Markdown
Contributor Author

JessamyT commented Apr 2, 2025

Perhaps this is because I was in my own private repo vs in viam-labs or somesuch? I could move this into a caveat/troubleshooting tip since repos may have different defaults

@npentrel
Copy link
Copy Markdown
Contributor

npentrel commented Apr 4, 2025

It may be because we're not in an org for our private modules but what confuses me is that mine is set to Read repository contents and packages permissions (Workflows have read permissions in the repository for the contents and packages scopes only.) which appears to be enough. So maybe we should direct them to use that option instead? The actions should not need write permissions as far as I can understand.

(And I think a step is fine, probably most people in an org will then need to take this option that makes sense. And we do want to reduce expanders I think)

@JessamyT
Copy link
Copy Markdown
Contributor Author

JessamyT commented Apr 4, 2025

(And I think a step is fine, probably most people in an org will then need to take this option that makes sense. And we do want to reduce expanders I think)

For this and the wifi PR, you've mentioned reducing expanders but this is an alert. Do you mean that we want to reduce both expanders and alerts?

@npentrel
Copy link
Copy Markdown
Contributor

npentrel commented Apr 7, 2025

(And I think a step is fine, probably most people in an org will then need to take this option that makes sense. And we do want to reduce expanders I think)

For this and the wifi PR, you've mentioned reducing expanders but this is an alert. Do you mean that we want to reduce both expanders and alerts?

Yes. Everything that adds a box should really only be there if necessary.

I think we still need to clarify under which condition this would require write permissions (as I said, it works without for https://github.com/npentrel/control-logic-example-module so I am not even sure if that is true)

Copy link
Copy Markdown
Contributor

@npentrel npentrel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see above comments

@JessamyT
Copy link
Copy Markdown
Contributor Author

JessamyT commented Apr 8, 2025

I tried replicating on one of my private modules and can't...I'll close and will reinvestigate if it comes up again.

@JessamyT JessamyT closed this Apr 8, 2025
@JessamyT JessamyT deleted the 3816permissions branch April 8, 2025 23:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

safe to build This pull request is marked safe to build from a trusted zone

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants