You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Once you publish your GitHub repository, everyone can inspect your code and the steps used to generate your results. If something goes wrong, a red cross appears and you can inspect the action as above to see where something went wrong.
60
+
Once you publish your GitHub repository, everyone can inspect your code and the steps used to generate your results. If an error occurs in your pipeline, a red cross appears and you can inspect the action as above to see what happened.
59
61
60
-
## Common issues
62
+
## The Re-Pro badge
61
63
62
-
Unless you are using some extraordinary dependencies or features in your project, your repository should now be configured for provable reproducibility. Some common problems which are encountered by people trying to set up a reproducibility proof are:
64
+
The Re-Pro badge is the certificate of reproducibility, which you can display in your document. It certifies that a document was indeed produced based on a given state of a source.
63
65
64
-
- Ìf the branch you want to run the reproducibility proof on is not called `main`, you'll need to modify the `branches:` key at the top of the `reproduce.yml` file.
65
-
- If your code files or LaTeX project is located in subdirectories, relative imports may not work any longer, hence you'll need to manually specify the working directory by adding `
66
-
working-directory: [PATH]` below the commands which run the code.
67
-
- Merge if already have other pipelines called `reproduce.yml`[TODO]
The Re-Pro badge is the certificate of reproducibility, which you can display in your document. It certifies that a document was indeed produced based on a given state of a source.
82
-
83
-
[Image of badge]
84
+
## Common issues
84
85
85
-
The badge is automatically generated. You can display it in your `LaTeX` documents by adding the following lines (if necessary):
86
+
Unless you are using some extraordinary dependencies or features in your project, your repository should now be configured for provable reproducibility. Some common problems which are encountered by people trying to set up a reproducibility proof are:
86
87
87
-
```[tex]
88
-
\usepackage{tikz}
89
-
\usepackage{hyperref}
90
-
...
91
-
\input{re-pro-badge.tex}
92
-
```
88
+
- Ìf the branch you want to run the reproducibility proof on is not called `main`, you'll need to modify the `branches:` key at the top of the `reproduce.yml` file.
89
+
- If your code files or LaTeX project is located in subdirectories, relative imports may not work any longer, hence you'll need to manually specify the working directory by adding `
90
+
working-directory: [PATH]` below the commands which run the code.
91
+
- In case you already use another GitHub action implemented in a file called `reproduce.yml`, you might have to resolve merge conflicts.
93
92
94
93
## Advanced usage
95
94
@@ -112,7 +111,7 @@ Subsequently you can add the following step to your action (make sure to replace
0 commit comments