Skip to content

Commit

Permalink
Tweaks following up GitHub Actions
Browse files Browse the repository at this point in the history
  • Loading branch information
dhimmel committed Jan 17, 2020
1 parent f072e93 commit af52dea
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 9 deletions.
1 change: 0 additions & 1 deletion .github/workflows/manubot.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,5 @@ jobs:
env:
MANUBOT_SSH_PRIVATE_KEY: ${{ secrets.MANUBOT_SSH_PRIVATE_KEY }}
BUILD_WEB_URL: https://github.com/${{ github.repository }}/commit/${{ github.sha }}/checks
COMMIT_MESSAGE: ${{ github.event.head_commit.message }}
shell: bash --login {0}
run: bash ci/deploy.sh
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[![HTML Manuscript](https://img.shields.io/badge/manuscript-HTML-blue.svg)](https://manubot.github.io/rootstock/)
[![PDF Manuscript](https://img.shields.io/badge/manuscript-PDF-blue.svg)](https://manubot.github.io/rootstock/manuscript.pdf)
[![GitHub Actions Status](https://github.com/manubot/rootstock/workflows/manubot/badge.svg)](https://github.com/manubot/rootstock/actions)
[![GitHub Actions Status](https://github.com/manubot/rootstock/workflows/Manubot/badge.svg)](https://github.com/manubot/rootstock/actions)
[![Travis Build Status](https://travis-ci.com/manubot/rootstock.svg?branch=master)](https://travis-ci.com/manubot/rootstock)
<!-- usage note: delete CI badges above for services not used by your manuscript -->

Expand Down
2 changes: 1 addition & 1 deletion SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ cat ci/deploy.key.txt && echo
Next, go to the GitHub repository settings page (URL echoed above).
Click "Add a new secret".
For "Name", enter `MANUBOT_SSH_PRIVATE_KEY`.
Next, copy-paste the content of `deploy.key.txt` into "Value"
Next, copy-paste the content of `ci/deploy.key.txt` into "Value"
(printed above by `cat`, including any trailing `=` characters if present).

### GitHub Actions
Expand Down
3 changes: 2 additions & 1 deletion USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ Citing a DOI containing parentheses [@doi:my-doi].

This syntax is also used by [`pandoc-url2cite`](https://github.com/phiresky/pandoc-url2cite).
Make sure to place these link reference definitions in their own paragraphs.
These paragraphs can be in any of the content Markdown files.

Another method for defining tags is to define `pandoc.citekey-aliases` in `metadata.yaml`:

Expand All @@ -141,7 +142,7 @@ pandoc:
tag:my-doi: doi:10.1016/S0022-2836(05)80360-2
```
For backwards compatability, tags can also be defined in `content/citation-tags.tsv`.
For backwards compatibility, tags can also be defined in `content/citation-tags.tsv`.
If `citation-tags.tsv` defines the tag `study-x`, then this study can be cited like `@tag:study-x`.
This method is deprecated.

Expand Down
7 changes: 2 additions & 5 deletions ci/deploy.sh
Original file line number Diff line number Diff line change
Expand Up @@ -61,18 +61,15 @@ manubot webpage \

# Commit message
MESSAGE="\
$(git log --max-count=1 --format='%s') [ci skip]
$(git log --max-count=1 --format='%s')
[ci skip]
This build is based on
https://github.com/$REPO_SLUG/commit/$COMMIT.
This commit was created by the following CI build and job:
$BUILD_WEB_URL
$JOB_WEB_URL
The full commit message that triggered this build is copied below:
$COMMIT_MESSAGE
"

# Deploy the manubot outputs to output
Expand Down

1 comment on commit af52dea

@agitter
Copy link
Member

@agitter agitter commented on af52dea Jan 17, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The GitHub Actions CI failed on this commit. Should we disable the Travis CI deploy stage by removing its MANUBOT_SSH_PRIVATE_KEY?

Edit: nevermind, this is already being addressed

Please sign in to comment.