hugo-sandstorm/README.md

51 lines
1.6 KiB
Markdown
Raw Normal View History

2022-11-26 16:56:24 +00:00
_Use [this fork](https://github.com/ocdtrekkie/hugo-sandstorm) of the project instead!_
# Hugo Sandstorm package
2017-03-13 19:18:41 +00:00
This is the [Sandstorm](https://sandstorm.io) package of [Hugo](https://gohugo.io/).
2020-07-28 10:59:12 +00:00
The version of Hugo in this build is listed in `hugo-version`.
2017-03-13 19:18:41 +00:00
## Development
2017-03-13 19:18:41 +00:00
The package is built with [vagrant-spk](https://github.com/sandstorm-io/vagrant-spk),
a tool designed to help app developers package apps for [Sandstorm](https://sandstorm.io).
2017-03-13 19:18:41 +00:00
You can follow the below mentioned steps to make your own package or to contribute.
### Prerequisites
2017-03-13 19:18:41 +00:00
You will need to install:
* [Vagrant](https://www.vagrantup.com/)
* [VirtualBox](https://www.virtualbox.org/wiki/Downloads)
* Git
2017-03-13 19:18:41 +00:00
## Step by Step
```
git clone https://github.com/sandstorm-io/vagrant-spk
git clone https://github.com/johnbintz/hugo-sandstorm
2017-03-13 19:18:41 +00:00
export PATH=$(pwd)/vagrant-spk:$PATH
cd hugo-sandstorm
bin/test_hugo
2017-03-13 19:18:41 +00:00
```
2021-10-14 12:11:39 +00:00
Visit [http://local.sandstorm.io:6090/](http://local.sandstorm.io:6090/) in a web browser.
2017-03-13 19:18:41 +00:00
Note: when you want to fork this repo and create actual app packages for the app
store you would need either the original app key or
[create a new one and make your own version of the app](https://docs.sandstorm.io/en/latest/developing/publishing-apps/).
2020-04-26 20:51:55 +00:00
## Upgrades
* You'll need Ruby 2.6 and `gem install httparty`.
* Run `bin/upgrade_hugo <new version>`.
* Follow the directions.
## Pack and publish
2021-10-15 19:53:57 +00:00
* Run `bin/update_changelogs` to update changelogs for the package
* Run `bin/pack_hugo` to create an spk in the parent directory to ths one
* Try loading that spk into a separate Sandstorm instance for testing
* If it works, run `bin/publish_hugo` to publish that version to the App Market