Use GitHub api to publish ghpages #169
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
juanpedromoreno
approved these changes
Apr 21, 2017
| @@ -25,18 +25,25 @@ If you're running the microsite locally, you can follow these steps: | |||
|
|
|||
| # Publish the microsite | |||
|
|
|||
| From version [`0.5.4`](https://github.com/47deg/sbt-microsites/releases/tag/v0.5.4), you have two options for publishing the site: | |||
There was a problem hiding this comment.
--for publishing
++to publish| @@ -25,18 +25,25 @@ If you're running the microsite locally, you can follow these steps: | |||
|
|
|||
| # Publish the microsite | |||
|
|
|||
| From version [`0.5.4`](https://github.com/47deg/sbt-microsites/releases/tag/v0.5.4), you have two options for publishing the site: | |||
| * **sbt-ghpages**: This is the default method. It uses the sbt-git plugin and the local ssh keys for pushing the changes. | |||
| * **github4s**: Avoids using local ssh keys, publishing the site with the GitHub web API. By contrast, you need to specify a token. | |||
There was a problem hiding this comment.
--publishing the site with the GitHub web API
++publishing the site through the GitHub HTTP API and [Github4s](https://github.com/47deg/github4s).|
|
||
| You need to create a GitHub token with `repo` scope. You can create it in the [GitHub settings](https://github.com/settings/tokens/new?scopes=repo&description=sbt-microsites) page. | ||
|
|
||
| Copy the token in a safe place, we'll send the token through an environment variable. |
There was a problem hiding this comment.
--we'll send the token through an environment variable.
++we'll use this token through an environment variable as we'll see shortly.|
|
||
| **2- Configure your project build** | ||
|
|
||
| You need to set these two properties: |
There was a problem hiding this comment.
--properties
++sbt settings
docs/src/main/tut/docs/settings.md
Outdated
|
|
||
| ``` | ||
| micrositeGithubOwner := "47deg" | ||
| micrositeGithubRepo := "sbt-microsites" | ||
| ``` | ||
|
|
||
| - `micrositeGithubToken`: used for publishing the site when `github4s` is enabled. A [token with repo scope](https://github.com/settings/tokens/new?scopes=repo&description=sbt-microsites) is needed. None by default: |
There was a problem hiding this comment.
--None by default:
++None by default, but you can override it in this way:
fedefernandez
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR replaces the publishMicrosite task with a command. Now, depending of the
micrositePushSiteWithsetting value, the plugin will publish the site with sbt-ghpages or github4s API.Please @juanpedromoreno, could you review? Thanks!