Skip to content

Commit b29d095

Browse files
committed
chore(doc): Add development and release docs.
1 parent ea048d9 commit b29d095

File tree

3 files changed

+24
-2
lines changed

3 files changed

+24
-2
lines changed

.github/workflows/release.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ jobs:
4848
with:
4949
files: build/*
5050
tag_name: "${{ env.NEW_TAG }}"
51+
generate_release_notes: true
52+
fail_on_unmatched_files: true
5153
- name: Checkout https://github.com/cloudfoundry/cli-plugin-repo
5254
uses: actions/checkout@v4
5355
with:

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
App-AutoScaler plug-in provides the command line interface to manage [App AutoScaler](https://github.com/cloudfoundry/app-autoscaler) policies, retrieve metrics and scaling event history.
44

5-
65
## Install plugin
76

87
### From CF-Community
@@ -11,7 +10,7 @@ App-AutoScaler plug-in provides the command line interface to manage [App AutoSc
1110
cf install-plugin -r CF-Community app-autoscaler-plugin
1211
```
1312

14-
## From source code
13+
### From source code
1514

1615

1716
```shell
@@ -26,6 +25,10 @@ make install
2625
cf uninstall-plugin AutoScaler
2726
```
2827

28+
## Development
29+
30+
Please see [the development docs](doc/development.md) for how to work on this plugin.
31+
2932
## Command List
3033

3134
| Command | Description |

doc/development.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Development
2+
3+
Start by installing [`devbox`](https://www.jetify.com/devbox/docs/installing_devbox/) and optionally `direnv` (you could [use devbox to install it globally](https://www.jetify.com/devbox/docs/devbox_global/) by using `devbox global add direnv`).
4+
5+
This should allow to use `make`.
6+
7+
Check out the targets available in the Make file by running `make help`.
8+
9+
## Releasing
10+
11+
1. Trigger a [release build workflow run](https://github.com/cloudfoundry/app-autoscaler-cli-plugin/actions/workflows/release.yml). You need to manually determine the correct semantic version. This could be automated in the future.
12+
2. In the output of the release job you triggered, navigate to the output of the step "Update plugin repo". At the bottom you will find a line similar to:
13+
> remote: Create a pull request for 'bump-app-autoscaler-cli-plugin-to-vX.X.X' on GitHub by visiting:
14+
15+
Click the link in the following line.
16+
This will open a PR with a template. Remove the template text after the first sentence and optionally add some notes. Create the PR and make sure it gets merged eventually.
17+
3. Once it is merged, after up to 24 hours later the release should appear at the top of [plugins.cloudfoundry.org](https://plugins.cloudfoundry.org/). Once this is the case it can be consumed using the regular install command listed in the [main README.md](../README.md).

0 commit comments

Comments
 (0)