From c8fed30c659bb9141dc6621998566c5adb177d5f Mon Sep 17 00:00:00 2001 From: Peter Evans Date: Fri, 3 Jan 2020 09:51:43 +0900 Subject: [PATCH] Move docs --- README.md | 10 +++++++--- concepts-guidelines.md => docs/concepts-guidelines.md | 0 examples.md => docs/examples.md | 0 updating.md => docs/updating.md | 6 +++--- 4 files changed, 10 insertions(+), 6 deletions(-) rename concepts-guidelines.md => docs/concepts-guidelines.md (100%) rename examples.md => docs/examples.md (100%) rename updating.md => docs/updating.md (87%) diff --git a/README.md b/README.md index 837fcc9..190a30e 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,13 @@ Create Pull Request action will: 2. Commit all changes to a new branch, or update an existing pull request branch. 3. Create a pull request to merge the new branch into the base—the branch checked out in the workflow. -## Usage +## Documentation -See [examples](examples.md) for detailed use cases. +- [Concepts and guidelines](docs/concepts-guidelines.md) +- [Examples](docs/examples.md) +- [Updating from v1](docs/updating.md) + +## Usage ```yml - name: Create Pull Request @@ -146,7 +150,7 @@ As well as relying on the action to handle uncommitted changes, you can addition The following workflow is a reference example that sets all the main inputs. -See [examples](examples.md) for more realistic use cases. +See [examples](docs/examples.md) for more realistic use cases. ```yml name: Create Pull Request diff --git a/concepts-guidelines.md b/docs/concepts-guidelines.md similarity index 100% rename from concepts-guidelines.md rename to docs/concepts-guidelines.md diff --git a/examples.md b/docs/examples.md similarity index 100% rename from examples.md rename to docs/examples.md diff --git a/updating.md b/docs/updating.md similarity index 87% rename from updating.md rename to docs/updating.md index 09e8696..6ae1ec2 100644 --- a/updating.md +++ b/docs/updating.md @@ -20,6 +20,6 @@ ## New features -- Unpushed commits made during the workflow before the action runs will now be considered as changes to be raised in the pull request -- New commits made to the pull request base will now be taken into account when pull requests are updated -- If an updated pull request no longer differs from its base it will automatically be closed and the pull request branch deleted +- Unpushed commits made during the workflow before the action runs will now be considered as changes to be raised in the pull request. See [Controlling commits](https://github.com/peter-evans/create-pull-request/tree/v2-beta#controlling-commits) for details. +- New commits made to the pull request base will now be taken into account when pull requests are updated. +- If an updated pull request no longer differs from its base it will automatically be closed and the pull request branch deleted.