diff --git a/CHANGELOG.md b/CHANGELOG.md index 5589940..8fb5769 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,3 +12,41 @@ `[BUGFIX]` +# 0.5.1 + +`[CHANGE]` + +`[FEATURE]` + +`[ENHANCEMENT]` + +`[BUGFIX]` +- Fix the issue that ofn install cannot install the latest version of OpenFunction #19 + +# 0.5.2 + +`[CHANGE]` + +`[FEATURE]` + +`[ENHANCEMENT]` +- Change the default version of OpenFunction to the latest stable version +- Add the `--force` option to force the operation +- Use the spinner instead of the original process display +- Adjust the function hierarchy to make some functions more generic + +`[BUGFIX]` + +# 0.5.3 + +`[CHANGE]` +- Adjust the condition of Shipwright so that it is always enabled + +`[FEATURE]` +- Add `version` subcommand + +`[ENHANCEMENT]` + +`[BUGFIX]` +- Fix the issue where the spinner was not terminating correctly +- Use the correct prompts to circumvent exceptions when executing on unsupported operating systems \ No newline at end of file diff --git a/README.md b/README.md index 79b5b35..bfd2bff 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ Visit [ofn releases page](https://github.com/OpenFunction/cli/releases/) to down > Make sure you put the artifacts from the above step under the appropriate path in `PATH` and rename it `ofn`. -Run `ofn install --all` to implement a simple deployment. By default, this command will install the *v0.4.0* version of OpenFunction and skips the installation of components that already exist. To overwrite the existing components, use the `--upgrade` command. +Run `ofn install --all` to implement a simple deployment. By default, this command will install the *latest stable* version of OpenFunction and skips the installation of components that already exist. To overwrite the existing components, use the `--upgrade` command. For more information, refer to the [ofn install document](docs/install.md). @@ -106,20 +106,3 @@ The following components already exist: βœ“ OpenFunction - Completed! πŸš€ Completed in 1m17.729501739s. ``` - -### Build OpenFunction CLI - -To build the OpenFunction CLIβ€”β€”`ofn`, run `make build`. -When the command is executed, you can find the artifact in the `. /dist` directory. -Move it to an appropriate path in the `PATH` so that you can use it in your environment. - -```shell -~# make build -go fmt ./... -/opt/openfunction/fn-cli/bin/goimports -w cmd/ pkg/ testdata/ -go vet ./... -CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags "-s -w -X 'main.goversion=go version go1.16.7 linux/amd64'" \ --o ./dist/fn_linux_amd64 cmd/main.go; -``` - -### diff --git a/RELEASE.md b/RELEASE.md index eebdb83..7635663 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -7,6 +7,9 @@ This page describes the release process and the currently planned schedule for u | release series | date (year-month-day) | release shepherd | |----------------|--------------------------------------------|---------------------------------------------| | v0.5.0 | 2021-12-21 | Laminar (GitHub: @tpiperatgod) | +| v0.5.1 | 2021-12-22 | Laminar (GitHub: @tpiperatgod) | +| v0.5.2 | 2022-01-03 | Laminar (GitHub: @tpiperatgod) | +| v0.5.3 | 2022-02-14 | Laminar (GitHub: @tpiperatgod) | # How to cut a new release @@ -45,22 +48,24 @@ Create a PR for the changes to be reviewed. ## Publish the new release For new minor and major releases, create the `release-.` branch starting at the PR merge commit. -From now on, all work happens on the `release-.` branch. -Build the `ofn` cli: +From now on, all work happens on the `release-.` branch. -```bash -make build -``` Tag the new release with a tag named `v..`, e.g. `v2.1.3`. Note the `v` prefix. You can do the tagging on the commandline: ```bash -tag="$(< VERSION)" +tag="v2.1.3" # Select a suitable and correct version git tag -a "${tag}" -m "${tag}" git push origin "${tag}" ``` Commit all the changes. +Build the `ofn` cli: + +```bash +make build +``` + Go to https://github.com/OpenFunction/cli/releases/new, associate the new release with the before pushed tag, paste in changes made to `CHANGELOG.md`, add cli file `ofn` and then click "Publish release". For patch releases, submit a pull request to merge back the release branch into the `main` branch.