1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-18 23:08:48 +00:00

add readme, schedule workflow, tag stuff

This commit is contained in:
Jason Hall 2022-03-01 08:47:52 -05:00
parent 1456dab6c7
commit 2c2305220d
2 changed files with 22 additions and 2 deletions

View file

@ -4,6 +4,8 @@ on:
workflow_dispatch: workflow_dispatch:
push: push:
branches: ['main'] branches: ['main']
schedule:
- cron: '0 6 * * *' # Daily at 6 AM
permissions: permissions:
contents: write contents: write
@ -20,12 +22,14 @@ jobs:
with: with:
install_components: alpha,beta install_components: alpha,beta
- run: ./crawl.sh
- run: | - run: |
rm -r gcloud/
./crawl.sh
git config user.name "Automated" git config user.name "Automated"
git config user.email "actions@users.noreply.github.com" git config user.email "actions@users.noreply.github.com"
git add -A git add -A
timestamp=$(date -u) timestamp=$(date -u)
git commit -m "gcloud: ${timestamp}" || exit 0 git commit -m "gcloud: ${timestamp}" || exit 0
git push git tag $(gcloud version --format=json | jq -r '."Google Cloud SDK"')
git push --tags

16
README.md Normal file
View file

@ -0,0 +1,16 @@
# `gcloud help`
This repo automatically scrapes the help text for [`gcloud`](https://cloud.google.com/sdk/) and puts it in this Git repo.
Scraping is automated with GitHub Actions.
Every day, the workflow installs the latest `gcloud` release, and crawls the output of `gcloud help` and all subgroups and subcommands.
The output is placed in [the `gcloud/` directory](./gcloud/).
This produces the same content as the [official CLI reference](https://cloud.google.com/sdk/gcloud/reference), in text form, with history.
This enables diffing the help text of two `gcloud` releases.
---
All text content is owned by Google, licensed under the [Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/).
Code in the repo is owned by me, licensed under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0).