Skip to content

Commit 15bc016

Browse files
832 consolidate hosted osi documentation sources (#837)
* Issue #832: Removed obsolete steps from workflow "protobuf" * Issue #832: Replaced DCO reference in pull request template * Issue #832: Removed outdated reference to Asciidoc output. --------- Signed-off-by: Philip WINDECKER (AVENYR GmbH) <philip.windecker@avenyr.de>
1 parent b00ad2b commit 15bc016

File tree

3 files changed

+4
-22
lines changed

3 files changed

+4
-22
lines changed

.github/pull_request_template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ How has it been tested?
1313
#### Take this checklist as orientation for yourself, if this PR is ready for the Change Control Board:
1414
- [ ] My suggestion follows the [style and contributors guidelines](https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/specification/contributing/start_contributing.html).
1515
- [ ] I have taken care about the [message documentation](https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/specification/contributing/commenting_messages.html) and the [fields and enums documentation](https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/specification/contributing/commenting_fields_enums.html).
16-
- [ ] I have done the [DCO signoff](https://opensimulationinterface.github.io/osi-documentation/open-simulation-interface/doc/howtocontribute.html#developer-certification-of-origin-dco).
17-
- [ ] My changes generate no errors when passing CI tests.
16+
- [ ] I have done the [DCO signoff](https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/specification/contributing/dco.html).
17+
- [ ] My changes generate no errors when passing CI tests.
1818
- [ ] I have successfully implemented and tested my fix/feature locally.
1919
- [ ] Appropriate reviewer(s) are assigned.
2020

.github/workflows/protobuf.yml

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ jobs:
9797
9898
- name: Get git Version
9999
id: get_version
100-
run: echo "VERSION=$(git describe --tags --always)" >> $GITHUB_OUTPUT
100+
run: echo "VERSION=$(git describe --tags --always)" >> $GITHUB_OUTPUT
101101

102102
- name: Prepare Documentation Build
103103
run: |
@@ -122,28 +122,13 @@ jobs:
122122
- name: Run Python Tests
123123
run: python -m unittest discover tests
124124

125-
- name: Archive Documentation
126-
if: ${{ github.event_name == 'pull_request' }}
127-
uses: actions/upload-artifact@v4
128-
with:
129-
name: linux64-doc
130-
path: doc/html
131-
if-no-files-found: error
132-
133125
- name: Upload Python Distribution
134126
if: ${{ github.event_name == 'pull_request' || ( github.event_name == 'push' && ( github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/v') ) ) }}
135127
uses: actions/upload-artifact@v4
136128
with:
137129
name: python-dist
138130
path: dist/
139131

140-
- name: Deploy to gh-pages if push to master branch
141-
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
142-
uses: peaceiris/actions-gh-pages@v3
143-
with:
144-
github_token: ${{ secrets.GITHUB_TOKEN }}
145-
publish_dir: ./doc/html
146-
147132
build-proto3-linux64:
148133
name: Build Proto3 Linux 64
149134

osi_version.proto.in

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,7 @@ package osi3;
2525
// properly set the version components prior to sending.
2626
//
2727
// Increments will happen as part of changes to the whole interface.
28-
// The meaning of different InterfaceVersions is defined in [1].
29-
//
30-
// \par Reference:
31-
// [1] Open Simulation Interface. (2020, January 25). <em>README</em>. Retrieved January 25, 2020, from https://opensimulationinterface.github.io/osi-documentation/open-simulation-interface/README.html
28+
// The meaning of different InterfaceVersions is defined in the versioning chapter of the official OSI documentation.
3229
//
3330
message InterfaceVersion
3431
{

0 commit comments

Comments
 (0)