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

Simplify the key setup instructions #21

Merged
merged 2 commits into from
May 26, 2022

Conversation

rikhuijzer
Copy link
Member

Manually adding a separate DOCUMENTER_KEY shouldn't be necessary. See JuliaDocs/Documenter.jl#1819 for more info.

@rikhuijzer rikhuijzer requested a review from a team as a code owner May 22, 2022 10:38
README.md Outdated
@@ -11,6 +11,7 @@ on:

jobs:
Documenter:
permissions: write-all
Copy link
Member

Choose a reason for hiding this comment

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

This is not a good practice. Instead, only the minimal permissions that are needed to make the workflow work should be given to the token.

Copy link
Member Author

Choose a reason for hiding this comment

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

Well spotted 👍 Based on https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions?ref=#permissions, the permissions are now set to

permissions:
    contents: write

I've tested this in a repository of mine (https://github.com/rikhuijzer/DiscountedCashFlows.jl/commits/main).

@SaschaMann SaschaMann merged commit 80c0bdc into julia-actions:master May 26, 2022
@SaschaMann
Copy link
Member

Thanks!

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