Skip to content

Commit a186979

Browse files
committed
Bump shared and note security issue email
1 parent d80c1da commit a186979

2 files changed

Lines changed: 19 additions & 17 deletions

File tree

README.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,26 @@
11
# trunk.cocoapods.org
22

3-
43
[![Build Status](https://img.shields.io/travis/CocoaPods/trunk.cocoapods.org/master.svg?style=flat)](https://travis-ci.org/CocoaPods/trunk.cocoapods.org)
54

6-
75
Available under the MIT license.
86

97
## Installation
108

11-
1. Create a testing sandbox repository on GitHub and, from the CocoaPods specification repository,
12-
add the [`Gemfile`](https://raw.github.com/CocoaPods/Specs/master/Gemfile) and
13-
[`Rakefile`](https://raw.github.com/CocoaPods/Specs/master/Rakefile) files.
9+
1. Create a testing sandbox repository on GitHub and, from the CocoaPods specification repository,
10+
add the [`Gemfile`](https://raw.github.com/CocoaPods/Specs/master/Gemfile) and
11+
[`Rakefile`](https://raw.github.com/CocoaPods/Specs/master/Rakefile) files.
1412

15-
2. Install PostgreSQL. (On OS X you can use the [Postgres App](http://postgresapp.com).)
13+
2. Install PostgreSQL. (On OS X you can use the [Postgres App](http://postgresapp.com).)
1614

17-
3. Install the dependencies:
15+
3. Install the dependencies:
1816

1917
$ rake bootstrap
2018

21-
4. Run the travis before script to set up your db
19+
4. Run the travis before script to set up your db
2220

2321
$ ./.travis/before.sh
2422

25-
5. Test whether or not a pod sends correctly
23+
5. Test whether or not a pod sends correctly
2624

2725
$ ./bin/test-push localhost:4567 spec/fixtures/AFNetworking.podspec
2826

@@ -40,23 +38,23 @@ this example the password is ‘secret’):
4038

4139
Optional environment variables are:
4240

43-
* `RACK_ENV`: Can be test, development, or production.
44-
* `DATABASE_URL`: The URL to the PostgreSQL database.
41+
- `RACK_ENV`: Can be test, development, or production.
42+
- `DATABASE_URL`: The URL to the PostgreSQL database.
4543

4644
## Webhook
4745

4846
The webhook sends messages to other services when events in trunk happen.
4947

5048
These events trigger the webhook and send a message.
5149

52-
* Successful create of a pod: `{'type':'pod','action':'create','timestamp':'<date>','data_url':'<URL>'}`
53-
* Successful create of a version: `{'type':'version','action':'create','timestamp':'<date>','data_url':'<URL>'}`
54-
* Successful update of a spec: `{'type':'spec','action':'update','timestamp':'<date>','data_url':'<URL>'}`
50+
- Successful create of a pod: `{'type':'pod','action':'create','timestamp':'<date>','data_url':'<URL>'}`
51+
- Successful create of a version: `{'type':'version','action':'create','timestamp':'<date>','data_url':'<URL>'}`
52+
- Successful update of a spec: `{'type':'spec','action':'update','timestamp':'<date>','data_url':'<URL>'}`
5553

5654
Environment variables are:
5755

58-
* `OUTGOING_HOOK_PATH`: The garbled path used at the end of `<schema>://<domain>/hooks/trunk/<OUTGOING_HOOK_PATH>`.
59-
* `WEBHOOKS_ENABLED`: If set to `true`, the webhook is enabled.
56+
- `OUTGOING_HOOK_PATH`: The garbled path used at the end of `<schema>://<domain>/hooks/trunk/<OUTGOING_HOOK_PATH>`.
57+
- `WEBHOOKS_ENABLED`: If set to `true`, the webhook is enabled.
6058

6159
### Usage in Trunk
6260

@@ -93,3 +91,7 @@ Note: The webhooks are currently only available to CP internal services. We are
9391
3. Install a POST route in your service that corresponds to the URL. Note: You MUST NOT use the value in `OUTGOING_HOOK_PATH` inside your public code. Instead, use an ENV variable as well, and set it to correspond to `OUTGOING_HOOK_PATH`.
9492

9593
You'll then receive POSTs to the URL with content `message=<JSON data>`.
94+
95+
### Security Issues
96+
97+
Email: `info` `@` `cocoapods.org`

0 commit comments

Comments
 (0)