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
+50-19Lines changed: 50 additions & 19 deletions
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ The command line utility will use an existing `git` repository to compare to cha
17
17
18
18
As this is still an alpha package, it is not suggested to include `php-semver-checker-git` directly in your composer.json. There are however a couple ways to use the tool:
19
19
20
-
1.**Preferred method** Download the [latest .phar build](http://psvcg.coreteks.org/php-semver-checker-git.phar). Note that the .phar build is generally less bleeding edge than the following methods.
20
+
1.**Preferred method** Download the [latest .phar build](https://psvcg.coreteks.org/php-semver-checker-git.phar). Note that the .phar build is generally less bleeding edge than the following methods.
21
21
2.`php composer.phar create-project tomzx/php-semver-checker-git --stability=dev` will clone to a new php-semver-checker-git folder in your current working directory
22
22
3.`git clone https://github.com/tomzx/php-semver-checker-git.git` and `php composer.phar install` in the newly cloned directory.
23
23
@@ -26,22 +26,43 @@ See the example section for examples of how to use the tool.
26
26
### Building `php-semver-checker-git.phar`
27
27
First, make sure you have [box](https://github.com/box-project/box2) installed. Then, in the base directory, you can run the following command which will generate the `php-semver-checker-git.phar` file.
28
28
29
-
```
29
+
```bash
30
30
box build
31
31
```
32
32
33
-
### Using `php-semver-checker-git` with `travis-ci`
33
+
### Using `php-semver-checker-git` with `GitHub actions`
34
34
35
-
It is very easy to add `php-semver-checker-git` to your build process and to get a nice report you can check in the `travis-ci` logs.
35
+
It is very easy to add `php-semver-checker-git` to your build process and to get a nice report you can check in the `GitHub actions` logs.
36
+
In a file under `.github/workflows/`, add the following:
In order to simplify the above call to `php-semver-checker-git`, we suggest you create a `php-semver-checker-git.yml` configuration file at the root of your project. In it, you can put the following:
@@ -53,16 +74,26 @@ include-before: src
53
74
include-after: src
54
75
```
55
76
56
-
With this configuration file, you can then use the following in your `.travis.yml` file.
77
+
With this configuration file, you can update the configuration file created previously:
Note: `--allow-detached` is very useful when you are running this command on [`travis-ci`](https://travis-ci.org) or any other continuous integration provider. It is necessary when a checkout is done on a particular commit, which makes `HEAD` become `detached`. If this option is not passed to the command, it will abort. This is done because it is impossible to revert the original `detached` branch when the `suggest` command completes.
114
+
Note: `--allow-detached`is very useful when you are running this command on [`GitHub actions`](https://github.com/features/actions) or any other continuous integration provider. It is necessary when a checkout is done on a particular commit, which makes `HEAD` become `detached`. If this option is not passed to the command, it will abort. This is done because it is impossible to revert the original `detached` branch when the `suggest` command completes.
84
115
85
116
### Compare HEAD against a specific tag constraint
0 commit comments