Skip to content

Commit

Permalink
Instructions updates
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanwelcher committed Feb 10, 2025
1 parent ca5cc4e commit 660db9b
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,18 @@ It will give you all of the tools you needs to get up and running quickly.
3. A [Prettier](https://prettier.io/) configuration for WordPress.
4. A [Husky](https://typicode.github.io/husky/) configuration to lint local files changes before they are committed.
5. A GitHub action to check that your commits and merges adhere to the correct coding standards
6. A GitHub action to automatically deploy your changes when merged to trunk. (See the Setup section for how to enable this feature)
6. A GitHub action to automatically deploy your changes to the production environment when merged to trunk.
7. A GitHub action to automatically deploy your changes to the staging environment when pushing to the `staging` branch.

## How do I use it?

1. Start by clicking the `Use this template` to use this as a starting point for your project.
2. In the Secrets and Variables->Actions under the Settings menu of the new repository. Create new the secrets outline in the table below.
3. Checkout the repo locally and run `npm run setup` to install everything.
4. Start developing!
1. Start by clicking the `Use this template` button to create a new repository in your own GitHub account from this template.
2. In the Secrets and Variables->Actions sections under the Settings menu of the new repository. Create new the secrets outlined in the table below.
3. In the Settings->Branches section of the new repository, set the branch protection rules to require a pull request to trunk, an approved review, and status checks to pass before merging.
4. 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.
5. Checkout the repo locally and run `npm run setup` to install everything.
6. In it doesn't already exist, create and `staging` branch and push it to the remote repository.
7. Start developing!

### Secrets

Expand Down

0 comments on commit 660db9b

Please sign in to comment.