Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): prepare for v1.0.0 release #97

Merged
merged 1 commit into from
Nov 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Changelog

All notable changes to this project will be documented in this file.
See updating [Changelog example here](https://keepachangelog.com/en/1.0.0/)

## [Unreleased]

## [1.0.0]

First stable release

[Unreleased]: https://github.com/UpCloudLtd/upcloud-csi/compare/v1.0.0...HEAD
[1.0.0]: https://github.com/UpCloudLtd/upcloud-csi/releases/tag/1.0.0
7 changes: 3 additions & 4 deletions DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,13 @@ $ make build-plugin
Project's application can be found under `cmd` directory:
- `upcloud-csi-plugin` is monolith CSI driver that can be run as controller or node driver (or both).

### Driver
Required interfaces are implemented by `Driver` type in `driver` package. For clarity, interface implementations are separated based on their role to files `controller.go`, `node.go` and `identity.go`.
Driver's gRPC server exposes endpoints described in following interfaces:
### Plugin
Required CSI interfaces are implemented in `controller`, `node` and `ìdentity` packages.
Plugin's gRPC server uses these packages to expose endpoints described in following interfaces:
- [csi.IdentityServer](https://pkg.go.dev/github.com/container-storage-interface/[email protected]/lib/go/csi#IdentityServer)
- [csi.ControllerServer](https://pkg.go.dev/github.com/container-storage-interface/[email protected]/lib/go/csi#ControllerServer)
- [csi.NodeServer](https://pkg.go.dev/github.com/container-storage-interface/[email protected]/lib/go/csi#NodeServer)

It's good to keep in mind that althought same `Driver` type implementes all the interfaces, node (`csi.NodeServer`) and controller (`csi.ControllerServer`) endpoints are normally executed on different hosts.

## Testing
Run tests using `make`
Expand Down
4 changes: 0 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,6 @@ Additional info about the CSI can be found
in [Kubernetes CSI Developer Documentation](https://kubernetes-csi.github.io/docs/)
and [Kubernetes Blog](https://kubernetes.io/blog/2019/01/15/container-storage-interface-ga/).

## Disclaimer

Before reaching the **v1.0.0** version, UpCloud CSI Driver is **NOT** recommended for production environment usage.

## Deployment
### Kubernetes
Kubernetes deployment [README](deploy/kubernetes/README.md) describes how to deploy UpCloud CSI driver using `kubectl` and sidecar containers.
Expand Down
15 changes: 15 additions & 0 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Releasing

1. Merge all your changes to the stable branch
3. Update CHANGELOG.md
1. Add new heading with the correct version e.g. `## [1.0.1]`
2. Update links at the bottom of the page
3. Leave `## Unreleased` section at the top empty
5. Test GoReleaser config with `goreleaser check`
6. Tag a commit with the version you want to release e.g. `v1.2.0`
7. Push the tag & commit to GitHub
- GitHub action automatically
- sets the version based on the tag
- creates a draft release to GitHub
8. Verify that [release notes](https://github.com/UpCloudLtd/upcloud-csi/releases) are in line with `CHANGELOG.md`
peknur marked this conversation as resolved.
Show resolved Hide resolved
9. Publish the drafted release