docs icon indicating copy to clipboard operation
docs copied to clipboard

Remove need for `KEYCHAIN_PASSWORD` secret in deploying-xcode-applications

Open cweider opened this issue 1 year ago • 3 comments
trafficstars

Why:

Generating the ephemeral keychain's password in the script removes the need for the user to generate and store one manually.

What's being changed (if available, include any code snippets, screenshots, or gifs):

Step describing KEYCHAIN_PASSWORD secret is removed. Script modified to generate random bytes to use as the keychain's password automatically (openssl rand – but it could be $RANDOM).

Check off the following:

  • [x] I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • [x] For content changes, I have completed the self-review checklist.

cweider avatar Feb 21 '24 19:02 cweider

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar Feb 21 '24 19:02 welcome[bot]

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
actions/deployment/deploying-xcode-applications/installing-an-apple-certificate-on-macos-runners-for-xcode-development.md fpt
ghec
ghes@ 3.12 3.11 3.10 3.9 3.8
fpt
ghec
ghes@ 3.12 3.11 3.10 3.9 3.8

fpt: Free, Pro, Team ghec: GitHub Enterprise Cloud ghes: GitHub Enterprise Server

github-actions[bot] avatar Feb 21 '24 20:02 github-actions[bot]

@cweider Thanks so much for opening a PR! I'll get this triaged for review ✨

nguyenalex836 avatar Feb 22 '24 16:02 nguyenalex836

Hey @cweider, thanks so much for opening this PR to update the docs! ✨

The reason we recommend users create a secret and pass the secret to the workflow is because it is more secure than generating the password via the command line. You can see this documented in Using secrets in a workflow with a little more information on why we make that recommendation.

While your solution is simpler to implement 👍, it is less secure. For that reason, I am going to close out this PR. Thanks again for your interest in improving GitHub's docs!

SiaraMist avatar Mar 11 '24 23:03 SiaraMist