Skip to content

Update README.md #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,22 @@
A Github action to generate a markdown file into a Confluence page.
# Confluence GHA

This is a reusable GitHub Action which translates a Markdown file into a Confluence
page.

This makes it simple to translate code documentation into public or internal pages
in Confluence. This is an example of usage:

```
jobs:
generate-confluence-page:
runs-on: ubuntu-latest
name: A job to generate Confluence page
steps:
- name: Generate confluence page
uses: identiv/confluence@v1
with:
source: README.md
url: https://identivegroup.atlassian.net/wiki
conf-account: ${{ secrets.CONFLUENCE_ACCOUNT }}
conf-api-key: ${{ secrets.CONFLUENCE_API_KEY }}
```