Make release and documentation more sane.
OK, I think I have this nailed now.
This commit is contained in:
parent
9969dd3410
commit
5eba2a45b7
1
.gitignore
vendored
1
.gitignore
vendored
@ -1,3 +1,4 @@
|
|||||||
|
proddist/
|
||||||
dist/
|
dist/
|
||||||
.sass-cache/
|
.sass-cache/
|
||||||
.jekyll-metadata
|
.jekyll-metadata
|
||||||
|
9
Makefile
9
Makefile
@ -2,18 +2,17 @@ DEV_DIST_DIR:=dist
|
|||||||
PROD_DIST_DIR:=proddist
|
PROD_DIST_DIR:=proddist
|
||||||
PROD_REMOTE:=git@gitlab.com:autonomic-cooperative/autonomic-cooperative.gitlab.io.git
|
PROD_REMOTE:=git@gitlab.com:autonomic-cooperative/autonomic-cooperative.gitlab.io.git
|
||||||
PROD_BRANCH:=production
|
PROD_BRANCH:=production
|
||||||
|
PROD_BASE_URL:=https://autonomic.zone
|
||||||
|
|
||||||
devserver:
|
devserver:
|
||||||
@echo "Serving development site from $(DEV_DIST_DIR)"
|
@echo "Serving development site from $(DEV_DIST_DIR)"
|
||||||
@jekyll serve --watch --incremental --destination $(DEV_DIST_DIR)
|
@jekyll serve --watch --incremental --destination $(DEV_DIST_DIR)
|
||||||
.PHONY: devserver
|
.PHONY: devserver
|
||||||
|
|
||||||
proddist:
|
|
||||||
@echo "Building production site into $(PROD_DIST_DIR)"
|
|
||||||
@jekyll build --destination $(PROD_DIST_DIR)
|
|
||||||
.PHONY: proddist
|
|
||||||
|
|
||||||
release:
|
release:
|
||||||
|
@echo "Building production site into $(PROD_DIST_DIR)"
|
||||||
|
@jekyll build --destination $(PROD_DIST_DIR) --baseurl $(PROD_BASE_URL)
|
||||||
|
|
||||||
@echo "Pushing $(PROD_DIST_DIR) contents to the upstream production branch"
|
@echo "Pushing $(PROD_DIST_DIR) contents to the upstream production branch"
|
||||||
@git subtree push --prefix $(PROD_DIST_DIR) $(PROD_REMOTE) $(PROD_BRANCH)
|
@git subtree push --prefix $(PROD_DIST_DIR) $(PROD_REMOTE) $(PROD_BRANCH)
|
||||||
.PHONY: release
|
.PHONY: release
|
||||||
|
17
README.md
17
README.md
@ -17,16 +17,7 @@ Please see [CONTRIBUTING.md] for the juicy details.
|
|||||||
|
|
||||||
# Make A New Release
|
# Make A New Release
|
||||||
|
|
||||||
Our production site is contained in the [proddist folder]. You'll need to make
|
Firstly, you'll need to tag and push the latest HEAD with:
|
||||||
sure you have the latest changes by running:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ make proddist
|
|
||||||
```
|
|
||||||
|
|
||||||
If you see any unstaged changes, please verify them with someone and push them
|
|
||||||
to the upstream master remote. Make sure the latest pipeline is passing and tag
|
|
||||||
HEAD with:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ git tag -a <YOUR-VERSION-NUMBER> $(git rev-parse HEAD)
|
$ git tag -a <YOUR-VERSION-NUMBER> $(git rev-parse HEAD)
|
||||||
@ -38,9 +29,3 @@ Then make a release with:
|
|||||||
```bash
|
```bash
|
||||||
$ make release
|
$ make release
|
||||||
```
|
```
|
||||||
|
|
||||||
This pushes the contents of the [proddist folder] to the production
|
|
||||||
branch which will get picked up by our production instance of
|
|
||||||
the site.
|
|
||||||
|
|
||||||
[proddist folder]: https://gitlab.com/autonomic-cooperative/autonomic-cooperative.gitlab.io/tree/master/proddist
|
|
||||||
|
Reference in New Issue
Block a user