-
Notifications
You must be signed in to change notification settings - Fork 7
Add note to Guide about how data consumers should handle notification messages with updates #218
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.
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
Merged
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| name: WIS2 Guide for INFCOM review | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - INFCOM-4 | ||
|
|
||
| env: | ||
| FILE_BASENAME: wis2-guide-DRAFT-INFCOM-4 | ||
|
|
||
| jobs: | ||
| build-wis2-guide: | ||
| name: Generate documentation | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Install dependencies | ||
| run: | | ||
| sudo apt-get update -y \ | ||
| && sudo apt-get install -y pandoc \ | ||
| && sudo gem install asciidoctor asciidoctor-pdf | ||
| - name: checkout repository | ||
| uses: actions/checkout@master | ||
| - name: build documentation | ||
| run: | | ||
| mkdir -p /tmp/wis2-guide/guide/images \ | ||
| && cd guide \ | ||
| && asciidoctor --trace -o /tmp/wis2-guide/guide/${FILE_BASENAME}.html index.adoc \ | ||
| && asciidoctor --trace --backend docbook --out-file - index.adoc | pandoc --from docbook --to docx --output /tmp/wis2-guide/guide/${FILE_BASENAME}.docx \ | ||
| && asciidoctor --trace -r asciidoctor-pdf --trace -b pdf -o /tmp/wis2-guide/guide/${FILE_BASENAME}.pdf index.adoc \ | ||
| && cp images/*.png /tmp/wis2-guide/guide/images \ | ||
| && cd .. | ||
| - name: checkout gh-pages branch | ||
| uses: actions/checkout@master | ||
| with: | ||
| ref: gh-pages | ||
| - name: update gh-pages branch and publish | ||
| run: | | ||
| git checkout gh-pages | ||
| git config --global user.email "tomkralidis@gmail.com" | ||
| git config --global user.name "Tom Kralidis" | ||
| rm -rf guide/infcom | ||
| mkdir -p guide/infcom | ||
| mv -f /tmp/wis2-guide/* guide/infcom | ||
| git add . | ||
| git commit -am "update WIS2 Guide INFCOM build" | ||
| git push | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| name: Test WIS2 Guide build for INFCOM review | ||
|
|
||
| on: | ||
| pull_request: | ||
| branches: | ||
| - INFCOM-4 | ||
| paths: | ||
| - '**.adoc' | ||
|
|
||
| env: | ||
| FILE_BASENAME: wis2-guide-DRAFT-INFCOM-4 | ||
|
|
||
| jobs: | ||
| build-wis2-guide: | ||
| name: Test documentation build | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Install dependencies | ||
| run: | | ||
| sudo apt-get update -y \ | ||
| && sudo apt-get install -y pandoc \ | ||
| && sudo gem install asciidoctor asciidoctor-pdf | ||
| - name: checkout repository | ||
| uses: actions/checkout@master | ||
| - name: build documentation | ||
| run: | | ||
| mkdir -p /tmp/wis2-guide/guide/images \ | ||
| && cd guide \ | ||
| && asciidoctor --trace -o /tmp/wis2-guide/guide/${FILE_BASENAME}.html index.adoc \ | ||
| && asciidoctor --trace --backend docbook --out-file - index.adoc | pandoc --from docbook --to docx --output /tmp/wis2-guide/guide/${FILE_BASENAME}.docx \ | ||
| && asciidoctor --trace -r asciidoctor-pdf --trace -b pdf -o /tmp/wis2-guide/guide/${FILE_BASENAME}.pdf index.adoc |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adjust one of the sentences?
"A data consumer should NOT expect to receive multiple notification messages about the same data item. Nor should data consumers assume..."
OR
"A data consumer should expect to receive multiple notification messages about the same data item. However, data consumers should NOT assume..."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I took the second suggestion.