diff --git a/README.md b/README.md index 8b7a89e..c960294 100644 --- a/README.md +++ b/README.md @@ -76,6 +76,10 @@ The examples seek to be: - Clear (eg resource names are verbose and unambiguous) +## Release Process + +See [here](RELEASE_PROCESS.md) + ## Sources / Thanks To [Official Kubernetes docs](https://kubernetes.io/docs/) diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md new file mode 100644 index 0000000..0c44da4 --- /dev/null +++ b/RELEASE_NOTES.md @@ -0,0 +1,49 @@ +== v0.0.3 + + +- Add Kubeval test + +- Added Deployment/simple-deployment-privileged.yaml + +- Added Deployment/simple-deployment-with-environment.yaml + +- Added Endpoints/endpoint-slice.yaml + +- Added restartPolicy to Job/simple.yaml + +- Added PersistentVolumeClaim/pvc.yaml + +- Added Pod/spec.affinity.nodeAffinity/node-affinity.yaml + +- Added Pod/spec.nodeSelector/simple.yaml + +- Added Pod/spec.volumes.persistentVolumeClaim/pod-pvc.yaml + +- Added PodDisruptionBudget/pod-disruption-budget-max-unavailable.yaml and PodDisruptionBudget/pod-disruption-budget-min-available.yaml + +- Added PodPreset/pod-preset.yaml + +- Added PriorityClass/default-priority-class.yaml + +- Added Secret/simple-secret.yaml + +- Added ServiceAccount/service-account-pod.yaml + +- Corrected Pod/spec.containers.volumes.projected/projected.yaml + +- Corrected Pod/spec.volumes.hostPath.type/file-or-create.yaml + +- Corrected PodSecurityPolicy/Ingress/simple.yaml + +- Corrected Service/spec.type/load-balancer.yaml + + +- Code of conduct, license, and contributions guidelines added + +== v0.0.2 + +- Bugfix for v0.0.1 + +== v0.0.1 + +- Initial base examples added diff --git a/RELEASE_PROCESS.md b/RELEASE_PROCESS.md new file mode 100644 index 0000000..e83e86e --- /dev/null +++ b/RELEASE_PROCESS.md @@ -0,0 +1,31 @@ +# Kubernetes-Examples Release Process + +## Fetch Tags and Diff + +Get the latest tags: + +``` +git fetch --tag +git tag +``` + +Diff the current code tag from the last one, and update the `RELEASE_NOTES.md` file, eg: + +``` +git diff -w v0.0.2 +``` + + +## Generate code + +Follow this doc to make a release in GitHub: + +[Release](https://docs.github.com/en/github/administering-a-repository/releasing-projects-on-github/managing-releases-in-a-repository) + +## Announce + +Announce on various channels: + +- Twitter + +- LinkedIn