When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. If you are planning to work on an issue that already exists please let us know before writing any code incase it's already in flight!
yourname/github-pages-deplpy-action@dev
.yarn format
and yarn lint
.yarn test
to run the suite. As this action is small in scope it's important that a high level of test coverage is maintained. All tests are written using Jest.yarn build
.In order to deploy and test your own fork of this action, you must commit the node_modules
dependencies. Be sure to run nvm use
before installing any dependencies. You can learn more about nvm here.
To do this you can follow the instructions below:
Install the project:
yarn install
Comment out the following in distribution branches:
# node_modules/ # lib/
Build the project:
yarn build
Commit:
$ git checkout -b branchnamehere $ git commit -a -m "prod dependencies"
The node_modules
and lib
folders should not be included when making a pull request. These are only required for GitHub Actions when it consumes the distribution branch, the dev
branch of the project should be free from any dependencies or lib files.