Package action for GitHub Marketplace

README.md

@@ -12,6 +12,29 @@ e.g. `contrib/awesomity/v1.2.3`.
 Usage
 -----
 
+Create a new workflow file with following context:
+
+```yaml
+on:
+  release:
+    types:
+      - created
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+      - '**/v[0-9]+.[0-9]+.[0-9]+'
+
+jobs:
+  build:
+    name: Renew documentation
+    runs-on: ubuntu-latest
+    steps:
+    - name: Pull new module version
+      uses: andrewslotin/go-proxy-pull-action@master
+```
+
+This will trigger the action each time whenever a new release is published for a tag that looks either like `vX.Y.Z` or
+`submodule/path/vX.Y.Z`.
+
 Why?
 ----
 

action.yml

@@ -0,0 +1,14 @@
+name: 'Go proxy warming'
+description: 'Pull the new release of a module to the Go proxy cache'
+author: 'Andrey Slotin'
+inputs:
+  goproxy:
+    description: 'URL of the proxy to be passed to `go get` as GOPROXY='
+    required: false
+    default: 'https://proxy.golang.org'
+runs:
+  using: 'docker'
+  image: 'Dockerfile'
+branding:
+  icon: 'download'
+  color: 'blue'