Skip to content

Commit 12547a1

Browse files
author
Greg Bowler
committed
Add readme
1 parent 6d21f71 commit 12547a1

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

Diff for: README.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
An example project that uses [php-actions/composer][composer-link]
2+
===
3+
4+
This is a trivial project that holds only simple example functionality: a repository that installs its dependencies (a WebEngine application) plus a private repository. The private repository is hosted on Github at https://github.com/php-actions/example-private-repo (the link will return 404 due to it being private).
5+
6+
An SSH key has been generated specifically for this project. It is a typical public/private pair of RSA keys. The example-private-repo repository has the key added as a read-only deploy key, so anyone with access to the key can clone the repo (but not push). The key pair is stored in this repository as a [Github Secret][secret].
7+
8+
Check out the [Actions tab in the Github repository][actions-tab] to see the past actions workflows and their outputs. You will see that both the [public repo for `phpgt/webengine`][webengine-link] and the [private repo for `php-actions/example-private-repo`][example-private-repo-link] are downloaded successfully.
9+
10+
The file at .github/workflows/ci.yml shows how to use [php-actions/composer][composer-link].
11+
12+
***
13+
14+
If you found this repository helpful, please consider [sponsoring the developer][sponsor].
15+
16+
[secret]: https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets
17+
[composer-link]: https://github.com/php-actions/composer
18+
[actions-tab]: https://github.com/php-actions/example-phpunit/actions
19+
[sponsor]: https://github.com/sponsors/g105b
20+
[webengine-link]: https://github.com/phpgt/webengine
21+
[example-private-repo-link]: https://github/com/php-actions/example-private-repo

0 commit comments

Comments
 (0)