diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000000000000000000000000000000000..ff740503920ea8d9c3219bbb26a0e4e48c21bbf7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,5 @@ +## Contributing + +This project uses the [forking workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow). +Please fork this project and submit pull requests to the [primary repository](https://git.doit.wisc.edu/adi-ia/rpc-netid-php). +It is expected that unit tests are created for new and updated functionality. Pull requests should be descriptive. \ No newline at end of file diff --git a/README.md b/README.md index 1b8b875dcada14b614ab84588da7a1fdff4a4e48..0ec9fd81cfdc3d420abd80c18ea24893ee6a8c75 100644 --- a/README.md +++ b/README.md @@ -11,16 +11,16 @@ The recommended way to obtain this client is with [Composer](http://www.getcompo "repositories": [ { "type": "vcs", - "url": "git@bitbucket.uwmadison_doit/rpc-netid-php" + "url": "git@git.doit.wisc.edu:adi-ia/rpc-netid-php.git" } ], "require": { - "uwmadison_doit/rpc-netid-php": "1.*" + "adi-ia/rpc-netid-php": "1.*" } } ``` -Your public SSH key will need to be linked to your Bitbucket account. You can alternatively use HTTP and specify your Bitbucket username and password. [The composer.json Schema - Repositories](https://getcomposer.org/doc/04-schema.md#repositories) +Your public SSH key will need to be linked to your git.doit.wisc.edu account. Learn more in the composer documentation about [the composer.json Schema - Repositories](https://getcomposer.org/doc/04-schema.md#repositories) ### Git @@ -88,15 +88,6 @@ You will need to run `phpdoc` at the root of the project in order to generate th [Installing phpdoc](http://phpdoc.org/docs/latest/getting-started/installing.html) - -## Contributing - -The rest of this README is for those wishing to contribute to the project. - -This project uses the [forking workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow). -Please fork this project and submit pull requests to the [blessed repository](https://bitbucket.org/uwmadison_doit/rpc-netid-php). -It is expected that unit tests are created for new and updated functionality. Pull requests should be descriptive. - ## Development Requirements 1. [phing](http://www.phing.info/) @@ -154,14 +145,3 @@ php phing.phar integration-test A valid client certificate is required to authenticate with Middleware's web service. Test data must be supplied in `src/test/resources/integration-test-data.ini`. See the class summary in `src/test/integration-tests/RpcNetidClientSoapIT.php` and the comments in `src/test/resources/integration-test-data.SAMPLE.ini`. -## Release Management - -To release a branch as a new version of the software: - -```bash -php phing.phar release -Dversion=1.2.3 -Dbranch=myBranch -``` - -The `branch` property is optional and will default to `master` if not set. - -See `README-release.md` for detailed information. diff --git a/README-release.md b/RELEASE.md similarity index 54% rename from README-release.md rename to RELEASE.md index 3748e6f6c4bcf25181cffa66d5e0ced53057d680..de173b199e7c11b5c2558b8cede6f0567607db42 100644 --- a/README-release.md +++ b/RELEASE.md @@ -1,17 +1,9 @@ # Release Process # -1. User has cloned the [blessed repository](https://bitbucket.org/uwmadison_doit/rpc-netid-php/) and has write access to it. -2. User runs the following command: `php phing.phar release -Dversion=1.2.3 -Dbranch=myBranch` +1. User has cloned the [primary repository](https://git.doit.wisc.edu/adi-ia/rpc-netid-php/) and has write access to it. +2. User runs the following command: `php phing.phar release -Dversion=1.2.3 [-Dbranch=some-alternate-branch]` The branch argument is optional and defaults to `master`. 3. The designated branch is checked out. 4. A tag is created with the name equal to the version number with no extra characters 5. The repository is pushed to origin with all tags. The end result is a new tag in the remote repository equal to the version number. Composer clients will now pick up on the new version number. - -For instance, if version 1.1.0 was released, a composer client with the following dependency would pick up on the new change: - -```json -"require": { - "uwmadison_doit/rpc-netid-php": "1.*" -} -``` \ No newline at end of file diff --git a/composer.json b/composer.json index a1b6ecf69d560c852388f888457a1789727f9fb5..640e12c6d0d51820adb082ef1a8cd1d02dd2699f 100644 --- a/composer.json +++ b/composer.json @@ -1,8 +1,8 @@ { - "name" : "uwmadison_doit/rpc-netid-php", + "name" : "adi-ia/rpc-netid-php", "description" : "PHP client for the NetID RPC web service provided by DoIT Middleware", "type" : "library", - "homepage" : "https://bitbucket.org/uwmadison_doit/rpc-netid-php/", + "homepage" : "https://git.doit.wisc.edu/adi-ia/rpc-netid-php", "license" : "Apache-2.0", "authors" : [{ "name" : "UW-Madison DoIT ADI Internal Applications", @@ -12,7 +12,7 @@ ], "support" : { "email" : "adi-ia@lists.wisc.edu", - "source" : "https://bitbucket.org/uwmadison_doit/rpc-netid-php/" + "source" : "https://git.doit.wisc.edu/adi-ia/rpc-netid-php" }, "require-dev" : { },