Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds link to help.newspack.com for instructions on setup and use. #13

Merged
merged 1 commit into from
Mar 7, 2025
Merged

Adds link to help.newspack.com for instructions on setup and use. #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 1 addition & 55 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,58 +15,4 @@ It will give you all of the tools you needs to get up and running quickly.

## How do I use it?

### Creating a new repository from this template

Click the `Use this template` button to create a new repository in your own GitHub account from this template.

### Setting up the repository secrets

Go to the Secrets and Variables->Actions sections under the Settings menu of the new repository.
Under the Repository secrets sections, create new the secrets outlined in the table below.

### Secrets

| Secret | Description |
| --------------------- | ------------------------------------------- |
| PROD_SFTP_USER | The username for the Production SFTP server |
| PROD_SFTP_PASSWORD | The password for the Production SFTP server |
| STAGING_SFTP_USER | The username for the Staging SFTP server |
| STAGING_SFTP_PASSWORD | The password for the Staging SFTP server |

### Adding some branch protection rules

1. Navigate to Settings > Branches.
2. Click on **Add classic branch protection rule**
3. Enter `trunk` into the Branch name pattern field.
4. Check **Require a pull request before merging**.
5. Check **Require approvals**. You can leave the number of required approval set at 1.
6. Click on **Create**.
7. Check Require status checks to pass before merging
8. In the search box, searching for “Linting” and add each status check that appears. There should be 3 in total.

## Adding collaborators

In Settings->Collaborators and teams section of the new repository, add the Newspack team as a collaborators with write access.
You may need to add them individually and you can get their usernames from the Newspack team.

### Checking out the repo locally

Checkout the repo locally and run `npm run setup` to install everything.

```bash
git clone <your-repo-url>

cd <your-repo-name>

npm run setup
```

### Create the staging branch

In it doesn't already exist, create and `staging` branch and push it to the remote repository.

```bash
git checkout -b staging

git push origin staging
```
Please refer to [How to set up the Newspack Starter Template for custom plugins](https://help.newspack.com/how-to-set-up-the-newspack-starter-template-for-custom-plugins/) on help.newspack.com for up-to-date installation and setup instructions.