Skip to content

Commit

Permalink
fix: Remove contributing docs referencing beta branch
Browse files Browse the repository at this point in the history
  • Loading branch information
AshCorr committed Oct 18, 2024
1 parent b61bbc6 commit 42b0b24
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 24 deletions.
1 change: 0 additions & 1 deletion .github/workflows/cd.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ on:
push:
branches:
- main
- beta
workflow_dispatch:

jobs:
Expand Down
24 changes: 1 addition & 23 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ In the near-future we are likely to adopt a stricter approach in this area.
## Testing larger changes

Depending on the nature of your change, you may want to test things on a 'real'
stack, or even publish a beta version of the library to NPM.
stack.

This section describes a few ad-hoc testing methods, posed as questions.

Expand Down Expand Up @@ -100,28 +100,6 @@ stack to test your changes against a real AWS stack.

This stack isn't user facing. Accidentally causing destruction there is ok - better there than on theguardian.com!

### Would your change update the layout of the NPM package?

It can sometimes be necessary to update the layout of the NPM package.

These changes can be quite difficult to simulate locally using `npm link` or similar.

For this reason, it can be helpful to publish a beta version to NPM. To do so:

1. Update the `beta` branch
1. Wait for the robots (GitHub Actions) to run and release a beta version

You can now install and test your changes with:

```
npm install @guardian/cdk@beta
```

Once you're happy with your changes, raise a PR into `main` as normal.

NOTE: The `beta` branch is just like any other branch - it may not be up to date with `main`.
It's wise to rebase it with `main` before working on it.

## Releasing

We use [changesets](https://github.com/changesets/changesets) to automate NPM releases.
Expand Down

0 comments on commit 42b0b24

Please sign in to comment.