Skip to content

Commit a87f7cb

Browse files
committed
ADD: clarify readme
1 parent acefdde commit a87f7cb

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

README.rst

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,32 @@ See the `action.yaml`_ file for details of required inputs.
1616
Prerequisites
1717
-------------
1818

19-
* Github repo is setup with `confluencebuilder`_ to publish to confluence on
20-
``make confluence`` when run locally
19+
* Github repo is setup with `confluencebuilder`_ options to publish to
20+
confluence on ``make confluence`` when run locally
2121

2222

2323
Example usage
2424
-------------
2525

26+
The following is a fully function `Github Workflow`_. Note that
27+
``atlassianUsername`` and ``atlassianApitoken`` are `Github secrets`_ that need
28+
to be added to the Github repo.
29+
2630
.. code:: yaml
2731
28-
uses: actions/publish-confluence@v1
29-
with:
30-
username: ${{ secrets.atlassianUsername }}
31-
apitoken: ${{ secrets.atlassianApitoken }}
32+
on: [push]
33+
jobs:
34+
publish_confluence:
35+
runs-on: ubuntu-latest
36+
name: Publish docs to confluence
37+
steps:
38+
- uses: actions/checkout@v1
39+
- name: publish to confluence
40+
uses: pratikmallya/publish-confluence@master
41+
with:
42+
username: ${{ secrets.atlassianUsername }}
43+
apitoken: ${{ secrets.atlassianApitoken }}
3244
3345
.. _confluencebuilder: https://github.com/sphinx-contrib/confluencebuilder
46+
.. _Github secrets: https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets
47+
.. _Github Workflow: https://help.github.com/en/actions/automating-your-workflow-with-github-actions/configuring-a-workflow

0 commit comments

Comments
 (0)