Skip to content

Commit

Permalink
feat: auto-publish cli-reference docs
Browse files Browse the repository at this point in the history
* feat: delete multiple entities; save credentials default true;

strm context billing-id shows no login information if user is not logged in

* fix: delete debuggin println call

* fix: delete unused variable; change comments for tab completions from two to multiple

* feat: add hidden flag to generate all docs to 'root/docs'

* feat: delete comma in delete help strings; minor refactors

* feat: add auto-generated docs; wip

* fix: change git push command

* fix: change git push command

* feat: place docs files in right directories

* fix: delete generated docs

* fix: change cli command from strm to dstrm

* fix: change readability of job

* fix: add make command to publishing docs

* fix: driving me crazy yo

* fix: dstrm to strm

* fix: absolute path to binary

* chore: trigger actions

* fix: rebase branch before push

* chore: trigger actions

* feat: auto-generate docs with additonial docstring

* fix: delete generated docs before (re)creating

* fix: overwrite cli reference docs when generating

* fix: delete generated docs from git; add to gitignore

* feat: move docs publishing functionality from pr to release

* fix: delete local test file

* feat: publish docs to shell script; make index files for docs

* chore: putting full script in pr.yaml to debug

* fix: strm -> dstrm

* fix: strm -> dstrm

* fix: force push to remote branch

* fix: move publish docs script back to file

* feat: trigger publishing docs in release

* fix: delete commented code

* feat: fix doc links; bug fixes

* feat: add regex for changing links

* feat: correct sed command; correct globbing; nest docs in dstrm directory

* feat: change to root command name in docstrings

* fix: move publishing docs from release to build

Co-authored-by: bob van den hoogen <bob@strmprivacy.io>
  • Loading branch information
bobvandenhoogen and bob van den hoogen authored Feb 22, 2022
1 parent f13181b commit 923566c
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
7 changes: 7 additions & 0 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,10 @@ jobs:
git push
git tag -a "${tag_name}" -m "Release brew formula for STRM Privacy CLI ${tag_name}"
git push --tags
- name: Publish Docs
env:
GITHUB_TOKEN: ${{secrets.GH_TOKEN}}
APIS_USERNAME: ${{secrets.APIS_USERNAME}}
APIS_EMAIL: ${{secrets.APIS_EMAIL}}
run: |
./scripts/publish_docs.sh
6 changes: 3 additions & 3 deletions scripts/generate_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ else
SED="sed"
fi

make
if [[ $APIS_EMAIL != "" ]]
then
git config --global user.email "${APIS_EMAIL}"
Expand All @@ -20,9 +19,10 @@ mkdir generated_docs

if [[ $APIS_EMAIL == "" ]]
then
dstrm --generate-docs > /dev/null 2>&1
make
./dist/dstrm --generate-docs > /dev/null 2>&1
else
./dist/strm --generate-docs > /dev/null 2>&1
./dist/strm_linux_amd64/strm --generate-docs > /dev/null 2>&1
fi

cd generated_docs
Expand Down

0 comments on commit 923566c

Please sign in to comment.