Modified docs to reflect the correct password syntax for the gon-sign.json file
#3620
Conversation
|
Warning Rate limit exceeded@leaanthony has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 9 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughThe changes involve updating dependencies in a Go project to newer versions and modifying documentation related to the signing process. The Go modules Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (1)
website/versioned_docs/version-v2.9.0/guides/signing.mdx (1)
276-277: The deprecation notice for Apple's altool syntax supporting@env:is present but lacks additional context or guidance for users.
- Consider providing more information on what users should do as an alternative or where they can find more details about the new notarytool.
Analysis chain
Verify clarity and completeness of deprecation notice.
Ensure that the deprecation notice for Apple's altool syntax supporting
@env:is clear and provides necessary context.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the clarity and completeness of deprecation notice. # Test: Search for the deprecation notice. Expect: Clear and complete notice. rg --type mdx 'deprecated Apple\'s altool'Length of output: 93
Script:
#!/bin/bash # Description: Verify the clarity and completeness of deprecation notice. # Test: Search for the deprecation notice. Expect: Clear and complete notice. rg --type mdx "deprecated Apple's altool"Length of output: 74
Script:
#!/bin/bash # Description: Verify the clarity and completeness of deprecation notice. # Test: Search for the deprecation notice in `.mdx` files. Expect: Clear and complete notice. rg 'deprecated Apple'\''s altool' --glob '*.mdx'Length of output: 340
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
v2/examples/customlayout/go.sumis excluded by!**/*.sum
Files selected for processing (2)
- v2/examples/customlayout/go.mod (1 hunks)
- website/versioned_docs/version-v2.9.0/guides/signing.mdx (2 hunks)
Additional comments not posted (6)
v2/examples/customlayout/go.mod (4)
36-36: No changes togolang.org/x/text.The dependency remains at version
v0.15.0.
32-32: Verify compatibility ofgolang.org/x/cryptov0.23.0.Ensure that the new version does not introduce breaking changes and is compatible with the rest of the project.
35-35: Verify compatibility ofgolang.org/x/sysv0.20.0.Ensure that the new version does not introduce breaking changes and is compatible with the rest of the project.
34-34: Verify compatibility ofgolang.org/x/netv0.25.0.Ensure that the new version does not introduce breaking changes and is compatible with the rest of the project.
website/versioned_docs/version-v2.9.0/guides/signing.mdx (2)
Line range hint
1-277:
Verify overall consistency and clarity of documentation.Ensure that the overall documentation is consistent and provides clear instructions regarding the migration to notarytool and new signing requirements.
Tools
LanguageTool
[uncategorized] ~268-~268: Loose punctuation mark.
Context: ...ak down of the above fields: -source: The location of your wails binary to be...(UNLIKELY_OPENING_PUNCTUATION)
257-257: Verify clarity and accuracy of app-specific password instructions.Ensure that the new instructions for entering the app-specific password directly are clear and accurate.
Verification successful
Verify clarity and accuracy of app-specific password instructions.
The instructions for entering the app-specific password directly in
website/versioned_docs/version-v2.9.0/guides/signing.mdxare clear and accurate. The change from using Gon's environment variable syntax to directly entering the password is correctly reflected.
website/versioned_docs/version-v2.9.0/guides/signing.mdx: The instructions are clear and do not reference the environment variable syntax.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the clarity and accuracy of app-specific password instructions. # Test: Search for the usage of app-specific password instructions. Expect: Clear and accurate instructions. rg --type mdx 'app-specific password'Length of output: 67
Script:
#!/bin/bash # Description: Verify the clarity and accuracy of app-specific password instructions. # Test: Search for the usage of app-specific password instructions. Expect: Clear and accurate instructions. rg 'app-specific password' --glob '*.mdx'Length of output: 1948
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- website/versioned_docs/version-v2.9.0/guides/signing.mdx (2 hunks)
Files skipped from review as they are similar to previous changes (1)
- website/versioned_docs/version-v2.9.0/guides/signing.mdx
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- website/versioned_docs/version-v2.9.0/guides/signing.mdx (2 hunks)
Files skipped from review as they are similar to previous changes (1)
- website/versioned_docs/version-v2.9.0/guides/signing.mdx
|
Thanks 🙏 The changes are to versioned documents which will get wiped at some point. Would it be possible to add them to the non versioned docs? Thank you 🙏 Please could you add an entry to the changelog located at |
|
Sure thing! Will get this sorted this week |
|
@ignasbernotas - any news? |
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (3)
website/docs/guides/signing.mdx (3)
257-257: Clarify Password InstructionsThe instruction to use "your-app-specific-password" is clear. Ensure that users are aware of how to generate this password.
Consider adding a brief note or link on how to generate an app-specific password.
271-271: Clarify Password InstructionsThe instruction to use "your app-specific password" is clear. Ensure that users are aware of how to generate this password.
Consider adding a brief note or link on how to generate an app-specific password.
276-277: Update Notarytool InformationThe note about the deprecated
altoolsyntax is informative. Ensure that users understand the implications of this change.Consider providing a link to Apple's documentation on the new notarytool for further reading.
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
v2/examples/customlayout/go.sumis excluded by!**/*.sum
Files selected for processing (3)
- v2/examples/customlayout/go.mod (1 hunks)
- website/docs/guides/signing.mdx (2 hunks)
- website/src/pages/changelog.mdxx (1 hunks)
Additional comments not posted (5)
v2/examples/customlayout/go.mod (4)
32-32: Dependency Update:golang.org/x/cryptoThe update from version
0.17.0to0.23.0is noted. Ensure that any breaking changes or deprecations in the newer version are addressed in the codebase.
34-34: Dependency Update:golang.org/x/netThe update from version
0.17.0to0.25.0is noted. Verify compatibility with the rest of the codebase.
35-35: Dependency Update:golang.org/x/sysThe update from version
0.15.0to0.20.0is noted. Ensure that the codebase is compatible with the new version.
36-36: Dependency Update:golang.org/x/textThe update from version
0.14.0to0.15.0is noted. Check for any changes that might affect the code.website/src/pages/changelog.mdxx (1)
29-29: Changelog entry update looks good.The documentation update to reflect the correct password syntax for the
gon-sign.jsonfile is clear and informative.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- website/docs/guides/signing.mdx (2 hunks)
- website/src/pages/changelog.mdxx (1 hunks)
Files skipped from review due to trivial changes (1)
- website/docs/guides/signing.mdx
Files skipped from review as they are similar to previous changes (1)
- website/src/pages/changelog.mdxx
iberflow
changed the title
gon-sign.json file
|
@leaanthony sorry for the delay, should be good now. thanks! |
|
…n.json` file (wailsapp#3620) * fix: docs macOS signing password syntax * fix: docs macOS signing password syntax --------- Co-authored-by: Lea Anthony <[email protected]>
Description
Updates current docs to specify that
@env:*syntax is no longer supported since Apple has switched to notarytool for signing.Type of change
Summary by CodeRabbit
New Features
Bug Fixes
Documentation