You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-10Lines changed: 7 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ Which of your projects are affected by that vulnerable package release? Is it wo
6
6
How many package updates do you have to do before you can update your server to the latest PHP version? Baton helps you
7
7
answer these questions.
8
8
9
-
Once installed, you can import any list of GitHubor Kilnrepositories to search for package usages in. You can also
9
+
Once installed, you can import any list of GitHub repositories to search for package usages in. You can also
10
10
set up a webhook to automatically import new projects whenever they get added to your organisation.
11
11
12
12
##Demo
@@ -62,12 +62,10 @@ Baton has Unit-Tests! Execute `bin/phpunit` to run them.
62
62
63
63
##Configuration
64
64
65
-
In order to import private repositories from GitHub you need to provide an[OAuth token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/).
65
+
In order to import private repositories from GitHub you need to provide an[API access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/).
66
66
67
67
Set it as the value of the environment variable`GITHUB_OAUTH_TOKEN` on your server and you're good to go.
68
68
69
-
The same goes for Kiln repositories. Store your Kiln OAuth token in the`KILN_OAUTH_TOKEN` environment variable on your server.
70
-
71
69
###Overriding Symfony configuration
72
70
73
71
You can add your custom Symfony configuration by providing any of
@@ -85,7 +83,7 @@ This allows adding custom configuriation (like custom loggin configuration) with
85
83
86
84
###Import Projects
87
85
88
-
Use the webhook route`/webhook` to import/update repositories onpush events (tested withGitHuband Kiln).
86
+
Use the webhook route`/webhook` to import/update repositories on GitHubpush events.
89
87
90
88
You can also import projects by repository URL through the Symfony Command`app:import-project` or the form at`/import-repositories`.
91
89
@@ -104,7 +102,7 @@ Show Composer Package with list of using projects grouped by version.
104
102
105
103
##Roadmap
106
104
107
-
Right now private repositories are only supported for projects hosted on GitHub or Kiln using OAuth tokens for authentication.
105
+
Right now private repositories are only supported for projects hosted on GitHub, accessible through a GitHub personal access token.
108
106
A more general approach would be to use ssh URLs for importing repositories and pass an authorized ssh identity to the VCS.
109
107
110
108
##Contributing
@@ -123,9 +121,8 @@ This is the final commit from the initial implementation in the given timeframe:
123
121
124
122
##Credits, Copyright and License
125
123
126
-
This project was started atthewebfactory GmbH, Bonn.
124
+
This project was started at webfactory GmbH, Bonn.
127
125
128
-
-<http://www.webfactory.de>
129
-
-<http://twitter.com/webfactory>
126
+
-<https://www.webfactory.de>
130
127
131
-
Copyright 2018 webfactory GmbH, Bonn. Code released under[the MIT license](LICENSE).
128
+
Copyright 2018-2025 webfactory GmbH, Bonn. Code released under[the MIT license](LICENSE).