[Security Issue] Update README.md to recommend removing auth.json after use by TheLastCicada · Pull Request #64 · php-actions/composer · GitHub
Skip to content

[Security Issue] Update README.md to recommend removing auth.json after use#64

Merged
g105b merged 1 commit into
php-actions:masterfrom
TheLastCicada:master
Sep 25, 2021
Merged

[Security Issue] Update README.md to recommend removing auth.json after use#64
g105b merged 1 commit into
php-actions:masterfrom
TheLastCicada:master

Conversation

@TheLastCicada

Copy link
Copy Markdown
Contributor

The auth.json file is created with a Github username and password to be used to authenticate requests from Composer back to Github. The username and password is recommended to use a personal access token to access private repos. The auth.json file is created at the root of the repo and if your Github Actions job eventually deploys the contents of this repo to a web accessible server, it will deploy the auth.json file too based on how the example is written. This update adds a step to remove the auth.json file from the repo after it is used by Composer, preventing sensitive credentials from being deployed in plain text to a potentially public location.

The auth.json file is created with a Github username and password to be used to authenticate requests from Composer back to Github.  The username and password is recommended to use a personal access token to access private repos.  The auth.json file is created at the root of the repo and if your Github Actions job eventually deploys the contents of this repo to a web accessible server, it will deploy the auth.json file too based on how the example is written.  This update adds a step to remove the auth.json file from the repo after it is used by Composer, preventing sensitive credentials from being deployed in plain text to a potentially public location.
@g105b g105b merged commit 0a2fe11 into php-actions:master Sep 25, 2021
@g105b

g105b commented Sep 25, 2021

Copy link
Copy Markdown
Member

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants