Skip to content

Commit 1de13d8

Browse files
committed
Update docs for Pipeline module
- Resolves #1
1 parent 2d2c9c8 commit 1de13d8

1 file changed

Lines changed: 50 additions & 29 deletions

File tree

docs/pages/modules/pipeline/index.md

Lines changed: 50 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -30,35 +30,6 @@ The goal is to seamlessly upgrade from the previous [Bitbucket Pipeline v2](http
3030
- [x] Create change log from Git commit messages
3131
- [x] Deploy metadata to an event API
3232

33-
## Bitbucket Pipeline
34-
35-
Create a file named `bitbucket-pipelines.yml`.
36-
37-
```yaml
38-
# See https://github.com/tangibleinc/pipeline
39-
image: php:8.1-fpm
40-
pipelines:
41-
# On every commit
42-
default:
43-
- step:
44-
script:
45-
- curl -sL "https://${BB_AUTH_STRING}@api.bitbucket.org/2.0/repositories/tangibleinc/tangible-pipeline-v3/downloads/run" | bash
46-
# On every version tag
47-
tags:
48-
"*":
49-
- step:
50-
script:
51-
- curl -sL "https://${BB_AUTH_STRING}@api.bitbucket.org/2.0/repositories/tangibleinc/tangible-pipeline-v3/downloads/run" | bash
52-
```
53-
54-
For existing projects, change `v2` to `v3` in the URL of the Bitbucket pipeline script.
55-
56-
Alternatively use the GitHub URL.
57-
58-
```
59-
https://raw.githubusercontent.com/tangibleinc/pipeline/main/run
60-
```
61-
6233
## GitHub Actions
6334

6435
Status: Work in progress
@@ -129,3 +100,53 @@ Use [GitHub Action `ssh-agent`](https://github.com/webfactory/ssh-agent) to pass
129100
with:
130101
ssh-private-key: ${{ secrets.TANGIBLE_PIPELINE_SSH_KEY }}
131102
```
103+
104+
- Reference: [`lifter-elements/.github/workflows/release.yml`](https://github.com/TangibleInc/lifter-elements/blob/de3cb98563178e4fa4b8cca94f601c433da42157/.github/workflows/release.yml)
105+
106+
### Composer dependencies
107+
108+
To install external Composer dependencies, add the following step after "Install dependencies".
109+
110+
```sh
111+
# Install external deps, generate autoload and lock file
112+
# Configure workspace as safe for Git to solve: https://github.com/composer/composer/issues/12221
113+
- name: Install PHP dependencies (Composer)
114+
uses: php-actions/composer@v6
115+
with:
116+
php_version: '8.2'
117+
run: |
118+
git config --global --add safe.directory /app
119+
composer install --no-dev --prefer-dist --no-interaction --no-progress --optimize-autoloader
120+
```
121+
122+
- Reference: https://github.com/TangibleInc/roller/issues/12
123+
124+
125+
## Bitbucket Pipeline
126+
127+
Create a file named `bitbucket-pipelines.yml`.
128+
129+
```yaml
130+
# See https://github.com/tangibleinc/pipeline
131+
image: php:8.1-fpm
132+
pipelines:
133+
# On every commit
134+
default:
135+
- step:
136+
script:
137+
- curl -sL "https://${BB_AUTH_STRING}@api.bitbucket.org/2.0/repositories/tangibleinc/tangible-pipeline-v3/downloads/run" | bash
138+
# On every version tag
139+
tags:
140+
"*":
141+
- step:
142+
script:
143+
- curl -sL "https://${BB_AUTH_STRING}@api.bitbucket.org/2.0/repositories/tangibleinc/tangible-pipeline-v3/downloads/run" | bash
144+
```
145+
146+
For existing projects, change `v2` to `v3` in the URL of the Bitbucket pipeline script.
147+
148+
Alternatively use the GitHub URL.
149+
150+
```
151+
https://raw.githubusercontent.com/tangibleinc/pipeline/main/run
152+
```

0 commit comments

Comments
 (0)