Skip to content

Commit 6ed661c

Browse files
Merge pull request #7761 from segmentio/fix-7724
Update partner local build instructions with info from action-destinations repo
2 parents 2fd74f4 + 68e7077 commit 6ed661c

File tree

1 file changed

+20
-8
lines changed

1 file changed

+20
-8
lines changed

src/partners/destinations/build.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Before you begin, consider the following prerequisites.
1111

1212
### Security
1313

14-
The security of customers and partners is a top priority at Segment. Before you begin building, review the [Acceptable Use Policy](https://segment.com/legal/acceptable-use-policy/), and keep in mind:
14+
The security of customers and partners is a top priority at Segment. Before you begin building, review the [Acceptable Use Policy](https://segment.com/legal/acceptable-use-policy/){:target="_blank}, and keep in mind:
1515

1616
- Follow a secure software-development lifecycle, which enables you to both create code that is safe for Segment customers and their end users, and maintain and raise the security of that code over time.
1717
- If you or your code comes into contact with Segment customer or end-user data for any reason, protect it with commercially reasonable methods throughout the data lifecycle, including creating, handling, transporting, and destruction.
@@ -23,9 +23,11 @@ The security of customers and partners is a top priority at Segment. Before you
2323
You don't need to access a Segment dev environment to build an integration. You’ll test it locally on your machine. Destinations are written in TypeScript. For more information about TypeScript, see TypeScript's [documentation](https://www.typescriptlang.org/docs/){:target="_blank}.
2424

2525
To work with Segment's actions repository, download and install the following:
26-
- [node](https://nodejs.org/en/){:target="_blank"}
26+
- [node](https://nodejs.org/en/){:target="_blank"} (_version 18.7+. Segment recommends managing Node versions with `nvm`._)
2727
- [nvm](https://github.com/nvm-sh/nvm){:target="_blank"}
28-
- [yarn](https://yarnpkg.com/){:target="_blank"}
28+
- [yarn](https://yarnpkg.com/){:target="_blank"} (_version 1.x_)
29+
30+
If you encounter errors when setting up your development environment, ensure you're running the correct version of Node by running `nvm use`.
2931

3032
### Fork the repository
3133

@@ -37,16 +39,26 @@ Fork the `segmentio/action-destinations` repository, connect to NPM and Yarn, an
3739
Run the test suite to ensure the environment is properly configured.
3840

3941
```sh
40-
git clone https://github.com/<your_gh_org>/action-destinations.git
42+
# Clone the repo locally
43+
git clone <your fork or https://github.com/segmentio/action-destinations.git>
4144
cd action-destinations
45+
4246
npm login
4347
yarn login
44-
# Requires node 14.17, optionally: nvm use 14.17
45-
yarn --ignore-engines --ignore-optional
46-
yarn bootstrap
47-
yarn build
48+
49+
# Requires node 18.17.1, optionally: nvm use 18.17.1
50+
yarn --ignore-optional
4851
yarn install
52+
yarn build
53+
54+
# Run unit tests to ensure things are working! For partners who don't have access to internal packages, you can run:
55+
yarn test-partners
56+
57+
# For segment employees, you can run:
4958
yarn test
59+
60+
# to reset all caches and rebuild again
61+
yarn clean-build
5062
```
5163

5264
## Create a destination

0 commit comments

Comments
 (0)