Refactor documentation and GitHub Actions #1279
Conversation
.github/workflows/build.yml
Outdated
| if: ${{ github.event_name == 'release' }} | ||
| uses: docker/[email protected] | ||
| with: | ||
| repository: oicrgsi/shesmu |
There was a problem hiding this comment.
just double checking this should be 'oicrgsi' and not 'oicr-gsi' in this context?
docs/index.md
Outdated
| - [Compiler Hacking](compiler-hacking.md) | ||
| - [Java API Documentation](javadoc) | ||
|
|
||
| ### Miscellaeno |
There was a problem hiding this comment.
Did you mean 'miscellanea'?
docs/installation.md
Outdated
| - Prometheus Alert Manager (required for `Olive Alert` to work) | ||
| - JIRA | ||
| - GitHub | ||
| - GitHub, GitLabs, or BitBucket for storing configuration files (recommended) |
There was a problem hiding this comment.
Also Github is here twice
There was a problem hiding this comment.
They're doing different things, so updated.
| @@ -3,8 +3,6 @@ | |||
| [Pinery](http://github.com/oicr-gsi/pinery) and | |||
| [Vidarr](https://github.com/oicr-gsi/vidarr). | |||
|
|
|||
| Deploying this plugin requires the [gsi-common](../plugin-gsi-common/README.md) plugin be deployed as well. | |||
There was a problem hiding this comment.
I believe this is still a requirement?
There was a problem hiding this comment.
Yes, but the module system takes care of this, so there's no need to specify it.
| @@ -2,8 +2,6 @@ | |||
| [Pinery](http://github.com/oicr-gsi/pinery) is a web service application that | |||
| provides generalized LIMS (Laboratory Information Management System) access for information about samples. | |||
|
|
|||
| Deploying this plugin requires the [gsi-common](../plugin-gsi-common/README.md) plugin be deployed as well. | |||
docs/plugin-sftp.md
Outdated
| autoreconf -i | ||
| ./configure --prefix=/install/dir | ||
| make | ||
| make install |
There was a problem hiding this comment.
Why does this tool not get an automatic build like the others?
There was a problem hiding this comment.
Good idea! I will add.
I don't know about building Shesmu releases this way. I've never had success with the Maven repository GitHub provides. We could have to push to the OICR Artifactory with the right keys.
| hope. If file names, user names, or group names have characters that are now | ||
| allowed in JSON strings, it does not go well. This tool provides a more robust | ||
| alternative that does the JSON encoding correctly. To install it: | ||
| For the `unix_file` input format, supported by the SSH plugin, Shesmu will try |
There was a problem hiding this comment.
Wasn't this already in plugin-sftp.md?
There was a problem hiding this comment.
I thought I deleted the bones of it and moved them here.
There was a problem hiding this comment.
Not what I'm seeing on github:
apmasell
force-pushed
the
gha
branch
2 times, most recently
from
f520eec to
4e03233
Compare
| needs: | ||
| - plan | ||
| - build-local-artifacts | ||
| runs-on: "ubuntu-20.04" |
There was a problem hiding this comment.
ubuntu-latest? Or is 20.04 required?
There was a problem hiding this comment.
This file is auto generated by cargo-dist, so I won't be modifying it.
| if: ${{ always() && needs.plan.outputs.publishing == 'true' && (needs.build-global-artifacts.result == 'skipped' || needs.build-global-artifacts.result == 'success') && (needs.build-local-artifacts.result == 'skipped' || needs.build-local-artifacts.result == 'success') }} | ||
| env: | ||
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| runs-on: "ubuntu-20.04" |
| # still allowing individual publish jobs to skip themselves (for prereleases). | ||
| # "host" however must run to completion, no skipping allowed! | ||
| if: ${{ always() && needs.host.result == 'success' }} | ||
| runs-on: "ubuntu-20.04" |
docs/plugin-cardea.md
Outdated
There was a problem hiding this comment.
Is there another way to have plugin documentation rendered rather than moving the README.md out of specific plugin directories and into docs?
There was a problem hiding this comment.
Not that I know. Symlinks create a terrible mess because of the way that the hyperlinks are resolved.
| install it, first, [install Rust](https://www.rust-lang.org/tools/install) and | ||
| then invoke: | ||
|
|
||
| cargo install --path . |
There was a problem hiding this comment.
I see you rewrote this in rust too, but why isn't it also installed by downloading a prebuilt version like shawk?
There was a problem hiding this comment.
Fixed. Yeah, getting a C++ program with a library dependency into a distributable form was more work than porting it to Rust and using cargo-dist.
The previous documentation sturcture cause all code and built modules to be uploaded to the GitHub Pages, which is undesirable. This reorganizes the documentation so that only the relevant files and uploaded and includes JavaDoc generated documentation. It also rewrites the GitHub Actions to build those tools.
The previous documentation sturcture cause all code and built modules to be uploaded to the GitHub Pages, which is undesirable. This reorganizes the documentation so that only the relevant files and uploaded and includes JavaDoc generated documentation. It also rewrites the GitHub Actions to build those tools.
JIRA Ticket: