5 Commits

Author SHA1 Message Date
218128db23 Improve development docs
We've learned how to use kubectl patch for local testing

We've also abandoned the automation between github and dockerhub
because we publish updates with sufficient irregularity that it is
better if we take the steps more manually and verify each as we go.
2021-02-28 13:40:10 -07:00
6f9ed1279c upgrade to wiki 0.23.0 + wiki-client 0.23.0 with feeling
previous attempt didn't actually install the new wiki-client
fixed the previous single & between cd and npm install --save
2021-02-28 13:30:18 -07:00
2ff3dcad1e correct wiki-client version number 2021-02-28 09:57:40 -07:00
eab72db590 Move release notes for 1.0.0 into its own file 2021-02-28 09:31:17 -07:00
04c3ba7fe1 upgrade wiki-client to v0.23.0 2021-02-28 09:19:18 -07:00
3 changed files with 33 additions and 29 deletions

View File

@ -5,8 +5,10 @@ RUN apk add --update --no-cache \
git \ git \
jq jq
WORKDIR "/home/node" WORKDIR "/home/node"
ARG WIKI_PACKAGE=wiki@0.23 ARG WIKI_PACKAGE=wiki@0.23.0
ARG WIKI_CLIENT=wiki-client@0.23.0
RUN su node -c "npm install -g --prefix . $WIKI_PACKAGE" RUN su node -c "npm install -g --prefix . $WIKI_PACKAGE"
RUN su node -c "cd /home/node/lib/node_modules/wiki; npm install --save $WIKI_CLIENT"
RUN su node -c "mkdir -p .wiki" RUN su node -c "mkdir -p .wiki"
VOLUME "/home/node/.wiki" VOLUME "/home/node/.wiki"
EXPOSE 3000 EXPOSE 3000

View File

@ -17,22 +17,6 @@ Visit http://localhost:3000 and http://anything.localtest.me:3000
Your wiki pages and configuration will be saved in the ~/.wiki folder. Your wiki pages and configuration will be saved in the ~/.wiki folder.
# Release Notes for 1.0.0
This is a significant **breaking** change from pre-1.0 releases. Especially:
* changed the user from `app` (`uid=1001(app) gid=1001(app) groups=1001(app)`)
to `node` (`uid=1000(node) gid=1000(node) groups=1000(node),1000(node)`)
* no longer installing `bash`, `configure-wiki`, nor `set-owner-name`
* no longer creating `/home/app/.wiki/wiki.json`
Those changes in particular will impose some work on authors upgrading
from previous versions.
The last non-breaking revision is 0.52.0 https://github.com/dobbs/farm/tree/0.52.0#readme
# Development # Development
This image's tag does not match the version of the included wiki This image's tag does not match the version of the included wiki
@ -42,27 +26,30 @@ devops pipeline.
Testing new images locally: Testing new images locally:
``` bash ``` bash
IMAGE=dobbs/farm:1.0.7-pre-22 TAG=1.0.8-prefer-title
IMAGE=dobbs/farm:$TAG
docker build --tag $IMAGE . docker build --tag $IMAGE .
``` ```
With the local kubernetes example (see [examples/k8s/README.md](./examples/k8s/README.md)): With the local kubernetes example (see [examples/k8s/README.md](./examples/k8s/README.md)):
``` bash ``` bash
export IMAGE=dobbs/farm:1.0.7-pre-22
docker build --tag $IMAGE .
k3d image import $IMAGE --cluster wiki k3d image import $IMAGE --cluster wiki
cd ./examples/k8s/ kubectl patch deployment.apps/wiki-deployment \
perl -pi -e 's{^(\s+image:\s*).*$}{\1 $ENV["IMAGE"]}' wiki.yaml --type='json' \
kubectl apply -f wiki.yaml -p='[{"op": "replace", "path": "/spec/template/spec/containers/0/image", "value":"'$IMAGE'"}]'
``` ```
The repos in Dockerhub and GitHub are configured to automatically build new tags. # Publish containers with experimental code
# Publish experimental plugins GitHub
Invoke Dockerhub and GitHub integration.
``` bash ``` bash
git tag -am "" '1.0.2-pre-0217' git tag -am "" "$TAG"
git push --atomic origin main '1.0.2-pre-0217' git push --atomic origin main "$TAG"
```
Docker Hub
``` bash
docker push $IMAGE
``` ```

15
RELEASE-NOTES-1.0.0.md Normal file
View File

@ -0,0 +1,15 @@
# Release Notes for 1.0.0
This is a significant **breaking** change from pre-1.0 releases. Especially:
* changed the user from `app` (`uid=1001(app) gid=1001(app) groups=1001(app)`)
to `node` (`uid=1000(node) gid=1000(node) groups=1000(node),1000(node)`)
* no longer installing `bash`, `configure-wiki`, nor `set-owner-name`
* no longer creating `/home/app/.wiki/wiki.json`
Those changes in particular will impose some work on authors upgrading
from previous versions.
The last non-breaking revision is 0.52.0 https://github.com/dobbs/farm/tree/0.52.0#readme